forked from cronvel/terminal-kit
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathCHANGELOG
1241 lines (654 loc) · 20.4 KB
/
CHANGELOG
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
v0.24.16
--------
Better approach for CRLF (term.options.crlf = true)
v0.24.15
--------
term.crlf
v0.24.14
--------
Fix issue #12 (when the TERM env variable does not exist)
v0.24.13
--------
Dependencies
v0.24.12
--------
Dependencies
v0.24.11
--------
Dependencies
v0.24.10
--------
Dependencies
v0.24.9
-------
Yet another fix to progressBar. Using async-kit's setSafeTimeout() instead of an internal one.
v0.24.8
-------
Minor fix in progressBar (bad size when progress/eta/item is undefined)
v0.24.7
-------
Timeout issues fixed when CPU-bound/sync task kick in
v0.24.6
-------
Dependencies
v0.24.5
-------
More progressBar (minor) bugs fixed + using ES6 String#repeat()
v0.24.4
-------
ProgressBar width fixed.
v0.24.3
-------
Dependencies
v0.24.2
-------
Dependencies
v0.24.1
-------
Dependencies
v0.24.0
-------
"use strict" everywhere
v0.23.1
-------
Upgrade string-kit from v0.4.0 to v0.4.1, fixing an issue with formatter count and detection
v0.23.0
-------
Breaking change: now rely on string-kit v0.4.x (.format()), so '%[]' -like markup becomes '%[]F' and '%/F3/f -like markup becomes '%[f3]f
v0.22.4 - v0.22.7
-----------------
String-kit dependency.
v0.22.3
-------
Documentation: spelling.
v0.22.2
-------
Better doc on the 'realTerminal' feature.
v0.22.1
-------
New: termkit.realTerminal -- like termkit.terminal but escape pipes.
v0.22.0
-------
No more relying on Node.js core events, now using NextGenEvents for everything.
v0.21.8
-------
Document: more cycle focus bugfixes
v0.21.7
-------
Document: Element#focusNextChild() and Element#focusPreviousChild() bugfix
v0.21.6
-------
Document#giveFocusTo() argument check.
v0.21.5
-------
Dependencies.
v0.21.4
-------
ScreenBuffer: optimized (delta) escape sequences for the terminal blitter are now working properly.
v0.21.3
-------
ScreenBuffer improvements.
v0.21.2
-------
Linux Console: repairing .color256(), thus repairing ScreenBuffer features.
v0.21.1
-------
Document: .focusPrevious() bugfixed.
v0.21.0
-------
Removing inline widget: .layout() and .form(), their Document counter-part should be used instead.
v0.20.32
--------
Internally replacing home-made arrayKit.fill() with ES6 Array#fill().
v0.20.31
--------
TextBuffer: 'hidden' option, .setHidden(), .getHidden(). Document TextInput Element now has the 'hidden' option for passwords.
v0.20.30
--------
TextBuffer: 'hidden' option, .setHidden(), .getHidden(). Document TextInput Element now has the 'hidden' option for passwords.
v0.20.29
--------
Document: Document#focusNext() infinite loop bugfixed, .redraw() for moving and resizing Element, Text#setContent() redraw bugfixed.
v0.20.28
--------
Documentation spelling.
v0.20.27
--------
Document: Text, Element Id and Layout bugfixes.
v0.20.26
--------
Document: .draw() and detached Element bugfix.
v0.20.25
--------
Exit minor bugfix.
v0.20.24
--------
Document: .attach()/.detach()/.destroy() bugfixes.
v0.20.23
--------
Document: .attach()/.detach()/.destroy() bugfixes.
v0.20.22
--------
Document: ENTER and KP_ENTER move to next TextInput in Forms.
v0.20.21
--------
Document: new method .clear() that remove all children
v0.20.20
--------
Document: all Element now have a .destroy() method.
v0.20.19
--------
Buttons are now blinking on submit
v0.20.18
--------
New: all interactive Document Elements now react to the mouse 'click' and 'hover' event!
v0.20.17
--------
Document: MenuBar is renamed DropDownMenu
v0.20.15 - v0.20.16
-------------------
Document MenuBar is now working.
v0.20.14
--------
Document Form navigation. TextBuffer .moveForward() bugfix
v0.20.13
--------
Document MenuBar: better default settings.
v0.20.12
--------
Document MenuBar: work in progress!
v0.20.11
--------
Document ColumnMenu is working!
v0.20.10
--------
Document: Menu is now known as RowMenu. ColumnMenu is in progress. (Those features are not under semver yet - i.e. not documented yet, so no minor version bump for that).
v0.20.9
-------
Document: reversing the logic of preventing propagation of event to parent: now returning a truthy value prevent that.
v0.20.8
-------
Document: event bubbling
v0.20.7
-------
Document: event management changes
v0.20.6
-------
Document Container now has a backgroundAttr option
v0.20.5
-------
Document now rely on nextgen-events instead of Node.js' built-in events.
v0.20.4
-------
New Document Element: Menu.
v0.20.3
-------
ScreenBuffer clipping bugfixed. Document drawing algorithm refactored to support resizing.
v0.20.2
-------
Document: redraw mecanism.
v0.20.1
-------
Document Element Layout is now resizable like the deprecated inline layout was.
v0.20.0
-------
Breaking API change: the Terminal 'resize' event now produces 2 args: width and height, instead of an object to be consistent
with other internal events
v0.19.4
-------
Inline layout ported to Document.
v0.19.3
-------
Document: minor improvement, unique id, document.elements[ id ] access...
v0.19.2
-------
Document element: now perform recursive draw() and drawCursor() automatically
v0.19.1
-------
Document model: Container.
v0.19.0
-------
Now require node.js v4. Document widget currently working: Button, Text, TextInput and Form.
v0.18.0
-------
New feature in progress: Document! It mimics the browser somewhat: a document with element, etc...
layout, form and area-type inputField will move to this new Document feature (every 'inline' features will be kept separated).
v0.17.0
-------
New: .inputField() now has an 'area' mode (standard mode is now known as 'inline' mode) that use ScreenBuffer and TextBuffer
for its rendering, allowing confined text-area-like inputs. This is still a work in progress and many features of the 'inline' mode
are missing. This will allow creation of terminal forms.
v0.16.14
--------
.createLayout(): it is now possible to pass the x,y coordinate of the top-left corner of the layout
v0.16.13
--------
.createLayout(): now creates accessible and resizable ScreenBuffer surfaces on layout's leaf
v0.16.12
--------
Bugfix .createLayout(): now it creates cross-junction like it should when two tee-junction overlap
v0.16.11
--------
Basic 'responsive' layout drawing is now working.
v0.16.10
--------
Layout: work in progress.
v0.16.9
-------
New feature: .createLayout() -- still in alpha.
v0.16.8
-------
New terminal state: term.state.fullscreen
v0.16.7
-------
Adding new spChars again.
v0.16.6
-------
Adding new spChars.
v0.16.5
-------
New: termkit.spChars now contains some useful utf-8 characters
v0.16.4
-------
Upgrade the string-kit dependency (important bugfix on the style markup feature)
v0.16.3
-------
Documentation on style markup.
v0.16.2
-------
Fixing the new format feature so it works properly.
v0.16.1
-------
Linux gpm patch for node v4.
v0.16.0
-------
Using new string-kit's format feature.
v0.15.12
--------
.yesOrNo(): now it returns a controler featuring the abort() method (see the doc).
v0.15.11
--------
Dependencies: string-kit 0.2.x, async-kit 0.6.x.
v0.15.10
--------
TextBuffer: miscBuffer for application data.
v0.15.9
-------
ScreenBuffer/TextBuffer: Rect constructor improvement.
v0.15.8
-------
ScreenBuffer: redraw delta bugfix.
v0.15.7
-------
TextBuffer: work in progress! (minor bugfixes)
v0.15.6
-------
fileInput() and inputField() improvement and options: 'style', 'default', 'cancelable'.
v0.15.4 - v0.15.5
-----------------
TextBuffer: work in progress! (minor bugfixes)
v0.15.3
-------
fileInput(): fixed few minor bugs.
v0.15.2
-------
New method: fileInput(): it is build on an inputField() that auto-complete and display an auto-complete menu
with all files available in the current directory.
v0.15.1
-------
TextBuffer: work in progress! (TAB support)
v0.15.0
-------
ScreenBuffer: backward incompatible change: "draw( { diffOnly: true } )" is now "draw( { delta: true } )".
TextBuffer: work in progress!
v0.14.8 - v0.14.10
------------------
TextBuffer: work in progress!
v0.14.7
-------
TextBuffer: Basic support is ok!
v0.14.6
-------
ScreenBuffer: delta optimization introduced in v0.14.5 is now disabled - not stable enough.
v0.14.5
-------
ScreenBuffer: attribute delta optimization.
v0.14.4
-------
.inputField(): fixed some issues with BACKSPACE when at the first column, and history UP and DOWN at the bottom line.
v0.14.3
-------
On the previous version, 'prependText' becomes 'prefix' (this feature is still not documented, thus not in the SemVer contract).
v0.14.2
-------
.inputField() autoComplete function: if an array is returned and it contains a custom property 'prependText', the autoCompleteMenu
will display items normaly, but it will return the chosen entry prepended with that text.
v0.14.1
-------
New method: .slowTyping(): it outputs some text with an old-fashioned slow-typing effect. See the doc.
v0.14.0
-------
.singleLineMenu(): support for TAB and SHIFT_TAB keys that cycle forward and backward.
.inputField(): same when in the auto-complete menu (since it uses .singleLineMenu() behind the scene)
v0.13.16
--------
Improvement of cleanup code on exit.
Issue #3 is fixed again (regression somewhere between 0.13.6 and 0.13.14).
v0.13.15
--------
Documentation:
* nice animated gif for each example of: progressBar, inputField, singleLineMenu, yesOrNo
* fixes in the examples
* .processExit() is now documentated, thus under SemVer
* .progressBar(): .stop() and .resume() method are now documentated, thus under SemVer
v0.13.14
--------
.progressBar(): .stop() and .resume() method (should be documented)
New method: .processExit() that exit cleanly (should be documented)
.getCursorLocation(): do not run in concurrency anymore (fix some issue getting values for another call)
v0.13.11 - v0.13.13
-------------------
.progressBar(): update immediately if the progress value is >= 1, to prevent program from quitting before the progress bar
had a chance to display 'done'.
v0.13.10
--------
.progressBar(): documentation of title and items.
v0.13.9
-------
.progressBar() improvement: 'title mode'. Documentation will be written once stabilized.
v0.13.8
-------
.progressBar() improvement: 'item mode'. Documentation will be written once stabilized.
v0.13.7
-------
.progressBar() can display ETA (activated with the 'eta' option, see the doc)
v0.13.6
-------
New method: .progressBar(), which creates a nice progress bar, see the documentation for details.
v0.13.5
-------
Fix issue #3.
v0.13.3 - v0.13.4
-----------------
Fixing issue #2 with Terminology and mouse reporting.
v0.13.2
-------
.inputField():
* now patched to support characters larger than 2 bytes, but it still has bugs due to full-width chars
* new option 'maxLength': to not allow user to add more characters than this
v0.13.0 - v0.13.1
-----------------
.beep() is deprecated, in favor of .bell().
SHIFT / CTRL / ALT + INSERT / DELETE / PAGE_UP / PAGE_DOWN / HOME / END combo.
v0.12.8
-------
Minor fixes in the demo and tests.
v0.12.7
-------
Fixed an error in the code that may have produced unreported bugs.
v0.12.6
-------
Try-catch when raw mode is not possible.
v0.12.4 - v0.12.5
-----------------
Atomic-Terminal support.
v0.12.3
-------
Bugfix: timeout detection for .getColor() and .getCursorLocation(), .inputField() is changed accordingly (and cleaned up)
v0.12.2
-------
Documentation improvements.
v0.12.1
-------
.singleLineMenu() callback's 'response' argument has 2 new properties: 'x' and 'y', the coordinates of the selected item.
v0.12.0
-------
Backward compatibility broken: .singleLineMenu()'s callback is now:
* callback( error , response ), where:
* error `mixed` truthy if an underlying error occurs
* response `Object` where
* selectedIndex `number` the user-selected menu item index
* selectedText `string` the user-selected menu item text
* unexpectedKey `string` when 'exitOnUnexpectedKey' option is set and an unexpected key is pressed, this contains
the key that produced the exit
Using named parameters for the callback is a more reliable and flexible API that will avoid breakage in the future,
when feature will be added.
v0.11.3
-------
* .inputField(): custom auto-completer can be asynchronous now, see the doc.
* Documentation: static method termkit.autoComplete() is now documented.
v0.11.2
-------
Improved documentation: formatting, Table of Contents, etc...
v0.11.1
-------
Documentation: features introduced since v0.10.8.
v0.11.0
-------
* .singleLineMenu() has more options: it is possible to define its own item separator, and customize the
new next/previous page hint feature
* .inputField() option 'menuOption' has moved to/mixed with 'autoCompleteMenu'
v0.10.9
-------
.inputField() now has the option 'autoCompleteMenu' to use in conjunction with 'autoComplete', it displays a single line menu
displaying all the completion candidate, when more than one is possible.
v0.10.8
-------
New method: .singleLineMenu(), which creates a simple menu, the user can select item with arrow keys and RETURN/ENTER.
v0.10.7
-------
Documentation on .createTerminal() is now available.
v0.10.6
-------
Stupid Gnome-terminal do not set COLORTERM environment variable anymore... this is a workaround to detect it.
v0.10.5
-------
Gnome-terminal now supports 24bits colors, so the support for it has been added.
v0.10.4
-------
.inputField() returned value, the inputControler, is now an event emitter (it emits 'ready'), and it features a 'redraw()' method.
v0.10.3
-------
.inputField() now supports an 'autoComplete' option, see the doc
v0.10.2
-------
.inputField() now supports an 'history' option, so UP and DOWN keys move up and down in the history
v0.10.1
-------
.inputField() returns more way to control it:
* getPosition(): return an object containing 'x' and 'y' properties, the coordinates where the input field starts
* hide(): hide the input field, it still records keystrokes
* show(): show the input field again
* rebase(): rebase the input field to the current cursor position (it does NOT erase the previous one,
use hide() before, see the doc)
v0.10.0
-------
.inputField() now returns an object featuring some functions to control things during the input process:
* abort(): abort the input process and do not even call the inputField()'s callback
* stop(): stop the input process now, call the inputField()'s callback (same behaviour than a regular 'ENTER' key pressed)
* getInput(): get the current input string
v0.9.14
-------
Added a link to the tutorials at blog.soulserv.net/tag/terminal.
v0.9.13
-------
Upgraded dependencies.
v0.9.11 - v0.9.12
-----------------
.noFormat() is now documented (thus under the SemVer contract).
v0.9.10
-------
Upgraded to [email protected].
v0.9.9
------
Just a small addition to the documentation: require() are added in most example (user's feedback).
v0.9.8
------
Upgraded dependencies.
v0.9.2 - v0.9.7
---------------
Package description & README.md that better fit the new npmjs.org site.
v0.9.1
-------
Removing tools/sprite-editor.js: the editor has now its own package: 'leeted'.
The demo located in demo/spaceship.js works again (sprites have been converted to file format V2).
Some performance optimization have greatly improved CPU usage.
v0.9.0
-------
File format has changed for ScreenBuffer.loadSync() and screenBuffer.saveSync().
This is now the format version 2.
File of format version 1 can still be loaded/saved using ScreenBuffer.loadSyncV1() and screenBuffer.saveSyncV1().
This file format is more flexible, so improvement to the lib can be achieved without changing the file format each time.
v0.8.0
-------
The Rect class has moved from termkit.ScreenBuffer.Rect to termkit.Rect
The 'key' event callback's argument #2 (data) now contains a 'isCharacter' property, true for printable, false for control
screenBuffer.clear() -> screenBuffer.fill()
v0.7.1
-------
Sprite editor now support the mouse.
v0.7.0
-------
ScreenBuffer now use Big Endian: there is no performance drop on Little Endian system and the code is less error prone.
v0.6.14
-------
ScreenBuffer .put() now support the 'wrap' option, bypassing the default 'wrap' value of the current screenBuffer.
v0.6.13
-------
ScreenBuffer .put() now support writing in any of the 4 directions.
The sprite editor can set the writing direction.
v0.6.12
-------
ScreenBuffer blending: style transparency bugfix.
Improvement of the sprite editor (new features: fill colors/style, put only attributes).
Improvement of the demo graphics.