Update color flag behaviour
#1653
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
kunagpal
suggested changes
Aug 1, 2018
test/unit/cli.test.js
Outdated
| done(); | ||
| }); | ||
| }); | ||
| it('should have color enabled with `--color on`', function (done) { |
There was a problem hiding this comment.
Newline between successive it blocks.
test/cli/color-tty.test.js
Outdated
| @@ -5,7 +5,7 @@ describe('CLI output', function () { | |||
|
|
|||
| describe('TTY', function () { | |||
| // @todo: Change to assert colored output after https://github.com/shelljs/shelljs/pull/524 is released | |||
| it('should produce colored output without any options', function (done) { | |||
| it.skip('should produce colored output without any options', function (done) { | |||
There was a problem hiding this comment.
Need to get this figured out.
lib/reporters/cli/cli-utils.js
Outdated
| * @returns {Boolean} - A boolean value depicting the result of the noTTY check. | ||
| */ | ||
| noTTY: function (color) { | ||
| return !color && (Boolean(process.env.CI) || !process.stdout.isTTY); // eslint-disable-line no-process-env | ||
| return (color === 'off') || !(color === 'on') && |
|
@codenirvana Changelog, migration guide and readme need updates as well |
kunagpal
suggested changes
Aug 2, 2018
CHANGELOG.yaml
Outdated
| @@ -7,6 +7,7 @@ unreleased: | |||
| - '#1605 Dropped support for Node < v6' | |||
| - '#1610 Dropped support for v2 CLI options' | |||
| - '#1616 Moved inbuilt HTML reporter to a standalone reporter: https://github.com/postmanlabs/newman-reporter-html' | |||
| - '#1653 Updated `color` option behaviour' | |||
There was a problem hiding this comment.
Also append: dropped support for --no-color
MIGRATION.md
Outdated
| @@ -34,6 +34,85 @@ Newman v4 requires Node.js >= v6. [Install Node.js via package manager](https:// | |||
| Newman v4 drops support for all the deprecated v2 CLI options, check [V2 to V3 Migration Guide](#v2-to-v3-migration-guide).<br/> | |||
| For the complete list of supported options, see the [README](README.md) | |||
|
|
|||
| #### --no-color | |||
| This option is dropped in favor of changes made in `color` option. A detailed guide on color option is available below. | |||
There was a problem hiding this comment.
the changes made to the --color option. See the section below for more details.
MIGRATION.md
Outdated
|
|
||
| **Note:** | ||
| The default color value is set to `auto` so, Newman attempts to automatically turn color on or off based on the colors support in the terminal. | ||
| This behaviour can be modified by using the `on` or `off` value accordingly. |
There was a problem hiding this comment.
by setting the color option to on or off respectively.
MIGRATION.md
Outdated
| ``` | ||
|
|
||
| **Note:** | ||
| The default color value is set to `auto` so, Newman attempts to automatically turn color on or off based on the colors support in the terminal. |
There was a problem hiding this comment.
The default behaviour is to detect color support for the terminal and act accordingly.
README.md
Outdated
| that output to console. | ||
| - `--color <value>`<br /> | ||
| Enable or Disable colored CLI output. The color value can be any of the three: `on`, `off` or `auto`*(default)*.<br/> | ||
| With `auto`, Newman attempts to automatically turn color on or off based on the colors support in the terminal. |
MIGRATION.md
Outdated
| This option is dropped in favor of changes made in `color` option. A detailed guide on color option is available below. | ||
|
|
||
| ### Using `color` option | ||
| The behaviour of this option is changed in both CLI and Library. Unlike previously, this option alone can be used to enable |
MIGRATION.md
Outdated
| The behaviour of this option is changed in both CLI and Library. Unlike previously, this option alone can be used to enable | ||
| or disable colored CLI output. | ||
|
|
||
| #### Migrations in CLI |
MIGRATION.md
Outdated
| $ newman run collection.json --color off | ||
| ``` | ||
|
|
||
| #### Migrations in Library |
kunagpal
approved these changes
Aug 2, 2018
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
--no-colorCLI flag. Equivalent:--color offnoColorLibrary options. Equivalent:color: 'off'--colorargument &colorlibrary option supports following value:process.env.CIorprocess.stdout.isTTYauto.Todo:
Reference: #1644
Fixes #1636