Skip to content

Changelog

listr2 8.2.3 (2024-06-21)

Bug Fixes

  • process-output: trick inquirer and such to not wrap on their own (78b9a90)

listr2 8.2.2 (2024-06-19)

Bug Fixes

  • deps: update dependencies (642d3f7)

listr2 8.2.1 (2024-04-03)

Bug Fixes

  • remove trying to remove non existing signal handler (1178601), closes #712

listr2 8.2.0 (2024-04-02)

Features

  • expose root/subtask through listr and use it directly (c5f8cab)

listr2 8.1.3 (2024-03-31)

Bug Fixes

  • remove all listeners call (763ada8)

listr2 8.1.2 (2024-03-29)

Bug Fixes

  • issues with adding/removing SIGINT listeners (0d30480)

listr2 8.1.1 (2024-03-27)

Bug Fixes

  • update signal handler to remove itself (7597099), closes #709

listr2 8.1.0 (2024-03-27)

Features

  • make observable and stream independent of node and external deps (4eab16a), closes #707

listr2 8.0.2 (2024-01-27)

Bug Fixes

  • deps: update all minor dependency updates (6662e0b)

listr2 8.0.1 (2023-12-20)

Bug Fixes

listr2 8.0.0 (2023-11-24)

Bug Fixes

Performance Improvements

BREAKING CHANGES

  • node16 is EOL therefore the support is dropped with the minimum supported version being >= 18.

listr2 7.0.2 (2023-10-18)

Bug Fixes

  • renderer: subtask options checking problem for default renderer (de71a4d), closes #694

listr2 7.0.1 (2023-09-19)

Bug Fixes

listr2 1.0.0 (2023-09-19)

Bug Fixes

  • force publish with new tagging method (b4ae099)
  • npm: add publish config public (a186982)
  • prompts: move prompt initiation to the adapter to lazy initiate (952ec8c)

Performance Improvements

  • convert to mono repo initially (6d80072)
  • repository: break in to monorepo (d830c33)

BREAKING CHANGES

  • repository: This commit breaks the repository in to a monorepo.

Projects that use enquirer requires to install the complimentary adapter @listr2/prompt-adapter-enquirer. Since there was a breaking change with this anyway it should be another hassle to tackle. Projects that use Manager requires to install the complimentary package @listr2/manager.

  • Converted to Monorepo for modularizing stuff.

listr2 7.0.0-beta.5 (2023-09-19)

Bug Fixes

  • npm: add publish config public (a186982)

listr2 7.0.0-beta.4 (2023-09-19)

Bug Fixes

  • force publish with new tagging method (b4ae099)

listr2 1.0.0-beta.1 (2023-09-19)

7.0.0-beta.3 (2023-09-17)

Bug Fixes

  • prompts: move prompt initiation to the adapter to lazy initiate (952ec8c)

Performance Improvements

  • prompts: implement inquirer support (313e885)
  • convert to mono repo initially (6d80072)
  • repository: break in to monorepo (d830c33)

BREAKING CHANGES

  • prompts: This changes the signature for task.prompt, please read the v7 migration guide to learn more about prompt adapters.
  • repository: This commit breaks the repository in to a monorepo.

Projects that use enquirer requires to install the complimentary adapter @listr2/prompt-adapter-enquirer. Since there was a breaking change with this anyway it should be another hassle to tackle. Projects that use Manager requires to install the complimentary package @listr2/manager.

  • Converted to Monorepo for modularizing stuff.

7.0.0-beta.2 (2023-09-09)

Features

  • add multiline output for default renderer (6ae3132), closes #686

7.0.0-beta.1 (2023-09-04)

Bug Fixes

  • esm/cjs issue with the library, bump deps (9c7a875)
  • issue with splatting logs (54f338b)
  • remove force/disable color by options (c2a1da1), closes #607
  • update problem with splat and loggin (f75cf22)

Performance Improvements

  • removes options for disable/force colors on listr level (df260b0)

BREAKING CHANGES

  • LISTR_DISABLE_COLOR is dropped in favor of using NO_COLOR environment variable to make this not differenciate from other libraries.

Listr options disableColor and forceColor has been dropped since they were not working properly anyways.

The other way to do this was to make color in to a function that directly calls createColors from colorrette. But since it is used in constants and such it really did not make much sense.

  • for this little thing since it was not functionining properly anyways

6.6.1 (2023-07-30)

Bug Fixes

  • issue with splatting logs (54f338b)
  • update problem with splat and loggin (f75cf22)

6.6.0 (2023-05-17)

Features

  • expose manager tasks for brownie (f8fdbf0)

6.5.0 (2023-05-13)

Features

6.4.2 (2023-05-11)

Bug Fixes

  • deps: update dependency eventemitter3 to ^5.0.1 (36ad76b)

6.4.2 (2023-05-03)

Bug Fixes

  • deps: update dependency eventemitter3 to ^5.0.1 (36ad76b)

6.4.1 (2023-04-29)

Bug Fixes

6.4.0 (2023-04-29)

Bug Fixes

  • move types condition to the front (04c20cc)

Features

  • package: export the package.json (3ec1d41)

Reverts

  • revert back the skiping hooks for now (031b536)

6.4.0 (2023-04-28)

Features

  • package: export the package.json (3ec1d41)

Reverts

  • revert back the skiping hooks for now (031b536)

6.3.1 (2023-04-17)

Bug Fixes

  • task: splat on titles for brownie and nx repositories (a756a47)

6.3.0 (2023-04-16)

Bug Fixes

  • renderer/default: update how bottom bar is checked (0b5dab9)

Features

  • renderer: add a caching mechanism for renderers (4112564), closes #672 #LISTR2-259
  • renderer: make paused timer configurable for every renderer (58f37d4)

6.2.0 (2023-04-11)

Bug Fixes

  • update filtering reordering mechanism (a72cc7b), closes #670

Features

  • force publish since semantic-release is stuck (fa0fae1)

6.1.0 (2023-04-11)

Bug Fixes

  • add options to processoutput fix eol problem (e6d6474), closes #670
  • process-output: make everything optional (148cb81)

Features

  • add related documentation to process output and update with feature flag (c1ede63)

6.1.0 (2023-04-11)

Bug Fixes

  • add options to processoutput fix eol problem (e6d6474), closes #670
  • process-output: make everything optional (148cb81)

Features

  • add related documentation to process output and update with feature flag (c1ede63)

6.0.4 (2023-04-08)

Bug Fixes

6.0.3 (2023-04-08)

Bug Fixes

  • logger: update logger for empty messages with fields not writing undefined (30c5baf)
  • renderer: update typings (a080d11)
  • update logger pushing undefined for tasks without titles (7bed36c)
  • renderer: update typings (a080d11)

6.0.2 (2023-04-08)

Bug Fixes

  • typing issues with secondary renderer not being changed (f5c9871)

6.0.1 (2023-04-07)

Bug Fixes

6.0.0 (2023-04-07)

Bug Fixes

  • comply with breaking changes on types (23d1855)
  • expose colorrette and some more utils (d9e0812)
  • handle non string values (04c583c)
  • issue with empty skips from before (5c04f19)
  • issue with test coverage (1bd74d9)
  • missing stuff (9d442f8)
  • move wrong dependency type to dev (d93f135)
  • refactor some of the api for work (4bce0c0)
  • task: update naming scheme and hide taskfn (1b19a89)
  • the issue with rendering, make default renderer method naming scheme similar to logger (6c5c172)
  • update ci configuration for codecov and semantic-release pushback (4f94de6)
  • update dependencies and configuration (ee07b2a)
  • update deps (8140f28)
  • update jsdocs, change default renderer option (2d99b67)
  • update logger to be more flexible (3b76139)
  • update option name (9ddfea3)
  • update splat from logger (142be8c)
  • update typescript path and the import paths accordingly (0d3afcb)

Features

  • add new options for base listr (1a41939)
  • add possiblity to force unicode on all systems (08ba157)
  • add process hooks to hook terminal to obstruct anything while rendering (db7398d), closes #662
  • add splat util.format to output, title and skip (02e5432)
  • add task retry delay (b72eaf3), closes #668
  • adds new test renderer (6098586)
  • ditch rxjs completely and use event emitter based approach (213bc76)
  • expose and alias more of the interfaces since they can be used outside (38479b0)
  • expose more api for pending tasks (a7b1981)
  • expose path from task directly (5c393d0)
  • expose spinner through its own stateful class (99bd97d)
  • process-output: ability to overwrite streams on process output (474e096)
  • process-output: hide cursor as before when hijacking output (a0e150c)
  • renderer: simplify and add eager option (5248c78)

Performance Improvements

  • bump node version to 16 since 14 dies in less than 1 month (36dde30)
  • change field name (91f6fda)
  • change naming scheme for renderer tasks to make it singular (cbcdfe2)
  • change the default behavior for error collection (4785730)
  • change the exposed API of the application (513ed76)
  • changes and reuses logger component and pluggable plugins for renderers (cbf668c), closes #651 #646 #613
  • constants: changes names of listr states (cf9c19d)
  • default fallback renderer changed to simple renderer (67b5b62)
  • deps: ditch-pmap instead of a basic implementation (eb7cfdc)
  • go full esm on jest/ts-node, use dynamic imports for esm modules on default renderer (9cc01c0)
  • handle prompts properly, rename loglevels to listrloglevels (73cad76)
  • logger: move splat to logger as well and refactor multiline message handling (fea0227)
  • logger: unify the logger field input (30a2658)
  • logger: use logger prototype instead of instance for initiating, always pass default (1fc7ef9)
  • move prompt to own instance (7cacdbd)
  • refactor and simplify default renderer (a9ec3c4)
  • refactor the name to shorten it, since it is still understandable (acfe5bd)
  • rename error field of listr and share through parent tasks (88eb34e)
  • rename field (aa831bd)
  • rename for consistency (0530c22)
  • rename nonttyrenderer and its related settings (f29bb12)
  • rename property (5e8a7be)
  • renderer: change the default (796826a)
  • update api and rename for consistency (ffbe9f2)
  • update documentation, rename presets (4041410)
  • update how bottom bar is handled through process output buffer (1729962)
  • update how logger is implemented and injected (3146082)
  • update how test renderer logs and use a serializer instead of constantly creating objects (5859ac4)
  • update naming scheme (acc1f9d)

BREAKING CHANGES

  • renames default renderer options collapse to collapseSubtasks
  • On the main Listr task list, conditions for fallback and silent renderer have been renamed.
  • rendererSilent has been renamed to silentRendererCondition.
  • rendererFallback has been renamed to fallbackRendererCondition.
  • Default fallback renderer has been changed from verbose to simple, since simple can mostly handle non-tty at this point.
  • Changes default error collection behavior to false from minimal, since this is the most hidden feature of them all, and it should be opt-in.
  • err field in manager has been renamed to errors as well
  • renames retry property withError to basically error
  • renderer: The default behavior of handling longer output has been changed to wrap.
  • nonTTYRenderer, nonTTYRendererOptions in Listr tasks has been renamed to fallbackRenderer and fallbackRendererOptions respectively.

To be honest this was staying for the original Listr compatability but since so much is refactored, it made sense to change it to match where the others are used.

  • Minimum node version usable is increased to node16 since node14 has been put out of the maintenance circle.
  • Moves prompt to another channel and avoids using the output channel for prompts.

Properly uses the ProcessOutputHook for Simpler Renderer. Hooks on prompts.

Moves the ProcessOutputBuffer logic in to its own class, where streams can be recorded.

Deprecated through has been ditched by using a basic WritableStream, idk why i did use it in the first place, I guess it was coming from the original Listr implementation.

Still uses ansi escape parsing to properly render the output, still limited by mostly the log-update but buffering output for bells and clear line or hide cursor charachters breaks stuff too much, so it is the safe way.

  • Renames the err field to errors in Listr class. So error collection is shared instead of injected.
  • This completely breaks old behavior with the renderers, even the basic parameters are changed.

Now the renderers for things like timer and timestamps takes in pluggable components through the shared constants, which makes them user configurable.

The logger interface and logger itself has changed to handle all the common cases for any kind of renderer, eventhough it does not use all of them at the same time.

This is a big change that might make the user checkout the new README.

  • constants: State names has been changed, which might break backwards compatability.

6.0.0-beta.19 (2023-04-07)

Performance Improvements

  • update how logger is implemented and injected (3146082)

6.0.0-beta.18 (2023-04-06)

Bug Fixes

  • update jsdocs, change default renderer option (2d99b67)

Performance Improvements

  • handle prompts properly, rename loglevels to listrloglevels (73cad76)

6.0.0-beta.17 (2023-04-06)

Bug Fixes

  • update logger to be more flexible (3b76139)
  • update option name (9ddfea3)

Performance Improvements

BREAKING CHANGES

  • renames default renderer options collapse to collapseSubtasks

6.0.0-beta.16 (2023-04-06)

Bug Fixes

  • refactor some of the api for work (4bce0c0)

6.0.0-beta.15 (2023-04-05)

Bug Fixes

  • move wrong dependency type to dev (d93f135)

6.0.0-beta.14 (2023-04-05)

Features

  • expose path from task directly (5c393d0)

Performance Improvements

  • change naming scheme for renderer tasks to make it singular (cbcdfe2)
  • update how test renderer logs and use a serializer instead of constantly creating objects (5859ac4)

6.0.0-beta.13 (2023-04-02)

Bug Fixes

6.0.0-beta.12 (2023-04-01)

Performance Improvements

  • change the default behavior for error collection (4785730)
  • default fallback renderer changed to simple renderer (67b5b62)
  • rename for consistency (0530c22)
  • update documentation, rename presets (4041410)

BREAKING CHANGES

  • On the main Listr task list, conditions for fallback and silent renderer have been renamed.
  • rendererSilent has been renamed to silentRendererCondition.
  • rendererFallback has been renamed to fallbackRendererCondition.
  • Default fallback renderer has been changed from verbose to simple, since simple can mostly handle non-tty at this point.
  • Changes default error collection behavior to false from minimal, since this is the most hidden feature of them all, and it should be opt-in.

6.0.0-beta.11 (2023-04-01)

Features

6.0.0-beta.10 (2023-04-01)

Performance Improvements

  • update how bottom bar is handled through process output buffer (1729962)

6.0.0-beta.9 (2023-03-19)

Bug Fixes

Features

  • expose and alias more of the interfaces since they can be used outside (38479b0)

Performance Improvements

  • rename property (5e8a7be)
  • renderer: change the default (796826a)
  • update api and rename for consistency (ffbe9f2)

BREAKING CHANGES

  • err field in manager has been renamed to errors as well
  • renames retry property withError to basically error
  • renderer: The default behavior of handling longer output has been changed to wrap.

6.0.0-beta.8 (2023-03-18)

Performance Improvements

  • go full esm on jest/ts-node, use dynamic imports for esm modules on default renderer (9cc01c0)

6.0.0-beta.7 (2023-03-18)

Performance Improvements

  • logger: use logger prototype instead of instance for initiating, always pass default (1fc7ef9)

6.0.0-beta.6 (2023-03-18)

Bug Fixes

Features

  • process-output: hide cursor as before when hijacking output (a0e150c)

Performance Improvements

  • bump node version to 16 since 14 dies in less than 1 month (36dde30)
  • deps: ditch-pmap instead of a basic implementation (eb7cfdc)
  • logger: move splat to logger as well and refactor multiline message handling (fea0227)
  • move prompt to own instance (7cacdbd)
  • refactor the name to shorten it, since it is still understandable (acfe5bd)
  • rename nonttyrenderer and its related settings (f29bb12)

BREAKING CHANGES

  • nonTTYRenderer, nonTTYRendererOptions in Listr tasks has been renamed to fallbackRenderer and fallbackRendererOptions respectively.

To be honest this was staying for the original Listr compatability but since so much is refactored, it made sense to change it to match where the others are used.

  • Minimum node version usable is increased to node16 since node14 has been put out of the maintenance circle.
  • Moves prompt to another channel and avoids using the output channel for prompts.

Properly uses the ProcessOutputHook for Simpler Renderer. Hooks on prompts.

Moves the ProcessOutputBuffer logic in to its own class, where streams can be recorded.

Deprecated through has been ditched by using a basic WritableStream, idk why i did use it in the first place, I guess it was coming from the original Listr implementation.

Still uses ansi escape parsing to properly render the output, still limited by mostly the log-update but buffering output for bells and clear line or hide cursor charachters breaks stuff too much, so it is the safe way.

6.0.0-beta.5 (2023-03-13)

Performance Improvements

  • logger: unify the logger field input (30a2658)

6.0.0-beta.4 (2023-03-13)

Features

  • add process hooks to hook terminal to obstruct anything while rendering (db7398d), closes #662

6.0.0-beta.3 (2023-03-13)

Bug Fixes

  • handle non string values (04c583c)
  • issue with empty skips from before (5c04f19)
  • task: update naming scheme and hide taskfn (1b19a89)
  • update deps (8140f28)

Features

  • add possiblity to force unicode on all systems (08ba157)
  • add splat util.format to output, title and skip (02e5432)
  • expose more api for pending tasks (a7b1981)
  • process-output: ability to overwrite streams on process output (474e096)
  • renderer: simplify and add eager option (5248c78)

Performance Improvements

  • refactor and simplify default renderer (a9ec3c4)
  • rename error field of listr and share through parent tasks (88eb34e)

BREAKING CHANGES

  • Renames the err field to errors in Listr class. So error collection is shared instead of injected.

6.0.0-beta.2 (2023-03-13)

Bug Fixes

  • the issue with rendering, make default renderer method naming scheme similar to logger (6c5c172)
  • update typescript path and the import paths accordingly (0d3afcb)

Features

  • add new options for base listr (1a41939)
  • expose spinner through its own stateful class (99bd97d)

Performance Improvements

6.0.0-beta.1 (2023-03-13)

Bug Fixes

  • comply with breaking changes on types (23d1855)
  • update dependencies and configuration (ee07b2a)

Features

Performance Improvements

  • change the exposed API of the application (513ed76)
  • changes and reuses logger component and pluggable plugins for renderers (cbf668c), closes #651 #646 #613
  • constants: changes names of listr states (cf9c19d)

BREAKING CHANGES

  • This completely breaks old behavior with the renderers, even the basic parameters are changed.

Now the renderers for things like timer and timestamps takes in pluggable components through the shared constants, which makes them user configurable.

The logger interface and logger itself has changed to handle all the common cases for any kind of renderer, eventhough it does not use all of them at the same time.

This is a big change that might make the user checkout the new README.

  • constants: State names has been changed, which might break backwards compatability.

5.1.0-beta.2 (2023-03-11)

Bug Fixes

  • expose colorrette and some more utils (d9e0812)

5.1.0-beta.1 (2023-03-11)

Features

  • ditch rxjs completely and use event emitter based approach (213bc76)

5.0.8 (2023-03-11)

Bug Fixes

  • render subtasks of the subtasks if parent has no title (7b443f9), closes #663

5.0.7 (2023-01-18)

Bug Fixes

  • deps: update dependency rxjs to ^7.8.0 (0e83e8d)

5.0.6 (2022-11-29)

Bug Fixes

  • deps: update dependency rxjs to ^7.5.7 (324f012)

5.0.5 (2022-09-05)

Bug Fixes

5.0.4 (2022-09-05)

Bug Fixes

  • listr-error: changes the types for the listrerror (306a304), closes #653

5.0.3 (2022-09-02)

Bug Fixes

  • Use 'isObservable' utility instance of 'instanceof' (197e373)

5.0.2 (2022-08-05)

Bug Fixes

  • update build configuration because of seg fault (54b54dd)

5.0.1 (2022-07-26)

Bug Fixes

5.0.0 (2022-07-26)

Bug Fixes

Performance Improvements

BREAKING CHANGES

  • drops support for node12, migrate build to gitlab

3.14.0 (2022-01-04)

Bug Fixes

  • add tests and inject context variable as mutable (afe3528)

Features

  • ability to change the context type on subtasks (7dccdfc), closes #612

3.13.6 (2022-01-03)

Bug Fixes

3.13.5 (2021-11-22)

Bug Fixes

  • swap clone package for rfdc to improve speed of error reporting (a75c857)

3.13.4 (2021-11-17)

Bug Fixes

  • mark enquirer as optional as peer (742395e), closes #589

3.13.3 (2021-11-02)

Bug Fixes

3.13.2 (2021-11-02)

Bug Fixes

3.13.1 (2021-10-23)

Bug Fixes

  • use v8 functions for error collection (be37833)

3.13.0 (2021-10-23)

Bug Fixes

  • ditch api-extractor update colorrette (7ae6752)
  • pass options to custom logger (3004640)

Features

  • pass options to the custom logger, implement it with types (4cecba8)

3.12.2 (2021-09-23)

Bug Fixes

3.12.1 (2021-09-13)

Bug Fixes

  • deps: update dependency colorette to ^1.4.0 (4f52e16)

3.12.0 (2021-09-12)

Features

  • fix error collection and improve it a bit (29a08bb), closes #459

3.11.1 (2021-08-31)

Bug Fixes

3.11.0 (2021-07-22)

Bug Fixes

  • fix the tests and errors with the simple renderer (ae4319b)
  • tiny bug with sending output through channel (cce9eee), closes #437

Features

  • renderer: adds simple renderer which is neither updating nor verbose (04a6858)

3.10.1 (2021-07-22)

Bug Fixes

3.10.0 (2021-06-07)

Features

  • add context to the class itself for outside access (98ea144)

3.9.0 (2021-05-27)

Features

3.8.6 (2021-05-27)

Bug Fixes

  • add the missing test case (b630e57), closes #411
  • allow async skip boolean or string (2289f3a)

3.8.5 (2021-05-27)

Bug Fixes

3.8.4 (2021-05-25)

Bug Fixes

3.8.3 (2021-05-24)

Performance Improvements

  • deps: replace chalk with colorette (3014a16)

3.8.2 (2021-05-03)

Bug Fixes

3.8.1 (2021-04-26)

Bug Fixes

  • deps: update dependency chalk to ^4.1.1 (ef4bb19)

3.8.0 (2021-04-25)

Features

  • use elegant spinner on environments that support unicode (f71db87)

3.7.1 (2021-04-19)

Bug Fixes

  • add auto generated docs for documentation site imports (ae3786e)

3.7.0 (2021-04-18)

Features

  • adds task level exit on error (9d27c2b)

3.6.3 (2021-04-17)

Bug Fixes

3.6.2 (2021-04-05)

Bug Fixes

3.6.1 (2021-04-05)

Bug Fixes

  • fix exporting types in the old format (f415027)

3.6.0 (2021-04-05)

Bug Fixes

Features

3.5.0 (2021-04-05)

Features

3.4.5 (2021-04-04)

Bug Fixes

  • fix issue with numeral prompt add example (49e67a6), closes #325

3.4.4 (2021-03-31)

Bug Fixes

  • deps: update dependency rxjs to ^6.6.7 (1b00a87)

3.4.3 (2021-03-08)

Bug Fixes

  • add enquirer import type for no type erors (9a3f105)

3.4.2 (2021-03-08)

Bug Fixes

3.4.1 (2021-03-05)

Bug Fixes

  • return the last error as well from isRetrying (f94641e)

3.4.0 (2021-03-05)

Features

3.3.4 (2021-02-27)

Bug Fixes

  • deps: update dependency rxjs to ^6.6.6 (0164fac)

3.3.3 (2021-02-23)

Bug Fixes

  • update how the renderer options are handled enabling to use task options (2b147b2)

3.3.2 (2021-02-21)

Bug Fixes

  • move documentation to site (462ad71)

3.3.1 (2021-01-31)

Bug Fixes

3.3.1-beta.3 (2021-01-31)

Bug Fixes

3.3.1-beta.2 (2021-01-25)

Bug Fixes

3.3.1-beta.1 (2021-01-24)

Bug Fixes

3.3.0 (2021-01-20)

Bug Fixes

  • add more filtering for empty lines (8bc1671)
  • drone stupidity (3baa018)
  • fix drone (af43b84)
  • force build (bc6cb28)
  • some fixes for truncation and word wrapping (18c279a)
  • update readme, remove word-wrap (2d6c6e8)
  • update truncating and word wrap column thingies (f8662b9)

Features

3.3.0-beta.2 (2021-01-18)

Bug Fixes

  • add more filtering for empty lines (8bc1671)
  • some fixes for truncation and word wrapping (18c279a)
  • update truncating and word wrap column thingies (f8662b9)

3.3.0-beta.1 (2021-01-17)

Bug Fixes

Features

3.2.3 (2020-11-26)

Bug Fixes

  • update deps and fix typescript resolve (836b8fd)

3.2.2 (2020-10-26)

Bug Fixes

  • prompt: update task wrapper as this requirement for external use (f0c0146)

3.2.1 (2020-10-24)

Bug Fixes

  • improve tests and disable the unnecassary cases (929a616)

3.2.0 (2020-10-24)

Bug Fixes

  • fixed a tiny bug with newlistr (51e4071)

Features

  • Implemented some jsdoc style docs (788fb99), closes #172

3.1.1 (2020-09-22)

Bug Fixes

  • prompt: make prompt outside used (2a61ac8)
  • prompt: reenabled external use (2408aa1)

3.1.0 (2020-09-20)

Bug Fixes

  • prompt: prompt.submit instead of prompt.cancel to not throw error (b758dac)
  • trying for adding skip functionality to prompt (71924c9), closes #173
  • trying for fix (79ba2bb)
  • deps: update dependency rxjs to ^6.6.3 (6664562)

Features

3.0.1 (2020-09-05)

Bug Fixes

  • default-renderer: added some fixes to swallowing error output in collapseErrors: [secure] mode and showErrorMessage (b0c2bb7)

3.0.0 (2020-09-04)

Bug Fixes

Features

  • default-renderer: added collapse errors changed the renderer a bit (514fc87), closes #163

Performance Improvements

  • changed last rendering method (bd38146)

BREAKING CHANGES

  • Tests might break with this release, if they directly rely on default-renderer. Especially the snapshot testing will get hit.
  • default-renderer now utilizes different EOL depending on the platform.

  • The last rendering method has been changed therefore it will leave a empty line before doing the last render which is the log-update clean functionallity, before writing it with process.stdout.

  • Outputted data now gets better trimmed which might cause testing to not match.

  • More consistent spacing is introduced for rendering the subtasks, bottom bar and the prompt bar.

  • error-collection was not working as expected but it might now cause some tests to fail.

Overall there are no breaking changes introduced to the code directly but it might cause the tests which rely on default-renderer, since the rendering method is almost completely revised.

3.0.0-beta.1 (2020-09-04)

Bug Fixes

Features

  • default-renderer: added collapse errors changed the renderer a bit (514fc87), closes #163

Performance Improvements

  • changed last rendering method (bd38146)

BREAKING CHANGES

  • Tests might break with this release, if they directly rely on default-renderer. Especially the snapshot testing will get hit.
  • default-renderer now utilizes different EOL depending on the platform.

  • The last rendering method has been changed therefore it will leave a empty line before doing the last render which is the log-update clean functionallity, before writing it with process.stdout.

  • Outputted data now gets better trimmed which might cause testing to not match.

  • More consistent spacing is introduced for rendering the subtasks, bottom bar and the prompt bar.

  • error-collection was not working as expected but it might now cause some tests to fail.

Overall there are no breaking changes introduced to the code directly but it might cause the tests which rely on default-renderer, since the rendering method is almost completely revised.

2.6.2 (2020-08-29)

Bug Fixes

  • default-renderer: timer with title change (6cf1eec)

2.6.1 (2020-08-27)

Bug Fixes

  • new version for replicate.npmjs (09dcb9c)

2.6.0 (2020-08-16)

Bug Fixes

  • keep persistent output on error (de7e661)

Features

  • listr: accessing parent task (544a130), closes #141
  • isolated error and skip messages (5b8735d)
  • default-renderer: added timer to renderer (4b8d757)

2.5.1 (2020-08-10)

Bug Fixes

  • prompt: fixed an issue with one prompt not returning default (375a441)

2.5.0 (2020-08-10)

Bug Fixes

  • deps: update dependency rxjs to ^6.6.2 (5175991)
  • prompt: enquirer custom prompts (6317ec6)

Features

  • renderer: added disable color and enable silent renderer via options (74f91c2)

2.4.1 (2020-07-29)

Bug Fixes

  • default-renderer: added a tiny fix when persistent bottom bar is enabled and task is skipped (d6a25a8)

2.4.0 (2020-07-27)

Bug Fixes

  • deps: removed bundle of rxjs (a103acb)
  • rxjs: retry for rxjs export with webpack (ac537e5)

Features

  • build: bundle rxjs with webpack, reduce total bundle size, since i started to use this everywhere (4cc922a)

Reverts

2.4.0-beta.3 (2020-07-27)

Bug Fixes

  • deps: removed bundle of rxjs (a103acb)

Reverts

2.4.0-beta.2 (2020-07-27)

Bug Fixes

  • rxjs: retry for rxjs export with webpack (ac537e5)

2.4.0-beta.1 (2020-07-27)

Features

  • build: bundle rxjs with webpack, reduce total bundle size, since i started to use this everywhere (4cc922a)

2.3.6 (2020-07-27)

Bug Fixes

  • remove unused import (46a72c7)
  • default-renderer: fix output rendering with empty subtasks (8299c3f)
  • default-renderer: output from subtask of subtask (4096e62)

2.3.5 (2020-07-26)

Bug Fixes

  • default-renderer: renderer to show spinner if all subtasks has no title (58aaadc)
  • deps: update all minor dependency updates (4fccbc4)

2.3.4 (2020-07-26)

Bug Fixes

  • default-renderer: fixed the issue when there is all empty subtasks and it leaves one extra space (57b0809)

2.3.3 (2020-07-24)

Bug Fixes

  • prompts: removed prompt bind type to use it in other scripts directly (655334a)

2.3.2 (2020-07-23)

Bug Fixes

  • tests: change env variable for tests, esspecially chalk because node_env test is more common (5c7c9ca)

2.3.1 (2020-07-22)

Bug Fixes

  • readme: added badge for npm (61f6bc3)

2.3.0 (2020-07-22)

Bug Fixes

  • colors: disable colors for test (b81ee08)
  • deps: update all minor package updates (aba8cf2)
  • truncate: fix truncate to 80 on columns unknown (3454aed)

Features

  • added lazy option to default renderer. moved enquirer to inject wrapper key from root (78f3984)
  • prompts: added external enquirer injection for testing, fallback condition, fixed catching err (a0bf6fd), closes #66 #67 #68

2.3.0-beta.2 (2020-07-22)

Features

  • added lazy option to default renderer. moved enquirer to inject wrapper key from root (78f3984)

2.3.0-beta.1 (2020-07-22)

Bug Fixes

  • deps: update all minor package updates (aba8cf2)

Features

  • prompts: added external enquirer injection for testing, fallback condition, fixed catching err (a0bf6fd), closes #66 #67 #68

2.2.1 (2020-07-18)

Bug Fixes

  • prompts: added return when prompt error (6c89e56)
  • prompts: fixed prompt error message when enquirer is not installed optionally (8fc5849)

2.2.0 (2020-07-03)

Features

  • display elegant spinner on Windows Terminal (a86868b)

2.1.9 (2020-07-01)

Bug Fixes

  • manager: manager type problem with indent (9444d3d)

2.1.9-beta.1 (2020-06-18)

Bug Fixes

  • manager: manager type problem with indent (9444d3d)

2.1.8 (2020-06-17)

Bug Fixes

  • renderer: add skip to verbose output (f577df0)

2.1.7 (2020-06-14)

Bug Fixes

  • renderer: verbose renderer (794f966)

2.1.6 (2020-06-14)

Bug Fixes

2.1.5 (2020-06-14)

Bug Fixes

  • renderer: verbose renderer defaults (3246fe1)

2.1.4 (2020-06-14)

Bug Fixes

  • added verbose renderer options: added new options of log empty title and title change (5a5eb79)
  • types: enquirer types (d309d91)

2.1.3 (2020-06-04)

Bug Fixes

  • enquirer: moved prompt flattening around again for my own scripts (a40a569)
  • enquirer: optional stdout (703658f)

2.1.2 (2020-06-04)

Bug Fixes

  • prompt: added option to call prompt from outside for my applicatiosn (27dbdfa)

2.1.1 (2020-06-04)

Bug Fixes

  • streams: add legacy streams to accepted types (f63dd52)

2.1.0 (2020-06-03)

Bug Fixes

  • deps: remove trivial deps (de8dec0)
  • deps: remove unnecassary types (b37f416)
  • deps: updated deps to latest (c4ad38f)
  • figures: made microsoft icons to use the fancy ones, even though it may fail in some cases (f0e5817), closes #31
  • prompt: enquirer to peer (cae55e9)
  • prompt: types (110130a)
  • prompts: fixed type for array prompts, added name as mandatory (a08b1e4)
  • stream: fixed streams added example (614d89f), closes #37

Features

  • prompt: make prompt module optional, be more compatible to underlying enqurier (64cecc1), closes #34
  • prompt: use enquirer directly (b34e9d0), closes #34
  • renderer: added hook and stdout support (bd73c68), closes #31

2.1.0-beta.6 (2020-06-03)

Bug Fixes

  • deps: remove trivial deps (de8dec0)
  • deps: remove unnecassary types (b37f416)
  • deps: updated deps to latest (c4ad38f)
  • stream: fixed streams added example (614d89f), closes #37

2.1.0-beta.5 (2020-06-03)

Bug Fixes

2.1.0-beta.4 (2020-06-02)

Bug Fixes

2.1.0-beta.3 (2020-06-02)

Bug Fixes

  • prompts: fixed type for array prompts, added name as mandatory (a08b1e4)

2.1.0-beta.2 (2020-06-02)

Features

  • prompt: make prompt module optional, be more compatible to underlying enqurier (64cecc1), closes #34
  • prompt: use enquirer directly (b34e9d0), closes #34

2.1.0-beta.1 (2020-05-25)

Bug Fixes

  • figures: made microsoft icons to use the fancy ones, even though it may fail in some cases (f0e5817), closes #31

Features

  • renderer: added hook and stdout support (bd73c68), closes #31

2.0.4 (2020-05-20)

Bug Fixes

  • types: match version of uuid (33a1e80)
  • uuid: added implicit tests for 13.6, rollback to uuid working version (75ade63), closes #28

2.0.3 (2020-05-19)

Bug Fixes

  • deps: exchange uuid with nanoid (2048b3d), closes #25

2.0.2 (2020-05-18)

Bug Fixes

2.0.1 (2020-05-06)

Bug Fixes

  • manager: fixed manager types (10d74e9), closes #22
  • manager: fixed types for manager (033c7d1)

2.0.0 (2020-05-06)

Bug Fixes

  • default-renderer: added back cli truncate (22132a5)
  • error-collection: fixed error collection on non-failing tasks (4239094)
  • manager: added error context (4f8f387)
  • manager: fixed manager (57dcd7f)
  • types: fix (b3ee9be)
  • fixed types for isolated renderer options (4521832)

Features

  • release: ready to update to new version (50fb773), closes #19 #18
  • renderer-options: started to isolate the renderer options instead of writing them directly (95f7f87)

BREAKING CHANGES

  • release: - Renderer Options
    • Reason: This was changed because of having all the renderer options that are mangled together and not respecting which renderer has been choosen. It also allows for custom renderers to have their own logic by exposing their options in a single class file rather than expecting that functionality from the project itself.
    • Before <v1.3.12:
    typescript
      new Listr<Ctx>([
      {
        task: async (ctx, task): Promise<void> => {
        },
        persistentOutput: true
      }
    ], {
      concurrent: [secure],
      collapse: true
    • After <v1.3.12:
    typescript
    new Listr<Ctx>(
      [
        {
          task: async (ctx, task): Promise<void> => {},
          options: { persistentOutput: true } // per task based options are moved to their own key
        }
      ],
      {
        concurrent: [secure],
        rendererOptions: { collapse: [secure] }
        // global renderer options moved to their own key
      }
    )
  • Some of the types has been changed.

    • Reason: Some of the types had to be changed due to compatability reasons with new autocomplete functionality of the dynamic renderer options.
    • Before <v1.3.12:
    typescript
    let task: Listr<Ctx>
    
    task = new Listr(..., { renderer: 'verbose' })
    • After <v1.3.12:
    typescript
    // this without the indication of verbose will now fail due to default renderer being 'default' for autocompleting goodness of the IDEs.
    // So you have to overwrite it manually to 'verbose'.
    // If it does not have a default you had to explicitly write { renderer: 'default' } everytime to have the auto complete feature
    let task: Listr<Ctx, 'verbose'>
    
    task = new Listr(..., { renderer: 'verbose' })
  • Test renderer removed.

    • Reason: On non-tty environments that the verbose renderer is intended for there is no need to show icons. Since icons are now optional with the default being disabled for the verbose renderer, there is no need for a renderer that does have the same functionality since verbose and test are now basically the same thing. Verbose seemed a better name then test, so I had to remove test from the equation.
    • Before <v1.3.12:
    typescript
    const task = new Listr(..., { renderer: 'test' })
    • After <v1.3.12:
    typescript
    const task = new Listr(..., { renderer: 'verbose' })

1.3.12 (2020-04-30)

Bug Fixes

  • ignore: note to self dont do late night commits (56ff7b7)

1.3.11 (2020-04-30)

Bug Fixes

  • build: ignored tests files (16d8d93)

1.3.10 (2020-04-30)

Bug Fixes

  • tests: add tests to npm ignore (83cd9d3)

1.3.9 (2020-04-30)

Bug Fixes

  • added e2e and unit tests, not comprehensive (4d3076b)

Reverts

  • task: revert back to enable boolean for not breaking compatability (45b6c32)