3 * Only create our onExit handler when we're enabled and remove it when we're
4 disabled. This stops us from creating multiple onExit handlers when
5 multiple gauge objects are being used.
6 * Fix bug where if a theme name were given instead of a theme object, it
8 * Remove supports-color because it's not actually used. Uhm. Yes, I just
13 * Use supports-color instead of has-color (as the module has been renamed)
17 * Bug fix: Calls to show/pulse while the progress bar is disabled should still
18 update our internal representation of what would be shown should it be enabled.
22 * New feature: Add new `isEnabled` method to allow introspection of the gauge's
23 "enabledness" as controlled by `.enable()` and `.disable()`.
27 * Bug fix: Don't run the code associated with `enable`/`disable` if the gauge
28 is already enabled or disabled respectively. This prevents leaking event
29 listeners, amongst other weirdness.
30 * New feature: Template items can have default values that will be used if no
31 value was otherwise passed in.
35 * Default to `enabled` only if we have a tty. Users can always override
36 this by passing in the `enabled` option explicitly or by calling calling
41 * Externalized `./console-strings.js` into `console-control-strings`.
45 * Update to `signal-exit@3.0.0`, which fixes a compatibility bug with the
47 * [#39](https://github.com/iarna/gauge/pull/39) Fix tests on 0.10 and add
48 a missing devDependency. ([@helloyou2012](https://github.com/helloyou2012))
52 * Add way to programmatically fetch a list of theme names in a themeset
53 (`Themeset.getThemeNames`).
57 * Add support for setting themesets on existing gauge objects.
58 * Add post-IO callback to `gauge.hide()` as it is somtetimes necessary when
59 your terminal is interleaving output from multiple filehandles (ie, stdout
64 * Fix a refactor bug in setTheme where it wasn't accepting the various types
71 * Add setTemplate & setTheme back in.
72 * Add support for named themes, you can now ask for things like 'colorASCII'
73 and 'brailleSpinner'. Of course, you can still pass in theme objects.
74 Additionally you can now pass in an object with `hasUnicode`, `hasColor` and
75 `platform` keys in order to override our guesses as to those values when
76 selecting a default theme from the themeset.
77 * Make the output stream optional (it defaults to `process.stderr` now).
78 * Add `setWriteTo(stream[, tty])` to change the output stream and,
81 #### BUG FIXES & REFACTORING
83 * Abort the display phase early if we're supposed to be hidden and we are.
84 * Stop printing a bunch of spaces at the end of lines, since we're already
85 using an erase-to-end-of-line code anyway.
86 * The unicode themes were missing the subsection separator.
94 * All new themes API– reference themes by name and pass in custom themes and
95 themesets (themesets get platform support autodetection done on them to
96 select the best theme). Theme mixins let you add features to all existing
98 * Much, much improved test coverage.
102 * Got rid of ░ in the default platform, noUnicode, hasColor theme. Thanks
103 to @yongtw123 for pointing out this had snuck in.
104 * Fiddled with the demo output to make it easier to see the spinner spin. Also
105 added prints before each platforms test output.
106 * I forgot to include `signal-exit` in our deps. <.< Thank you @KenanY for
107 finding this. Then I was lazy and made a new commit instead of using his
108 PR. Again, thank you for your patience @KenenY.
109 * Drastically speed up travis testing.
110 * Add a small javascript demo (demo.js) for showing off the various themes
111 (and testing them on diff platforms).
112 * Change: The subsection separator from ⁄ and / (different chars) to >.
113 * Fix crasher: A show or pulse without a label would cause the template renderer
114 to complain about a missing value.
115 * New feature: Add the ability to disable the clean-up-on-exit behavior.
116 Not something I expect to be widely desirable, but important if you have
117 multiple distinct gauge instances in your app.
118 * Use our own color support detection.
119 The `has-color` module proved too magic for my needs, making assumptions
120 as to which stream we write to and reading command line arguments.
124 This is a major rewrite of the internals. Externally there are fewer
127 * On node>0.8 gauge object now prints updates at a fixed rate. This means
128 that when you call `show` it may wate up to `updateInterval` ms before it
129 actually prints an update. You override this behavior with the
130 `fixedFramerate` option.
131 * The gauge object now keeps the cursor hidden as long as it's enabled and
133 * The constructor's arguments have changed, now it takes a mandatory output
134 stream and an optional options object. The stream no longer needs to be
135 an `ansi`ified stream, although it can be if you want (but we won't make
136 use of its special features).
137 * Previously the gauge was disabled by default if `process.stdout` wasn't a
138 tty. Now it always defaults to enabled. If you want the previous
139 behavior set the `enabled` option to `process.stdout.isTTY`.
140 * The constructor's options have changed– see the docs for details.
141 * Themes are entirely different. If you were using a custom theme, or
142 referring to one directly (eg via `Gauge.unicode` or `Gauge.ascii`) then
143 you'll need to change your code. You can get the equivalent of the latter
146 var themes = require('gauge/themes')
147 var unicodeTheme = themes(true, true) // returns the color unicode theme for your platform
149 The default themes no longer use any ambiguous width characters, so even
150 if you choose to display those as wide your progress bar should still
152 * Templates are entirely different and if you were using a custom one, you
153 should consult the documentation to learn how to recreate it. If you were
154 using the default, be aware that it has changed and the result looks quite
projects / yaffs-website / blob