Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
@tapjs/config
Advanced tools
@tapjs/config - npm Package Compare versions
Comparing version 2.0.0-12 to 2.0.0-13
@@ -43,16 +43,16 @@ "use strict"; | ||
| .heading('TAP - Test Anything Protocol library for JavaScript') | ||
| .description(`Short options are parsed gnu-style, so for example '-bCRspec' would be | ||
| equivalent to '--bail --no-color --reporter=spec' | ||
| .description(`Short options are parsed gnu-style, so for example \`-bCRspec\` would be | ||
| equivalent to \`--bail --no-color --reporter=spec\` | ||
| Much more documentation available at: https://www.node-tap.org/`) | ||
| Much more documentation available at: <https://www.node-tap.org/>`) | ||
| .heading('Subcommands') | ||
| .heading('tap run [test files...]', 3) | ||
| .heading('tap run [test files...]', 3, { pre: true }) | ||
| .description(`(default) Run the files if specified, or search for test files | ||
| according to the 'include' and 'exclude' glob expressions. | ||
| according to the \`include\` and \`exclude\` glob expressions. | ||
| If the first argument to the tap cli is not one of these subcommands, | ||
| then it will be treated as a test file to run.`) | ||
| .heading('tap plugin [add <plugin> | rm <plugin> | list]', 3) | ||
| .heading('tap plugin [add <plugin> | rm <plugin> | list]', 3, { pre: true }) | ||
| .description(`Manage plugins`) | ||
| .heading('tap plugin add <plugin>', 4) | ||
| .heading('tap plugin add <plugin>', 4, { pre: true }) | ||
| .description(`Add the specified plugin to the tap project config. | ||
@@ -64,38 +64,38 @@ | ||
| If the plugin is not a module on disk, then tap will attempt to install | ||
| the plugin package as a dev dependency by running 'npm install | ||
| --save-dev <plugin>'.`) | ||
| .heading('tap plugin rm <plugin>', 4) | ||
| the plugin package as a dev dependency by running | ||
| \`npm install --save-dev <plugin>\`.`) | ||
| .heading('tap plugin rm <plugin>', 4, { pre: true }) | ||
| .description(`Remove the specified plugin. | ||
| If the plugin is one of tap's builtin plugins, then it will be disabled | ||
| by adding '!<plugin>' to the 'plugin' tap config. | ||
| by adding \`!<plugin>\` to the \`plugin\` tap config. | ||
| If the plugin is an installed devDependency, then it will be removed by | ||
| running 'npm rm <plugin>'.`) | ||
| .heading('tap plugin list', 4) | ||
| running \`npm rm <plugin>\`.`) | ||
| .heading('tap plugin list', 4, { pre: true }) | ||
| .description('List the plugins in use') | ||
| .heading('tap build', 3) | ||
| .heading('tap build', 3, { pre: true }) | ||
| .description(`Rebuild tap with the configured plugins. This is done automatically when | ||
| running tests if the set of plugins does not match what tap was previously | ||
| built with.`) | ||
| .heading('tap report', 3) | ||
| .description(`Print a coverage report using the 'coverage-report' config. | ||
| .heading('tap report', 3, { pre: true }) | ||
| .description(`Print a coverage report using the \`coverage-report\` config. | ||
| Coverage reporters can also be specified as positional arguments, | ||
| for example 'tap report html'. | ||
| for example \`tap report html\`. | ||
| `) | ||
| .heading('tap version', 3) | ||
| .heading('tap version', 3, { pre: true }) | ||
| .description(`Print the version of tap in use | ||
| This is also run if the -v --version flag is set`) | ||
| .heading('tap versions', 3) | ||
| .heading('tap versions', 3, { pre: true }) | ||
| .description(`Print the versions of tap and its components and plugins. | ||
| This is also run if the -V --versions flag is set`) | ||
| .heading('tap dump-config', 3) | ||
| .heading('tap dump-config', 3, { pre: true }) | ||
| .description('Print the resolved configuration in YAML format.') | ||
| .heading('tap list', 3) | ||
| .heading('tap list', 3, { pre: true }) | ||
| .description(`Print the test files that will be run, according to the configuration | ||
| and positional arguments.`) | ||
| .heading('tap help', 3) | ||
| .heading('tap help', 3, { pre: true }) | ||
| .description(`Print usage information | ||
@@ -123,10 +123,10 @@ | ||
| To see the format used in a .taprc file, run the 'tap dump-config' | ||
| To see the format used in a .taprc file, run the \`tap dump-config\` | ||
| command with the desired options specified on the command line. | ||
| Additionally, all config options that are modified from their defaults | ||
| will be set in the environment with the 'TAP_' prefix, and will be read | ||
| will be set in the environment with the \`TAP_\` prefix, and will be read | ||
| from the environment if so specified. For example, specifying | ||
| '--omit-version' on the command line, or 'omit-version: true' in a | ||
| .taprc file, will set 'TAP_OMIT_VERSION=1' in the environment. | ||
| \`--omit-version\` on the command line, or \`omit-version: true\` in a | ||
| .taprc file, will set \`TAP_OMIT_VERSION=1\` in the environment. | ||
@@ -142,3 +142,3 @@ Environment and CLI options take priority over any config files. | ||
| Typically this is set in a .taprc file, not on the command | ||
| line, and can be managed using the 'tap plugin <add|rm>' | ||
| line, and can be managed using the \`tap plugin <add|rm>\` | ||
| command. | ||
@@ -152,3 +152,3 @@ | ||
| (perhaps by being part of tap's default set), add it to | ||
| this list prefixed by a '!' character. | ||
| this list prefixed by a \`!\` character. | ||
@@ -173,4 +173,4 @@ The default plugin set that ships with tap is: | ||
| hint: 'reporter', | ||
| description: `Use the specified reporter. Defaults to 'base' when colors | ||
| are in use, or 'tap' when colors are disabled. | ||
| description: `Use the specified reporter. Defaults to \`base\` when colors | ||
| are in use, or \`tap\` when colors are disabled. | ||
@@ -213,6 +213,6 @@ In addition to the built-in reporters provided by | ||
| Default is 'text' when running on the command line, or | ||
| 'text-lcov' when piping to coveralls. | ||
| Default is \`text\` when running on the command line, or | ||
| \`text-lcov\` when piping to coveralls. | ||
| If 'html' is used, then the report will be opened in a web | ||
| If \`html\` is used, then the report will be opened in a web | ||
| browser after running. | ||
@@ -234,5 +234,5 @@ | ||
| 'show-full-coverage': { | ||
| description: `Show the '100' lines in the default 'text' coverage | ||
| description: `Show the \`100\` lines in the default \`text\` coverage | ||
| reporter for every file that has full coverage. Defaults to | ||
| false for all commands other than 'tap report'. Has no | ||
| false for all commands other than \`tap report\`. Has no | ||
| effect on any other coverage report styles. | ||
@@ -247,3 +247,3 @@ | ||
| When running 'tap report', this defaults to true, because | ||
| When running \`tap report\`, this defaults to true, because | ||
| presumably you do want to see something if explicitly | ||
@@ -253,8 +253,8 @@ requesting a coverage report, even if it's just a list of | ||
| When running 'tap report --no-show-full-coverage', | ||
| When running \`tap report --no-show-full-coverage\`, | ||
| with this config explicitly set false, it will omit the | ||
| default text report on full coverage, and behave like | ||
| running 'tap report none' (ie, print nothing). | ||
| running \`tap report none\` (ie, print nothing). | ||
| When running 'tap report text --no-show-full-coverage', | ||
| When running \`tap report text --no-show-full-coverage\`, | ||
| explicitly requesting a text report and also explicitly | ||
@@ -286,3 +286,3 @@ requesting that full coverage text report *not* be shown, | ||
| Return 'null' to not cover any files by this test. | ||
| Return \`null\` to not cover any files by this test. | ||
@@ -398,4 +398,4 @@ Return an empty array [] to cover the set that would be | ||
| The 'before' module, if specified, will always run before any tests, | ||
| and the 'after' module will be loaded after the entire test run is | ||
| The \`before\` module, if specified, will always run before any tests, | ||
| and the \`after\` module will be loaded after the entire test run is | ||
| complete. | ||
@@ -424,3 +424,3 @@ `) | ||
| Relative 'before' paths are resolved against the project | ||
| Relative \`before\` paths are resolved against the project | ||
| config root, even if specified on the cli.`, | ||
@@ -439,3 +439,3 @@ }, | ||
| Relative 'after' paths are resolved against the project | ||
| Relative \`after\` paths are resolved against the project | ||
| config root, even if specified on the cli.`, | ||
@@ -460,3 +460,3 @@ }, | ||
| Files will be created to match the folder structure and | ||
| filenames of test files run, but with '.tap' appended to | ||
| filenames of test files run, but with \`.tap\` appended to | ||
| the filenames.`, | ||
@@ -472,3 +472,3 @@ }, | ||
| description: `A glob expression pattern indicating tests to run if no | ||
| positional arguments are provided to the 'tap run' command. | ||
| positional arguments are provided to the \`tap run\` command. | ||
@@ -478,8 +478,8 @@ By default, tap will search for all files ending in .ts, | ||
| folder named test, tests, or __tests__, or any file ending | ||
| in '.spec.' or '.test.' before a supported extension, or a | ||
| top-level file named 'test.(js,jsx,...)' or | ||
| 'tests.(js,jsx,...)' | ||
| in \`.spec.\` or \`.test.\` before a supported extension, or a | ||
| top-level file named \`test.(js,jsx,...)\` or | ||
| \`tests.(js,jsx,...)\` | ||
| No files excluded by the 'exclude' option will be loaded, | ||
| meaning so dependencies, build artifacts in 'dist', and | ||
| No files excluded by the \`exclude\` option will be loaded, | ||
| meaning so dependencies, build artifacts in \`dist\`, and | ||
| test fixtures and snapshots will be ignored.`, | ||
@@ -491,3 +491,3 @@ }, | ||
| description: `A glob pattern indicating which filenames should NEVER | ||
| be run as tests. This overrides the 'include' option. | ||
| be run as tests. This overrides the \`include\` option. | ||
@@ -522,3 +522,3 @@ Defaults to excluding any folders named dist, fixture, or | ||
| If a value is not provided, such as '--test-env=key', then | ||
| If a value is not provided, such as \`--test-env=key\`, then | ||
| the key is ensured to not be set in the environment. To | ||
@@ -532,3 +532,3 @@ set a key to the empty string, use --test-env=key=`, | ||
| description: `Pass an argument to Node binary in all child processes. | ||
| Run 'node --help' to see a list of all relevant arguments. | ||
| Run \`node --help\` to see a list of all relevant arguments. | ||
| This can be specified multiple times to pass multiple args | ||
@@ -542,3 +542,3 @@ to Node.`, | ||
| 'omit-version': { | ||
| description: `Do not print the 'TAP version 14' line. (This may be needed | ||
| description: `Do not print the \`TAP version 14\` line. (This may be needed | ||
| for compapatibility with some older TAP parsers.)`, | ||
@@ -545,0 +545,0 @@ }, |
@@ -41,16 +41,16 @@ /** | ||
| .heading('TAP - Test Anything Protocol library for JavaScript') | ||
| .description(`Short options are parsed gnu-style, so for example '-bCRspec' would be | ||
| equivalent to '--bail --no-color --reporter=spec' | ||
| .description(`Short options are parsed gnu-style, so for example \`-bCRspec\` would be | ||
| equivalent to \`--bail --no-color --reporter=spec\` | ||
| Much more documentation available at: https://www.node-tap.org/`) | ||
| Much more documentation available at: <https://www.node-tap.org/>`) | ||
| .heading('Subcommands') | ||
| .heading('tap run [test files...]', 3) | ||
| .heading('tap run [test files...]', 3, { pre: true }) | ||
| .description(`(default) Run the files if specified, or search for test files | ||
| according to the 'include' and 'exclude' glob expressions. | ||
| according to the \`include\` and \`exclude\` glob expressions. | ||
| If the first argument to the tap cli is not one of these subcommands, | ||
| then it will be treated as a test file to run.`) | ||
| .heading('tap plugin [add <plugin> | rm <plugin> | list]', 3) | ||
| .heading('tap plugin [add <plugin> | rm <plugin> | list]', 3, { pre: true }) | ||
| .description(`Manage plugins`) | ||
| .heading('tap plugin add <plugin>', 4) | ||
| .heading('tap plugin add <plugin>', 4, { pre: true }) | ||
| .description(`Add the specified plugin to the tap project config. | ||
@@ -62,38 +62,38 @@ | ||
| If the plugin is not a module on disk, then tap will attempt to install | ||
| the plugin package as a dev dependency by running 'npm install | ||
| --save-dev <plugin>'.`) | ||
| .heading('tap plugin rm <plugin>', 4) | ||
| the plugin package as a dev dependency by running | ||
| \`npm install --save-dev <plugin>\`.`) | ||
| .heading('tap plugin rm <plugin>', 4, { pre: true }) | ||
| .description(`Remove the specified plugin. | ||
| If the plugin is one of tap's builtin plugins, then it will be disabled | ||
| by adding '!<plugin>' to the 'plugin' tap config. | ||
| by adding \`!<plugin>\` to the \`plugin\` tap config. | ||
| If the plugin is an installed devDependency, then it will be removed by | ||
| running 'npm rm <plugin>'.`) | ||
| .heading('tap plugin list', 4) | ||
| running \`npm rm <plugin>\`.`) | ||
| .heading('tap plugin list', 4, { pre: true }) | ||
| .description('List the plugins in use') | ||
| .heading('tap build', 3) | ||
| .heading('tap build', 3, { pre: true }) | ||
| .description(`Rebuild tap with the configured plugins. This is done automatically when | ||
| running tests if the set of plugins does not match what tap was previously | ||
| built with.`) | ||
| .heading('tap report', 3) | ||
| .description(`Print a coverage report using the 'coverage-report' config. | ||
| .heading('tap report', 3, { pre: true }) | ||
| .description(`Print a coverage report using the \`coverage-report\` config. | ||
| Coverage reporters can also be specified as positional arguments, | ||
| for example 'tap report html'. | ||
| for example \`tap report html\`. | ||
| `) | ||
| .heading('tap version', 3) | ||
| .heading('tap version', 3, { pre: true }) | ||
| .description(`Print the version of tap in use | ||
| This is also run if the -v --version flag is set`) | ||
| .heading('tap versions', 3) | ||
| .heading('tap versions', 3, { pre: true }) | ||
| .description(`Print the versions of tap and its components and plugins. | ||
| This is also run if the -V --versions flag is set`) | ||
| .heading('tap dump-config', 3) | ||
| .heading('tap dump-config', 3, { pre: true }) | ||
| .description('Print the resolved configuration in YAML format.') | ||
| .heading('tap list', 3) | ||
| .heading('tap list', 3, { pre: true }) | ||
| .description(`Print the test files that will be run, according to the configuration | ||
| and positional arguments.`) | ||
| .heading('tap help', 3) | ||
| .heading('tap help', 3, { pre: true }) | ||
| .description(`Print usage information | ||
@@ -121,10 +121,10 @@ | ||
| To see the format used in a .taprc file, run the 'tap dump-config' | ||
| To see the format used in a .taprc file, run the \`tap dump-config\` | ||
| command with the desired options specified on the command line. | ||
| Additionally, all config options that are modified from their defaults | ||
| will be set in the environment with the 'TAP_' prefix, and will be read | ||
| will be set in the environment with the \`TAP_\` prefix, and will be read | ||
| from the environment if so specified. For example, specifying | ||
| '--omit-version' on the command line, or 'omit-version: true' in a | ||
| .taprc file, will set 'TAP_OMIT_VERSION=1' in the environment. | ||
| \`--omit-version\` on the command line, or \`omit-version: true\` in a | ||
| .taprc file, will set \`TAP_OMIT_VERSION=1\` in the environment. | ||
@@ -140,3 +140,3 @@ Environment and CLI options take priority over any config files. | ||
| Typically this is set in a .taprc file, not on the command | ||
| line, and can be managed using the 'tap plugin <add|rm>' | ||
| line, and can be managed using the \`tap plugin <add|rm>\` | ||
| command. | ||
@@ -150,3 +150,3 @@ | ||
| (perhaps by being part of tap's default set), add it to | ||
| this list prefixed by a '!' character. | ||
| this list prefixed by a \`!\` character. | ||
@@ -171,4 +171,4 @@ The default plugin set that ships with tap is: | ||
| hint: 'reporter', | ||
| description: `Use the specified reporter. Defaults to 'base' when colors | ||
| are in use, or 'tap' when colors are disabled. | ||
| description: `Use the specified reporter. Defaults to \`base\` when colors | ||
| are in use, or \`tap\` when colors are disabled. | ||
@@ -211,6 +211,6 @@ In addition to the built-in reporters provided by | ||
| Default is 'text' when running on the command line, or | ||
| 'text-lcov' when piping to coveralls. | ||
| Default is \`text\` when running on the command line, or | ||
| \`text-lcov\` when piping to coveralls. | ||
| If 'html' is used, then the report will be opened in a web | ||
| If \`html\` is used, then the report will be opened in a web | ||
| browser after running. | ||
@@ -232,5 +232,5 @@ | ||
| 'show-full-coverage': { | ||
| description: `Show the '100' lines in the default 'text' coverage | ||
| description: `Show the \`100\` lines in the default \`text\` coverage | ||
| reporter for every file that has full coverage. Defaults to | ||
| false for all commands other than 'tap report'. Has no | ||
| false for all commands other than \`tap report\`. Has no | ||
| effect on any other coverage report styles. | ||
@@ -245,3 +245,3 @@ | ||
| When running 'tap report', this defaults to true, because | ||
| When running \`tap report\`, this defaults to true, because | ||
| presumably you do want to see something if explicitly | ||
@@ -251,8 +251,8 @@ requesting a coverage report, even if it's just a list of | ||
| When running 'tap report --no-show-full-coverage', | ||
| When running \`tap report --no-show-full-coverage\`, | ||
| with this config explicitly set false, it will omit the | ||
| default text report on full coverage, and behave like | ||
| running 'tap report none' (ie, print nothing). | ||
| running \`tap report none\` (ie, print nothing). | ||
| When running 'tap report text --no-show-full-coverage', | ||
| When running \`tap report text --no-show-full-coverage\`, | ||
| explicitly requesting a text report and also explicitly | ||
@@ -284,3 +284,3 @@ requesting that full coverage text report *not* be shown, | ||
| Return 'null' to not cover any files by this test. | ||
| Return \`null\` to not cover any files by this test. | ||
@@ -396,4 +396,4 @@ Return an empty array [] to cover the set that would be | ||
| The 'before' module, if specified, will always run before any tests, | ||
| and the 'after' module will be loaded after the entire test run is | ||
| The \`before\` module, if specified, will always run before any tests, | ||
| and the \`after\` module will be loaded after the entire test run is | ||
| complete. | ||
@@ -422,3 +422,3 @@ `) | ||
| Relative 'before' paths are resolved against the project | ||
| Relative \`before\` paths are resolved against the project | ||
| config root, even if specified on the cli.`, | ||
@@ -437,3 +437,3 @@ }, | ||
| Relative 'after' paths are resolved against the project | ||
| Relative \`after\` paths are resolved against the project | ||
| config root, even if specified on the cli.`, | ||
@@ -458,3 +458,3 @@ }, | ||
| Files will be created to match the folder structure and | ||
| filenames of test files run, but with '.tap' appended to | ||
| filenames of test files run, but with \`.tap\` appended to | ||
| the filenames.`, | ||
@@ -470,3 +470,3 @@ }, | ||
| description: `A glob expression pattern indicating tests to run if no | ||
| positional arguments are provided to the 'tap run' command. | ||
| positional arguments are provided to the \`tap run\` command. | ||
@@ -476,8 +476,8 @@ By default, tap will search for all files ending in .ts, | ||
| folder named test, tests, or __tests__, or any file ending | ||
| in '.spec.' or '.test.' before a supported extension, or a | ||
| top-level file named 'test.(js,jsx,...)' or | ||
| 'tests.(js,jsx,...)' | ||
| in \`.spec.\` or \`.test.\` before a supported extension, or a | ||
| top-level file named \`test.(js,jsx,...)\` or | ||
| \`tests.(js,jsx,...)\` | ||
| No files excluded by the 'exclude' option will be loaded, | ||
| meaning so dependencies, build artifacts in 'dist', and | ||
| No files excluded by the \`exclude\` option will be loaded, | ||
| meaning so dependencies, build artifacts in \`dist\`, and | ||
| test fixtures and snapshots will be ignored.`, | ||
@@ -489,3 +489,3 @@ }, | ||
| description: `A glob pattern indicating which filenames should NEVER | ||
| be run as tests. This overrides the 'include' option. | ||
| be run as tests. This overrides the \`include\` option. | ||
@@ -520,3 +520,3 @@ Defaults to excluding any folders named dist, fixture, or | ||
| If a value is not provided, such as '--test-env=key', then | ||
| If a value is not provided, such as \`--test-env=key\`, then | ||
| the key is ensured to not be set in the environment. To | ||
@@ -530,3 +530,3 @@ set a key to the empty string, use --test-env=key=`, | ||
| description: `Pass an argument to Node binary in all child processes. | ||
| Run 'node --help' to see a list of all relevant arguments. | ||
| Run \`node --help\` to see a list of all relevant arguments. | ||
| This can be specified multiple times to pass multiple args | ||
@@ -540,3 +540,3 @@ to Node.`, | ||
| 'omit-version': { | ||
| description: `Do not print the 'TAP version 14' line. (This may be needed | ||
| description: `Do not print the \`TAP version 14\` line. (This may be needed | ||
| for compapatibility with some older TAP parsers.)`, | ||
@@ -543,0 +543,0 @@ }, |
| { | ||
| "name": "@tapjs/config", | ||
| "version": "2.0.0-12", | ||
| "version": "2.0.0-13", | ||
| "description": "Utility loading and managing tap configuration", | ||
@@ -37,8 +37,8 @@ "author": "Isaac Z. Schlueter <i@izs.me> (https://blog.izs.me)", | ||
| "peerDependencies": { | ||
| "@tapjs/core": "0.0.0-12", | ||
| "@tapjs/test": "0.0.0-12" | ||
| "@tapjs/core": "0.0.0-13", | ||
| "@tapjs/test": "0.0.0-13" | ||
| }, | ||
| "dependencies": { | ||
| "chalk": "^5.2.0", | ||
| "jackspeak": "^2.2.3", | ||
| "jackspeak": "2.3", | ||
| "polite-json": "^4.0.1", | ||
@@ -45,0 +45,0 @@ "walk-up-path": "^3.0.1" |
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
- increased by0.93%
216673
Dependency changes
+ Added@tapjs/core@0.0.0-13(transitive)
+ Added@tapjs/test@0.0.0-13(transitive)
- Removed@tapjs/core@0.0.0-12(transitive)
- Removed@tapjs/test@0.0.0-12(transitive)
Updatedjackspeak@2.3