nx 19.7.0-canary.20240904-f39b995 → 19.7.0-canary.20240906-a3c2db8

package/src/command-line/reset/command-object.js

@@ -19,7 +19,7 @@ exports.yargsResetCommand = {
         type: 'boolean',
     })
         .option('onlyWorkspaceData', {
-        description: 'Clears the workspace data directory. Used by Nx to store cached data about the current workspace (e.g. partial results, incremental data, etc)',
+        description: 'Clears the workspace data directory. Used by Nx to store cached data about the current workspace (e.g. partial results, incremental data, etc).',
         type: 'boolean',
     }),
     handler: async (argv) => (await Promise.resolve().then(() => require('./reset'))).resetHandler(argv),

package/src/command-line/run/command-object.js

@@ -27,7 +27,7 @@ exports.yargsRunCommand = {
 exports.yargsNxInfixCommand = {
     ...exports.yargsRunCommand,
     command: '$0 <target> [project] [_..]',
-    describe: 'Run a target for a project',
+    describe: 'Run a target for a project.',
     handler: async (args) => {
         const exitCode = await (0, params_1.handleErrors)(args.verbose ?? process.env.NX_VERBOSE_LOGGING === 'true', async () => {
             // Yargs parses <target> as 'undefined' if running just 'nx'

package/src/command-line/run-many/command-object.js

@@ -6,7 +6,7 @@ const shared_options_1 = require("../yargs-utils/shared-options");
 const params_1 = require("../../utils/params");
 exports.yargsRunManyCommand = {
     command: 'run-many',
-    describe: 'Run target for multiple listed projects',
+    describe: 'Run target for multiple listed projects.',
     builder: (yargs) => (0, documentation_1.linkToNxDevAndExamples)((0, shared_options_1.withRunManyOptions)((0, shared_options_1.withOutputStyleOption)((0, shared_options_1.withTargetAndConfigurationOption)((0, shared_options_1.withBatch)(yargs)))), 'run-many'),
     handler: async (args) => {
         const exitCode = await (0, params_1.handleErrors)(args.verbose ?? process.env.NX_VERBOSE_LOGGING === 'true', async () => {

package/src/command-line/show/command-object.js

@@ -6,14 +6,14 @@ const shared_options_1 = require("../yargs-utils/shared-options");
 const params_1 = require("../../utils/params");
 exports.yargsShowCommand = {
     command: 'show',
-    describe: 'Show information about the workspace (e.g., list of projects)',
+    describe: 'Show information about the workspace (e.g., list of projects).',
     builder: (yargs) => yargs
         .command(showProjectsCommand)
         .command(showProjectCommand)
         .demandCommand()
         .option('json', {
         type: 'boolean',
-        description: 'Output JSON',
+        description: 'Output JSON.',
     })
         .example('$0 show projects', 'Show a list of all projects in the workspace')
         .example('$0 show projects --with-target serve', 'Show a list of all projects in the workspace that have a "serve" target')
@@ -25,11 +25,11 @@ exports.yargsShowCommand = {
 };
 const showProjectsCommand = {
     command: 'projects',
-    describe: 'Show a list of projects in the workspace',
+    describe: 'Show a list of projects in the workspace.',
     builder: (yargs) => (0, shared_options_1.withVerbose)((0, shared_options_1.withAffectedOptions)(yargs))
         .option('affected', {
         type: 'boolean',
-        description: 'Show only affected projects',
+        description: 'Show only affected projects.',
     })
         .option('projects', {
         type: 'string',
@@ -40,17 +40,17 @@ const showProjectsCommand = {
         .option('withTarget', {
         type: 'string',
         alias: ['t'],
-        description: 'Show only projects that have a specific target',
+        description: 'Show only projects that have a specific target.',
         coerce: shared_options_1.parseCSV,
     })
         .option('type', {
         type: 'string',
-        description: 'Select only projects of the given type',
+        description: 'Select only projects of the given type.',
         choices: ['app', 'lib', 'e2e'],
     })
         .option('sep', {
         type: 'string',
-        description: 'Outputs projects with the specified seperator',
+        description: 'Outputs projects with the specified seperator.',
     })
         .implies('untracked', 'affected')
         .implies('uncommitted', 'affected')
@@ -79,15 +79,15 @@ const showProjectCommand = {
         .positional('projectName', {
         type: 'string',
         alias: 'p',
-        description: 'Which project should be viewed?',
+        description: 'Which project should be viewed?.',
     })
         .option('web', {
         type: 'boolean',
-        description: 'Show project details in the browser. (default when interactive)',
+        description: 'Show project details in the browser. (default when interactive).',
     })
         .option('open', {
         type: 'boolean',
-        description: 'Set to false to prevent the browser from opening when using --web',
+        description: 'Set to false to prevent the browser from opening when using --web.',
         implies: 'web',
     })
         .check((argv) => {

package/src/command-line/watch/command-object.js

@@ -5,7 +5,7 @@ const documentation_1 = require("../yargs-utils/documentation");
 const shared_options_1 = require("../yargs-utils/shared-options");
 exports.yargsWatchCommand = {
     command: 'watch',
-    describe: 'Watch for changes within projects, and execute commands',
+    describe: 'Watch for changes within projects, and execute commands.',
     builder: (yargs) => (0, documentation_1.linkToNxDevAndExamples)(withWatchOptions(yargs), 'watch'),
     handler: async (args) => {
         await Promise.resolve().then(() => require('./watch')).then((m) => m.watch(args));

package/src/command-line/yargs-utils/shared-options.d.ts

@@ -3,7 +3,7 @@ interface ExcludeOptions {
     exclude: string[];
 }
 export declare const defaultYargsParserConfiguration: Partial<ParserConfigurationOptions>;
-export declare function withExcludeOption(yargs: Argv): Argv<ExcludeOptions>;
+export declare function withExcludeOption<T>(yargs: Argv<T>): Argv<T & ExcludeOptions>;
 export interface RunOptions {
     exclude: string;
     parallel: string;
@@ -20,6 +20,7 @@ export interface RunOptions {
     batch: boolean;
     useAgents: boolean;
     excludeTaskDependencies: boolean;
+    skipSync: boolean;
 }
 export declare function withRunOptions<T>(yargs: Argv<T>): Argv<T & RunOptions>;
 export declare function withTargetAndConfigurationOption(yargs: Argv, demandOption?: boolean): Argv<{

package/src/command-line/yargs-utils/shared-options.js

@@ -22,7 +22,7 @@ exports.defaultYargsParserConfiguration = {
 };
 function withExcludeOption(yargs) {
     return yargs.option('exclude', {
-        describe: 'Exclude certain projects from being processed',
+        describe: 'Exclude certain projects from being processed.',
         type: 'string',
         coerce: parseCSV,
     });
@@ -30,7 +30,7 @@ function withExcludeOption(yargs) {
 function withRunOptions(yargs) {
     return withVerbose(withExcludeOption(yargs))
         .option('parallel', {
-        describe: 'Max number of parallel processes [default is 3]',
+        describe: 'Max number of parallel processes [default is 3].',
         type: 'string',
     })
         .option('maxParallel', {
@@ -38,11 +38,11 @@ function withRunOptions(yargs) {
         hidden: true,
     })
         .options('runner', {
-        describe: 'This is the name of the tasks runner configured in nx.json',
+        describe: 'This is the name of the tasks runner configured in nx.json.',
         type: 'string',
     })
         .option('prod', {
-        describe: 'Use the production configuration',
+        describe: 'Use the production configuration.',
         type: 'boolean',
         default: false,
         hidden: true,
@@ -61,24 +61,29 @@ function withRunOptions(yargs) {
                 : value,
     })
         .option('nxBail', {
-        describe: 'Stop command execution after the first failed task',
+        describe: 'Stop command execution after the first failed task.',
         type: 'boolean',
         default: false,
     })
         .option('nxIgnoreCycles', {
-        describe: 'Ignore cycles in the task graph',
+        describe: 'Ignore cycles in the task graph.',
         type: 'boolean',
         default: false,
     })
         .options('skipNxCache', {
-        describe: 'Rerun the tasks even when the results are available in the cache',
+        describe: 'Rerun the tasks even when the results are available in the cache.',
         type: 'boolean',
         default: false,
     })
         .options('excludeTaskDependencies', {
-        describe: 'Skips running dependent tasks first',
+        describe: 'Skips running dependent tasks first.',
         type: 'boolean',
         default: false,
+    })
+        .option('skipSync', {
+        type: 'boolean',
+        // TODO(leo): add description and make it visible once it is stable
+        hidden: true,
     })
         .options('cloud', {
         type: 'boolean',
@@ -96,7 +101,7 @@ function withRunOptions(yargs) {
 }
 function withTargetAndConfigurationOption(yargs, demandOption = true) {
     return withConfiguration(yargs).option('targets', {
-        describe: 'Tasks to run for affected projects',
+        describe: 'Tasks to run for affected projects.',
         type: 'string',
         alias: ['target', 't'],
         requiresArg: true,
@@ -107,7 +112,7 @@ function withTargetAndConfigurationOption(yargs, demandOption = true) {
 }
 function withConfiguration(yargs) {
     return yargs.options('configuration', {
-        describe: 'This is the configuration to use when performing tasks on projects',
+        describe: 'This is the configuration to use when performing tasks on projects.',
         type: 'string',
         alias: 'c',
     });
@@ -115,7 +120,7 @@ function withConfiguration(yargs) {
 function withVerbose(yargs) {
     return yargs
         .option('verbose', {
-        describe: 'Prints additional information about the commands (e.g., stack traces)',
+        describe: 'Prints additional information about the commands (e.g., stack traces).',
         type: 'boolean',
     })
         .middleware((args) => {
@@ -127,7 +132,7 @@ function withVerbose(yargs) {
 function withBatch(yargs) {
     return yargs.options('batch', {
         type: 'boolean',
-        describe: 'Run task(s) in batches for executors which support batches',
+        describe: 'Run task(s) in batches for executors which support batches.',
         coerce: (v) => {
             return v || process.env.NX_BATCH_MODE === 'true';
         },
@@ -138,26 +143,26 @@ function withAffectedOptions(yargs) {
     return withExcludeOption(yargs)
         .parserConfiguration(exports.defaultYargsParserConfiguration)
         .option('files', {
-        describe: 'Change the way Nx is calculating the affected command by providing directly changed files, list of files delimited by commas or spaces',
+        describe: 'Change the way Nx is calculating the affected command by providing directly changed files, list of files delimited by commas or spaces.',
         type: 'string',
         requiresArg: true,
         coerce: parseCSV,
     })
         .option('uncommitted', {
-        describe: 'Uncommitted changes',
+        describe: 'Uncommitted changes.',
         type: 'boolean',
     })
         .option('untracked', {
-        describe: 'Untracked changes',
+        describe: 'Untracked changes.',
         type: 'boolean',
     })
         .option('base', {
-        describe: 'Base of the current branch (usually main)',
+        describe: 'Base of the current branch (usually main).',
         type: 'string',
         requiresArg: true,
     })
         .option('head', {
-        describe: 'Latest commit of the current branch (usually HEAD)',
+        describe: 'Latest commit of the current branch (usually HEAD).',
         type: 'string',
         requiresArg: true,
     })
@@ -178,7 +183,7 @@ function withRunManyOptions(yargs) {
         type: 'string',
         alias: 'p',
         coerce: parseCSV,
-        describe: 'Projects to run. (comma/space delimited project names and/or patterns)',
+        describe: 'Projects to run. (comma/space delimited project names and/or patterns).',
     })
         .option('all', {
         describe: '[deprecated] `run-many` runs all targets on all projects in the workspace if no projects are provided. This option is no longer required.',
@@ -219,11 +224,11 @@ function withRunOneOptions(yargs) {
     const res = withRunOptions(withOutputStyleOption(withConfiguration(yargs), allOutputStyles))
         .parserConfiguration(exports.defaultYargsParserConfiguration)
         .option('project', {
-        describe: 'Target project',
+        describe: 'Target project.',
         type: 'string',
     })
         .option('help', {
-        describe: 'Show Help',
+        describe: 'Show Help.',
         type: 'boolean',
     });
     if (executorShouldShowHelp) {