Merge branch 'dev' into 1180-deprecate-pattern-parameters

Author: JosefBredereck

packages/cli/bin/cli-actions/build.js

@@ -6,7 +6,7 @@ const { error, info, wrapAsync } = require('../utils');
 const build = (options) =>
   wrapAsync(function* () {
     try {
-      const config = yield resolveConfig(options.parent.config);
+      const config = yield resolveConfig(options.config);
       yield buildPatterns(config, options);
       info(`build: Yay, your Pattern Lab project was successfully built ☺`);
     } catch (err) {

packages/cli/bin/cli-actions/disable.js

@@ -35,7 +35,7 @@ const enable = (options) =>
         }
       });
     }
-    yield writeJsonAsync(options.parent.config, config);
+    yield writeJsonAsync(options.config, config);
     spinner.succeed(`⊙ patternlab → Updated config`);
   });
 

packages/cli/bin/cli-actions/enable.js

@@ -33,7 +33,7 @@ const enable = (options) =>
         }
       });
     }
-    yield writeJsonAsync(options.parent.config, config);
+    yield writeJsonAsync(options.config, config);
     spinner.succeed(`⊙ patternlab → Updated config`);
   });
 

packages/cli/bin/cli-actions/export.js

@@ -5,7 +5,7 @@ const wrapAsync = require('../utils').wrapAsync;
 
 const _export = (options) =>
   wrapAsync(function* () {
-    const config = yield resolveConfig(options.parent.config);
+    const config = yield resolveConfig(options.config);
     archive(config);
   });
 

packages/cli/bin/cli-actions/help.js

@@ -3,8 +3,8 @@ module.exports = () => {
   /* eslint-disable */
   console.log(`
   Examples:
-    $ patternlab init # Initialize a Pattern Lab project.');
-    $ patternlab <cmd> # Builds Pattern Lab from the current dir');
-    $ patternlab <cmd> --config <path/to/patternlab-config> # Pattern Lab from a config in a specified directory');`);
+    $ patternlab init # Initialize a Pattern Lab project
+    $ patternlab <cmd> # Builds Pattern Lab from the current dir
+    $ patternlab <cmd> --config <path/to/patternlab-config> # Pattern Lab from a config in a specified directory`);
   /* eslint-enable */
 };

packages/cli/bin/cli-actions/install.js

@@ -13,7 +13,7 @@ const writeJsonAsync = require('../utils').writeJsonAsync;
  */
 const install = (options) =>
   wrapAsync(function* () {
-    const config = yield resolveConfig(options.parent.config);
+    const config = yield resolveConfig(options.config);
 
     const spinner = ora(
       `⊙ patternlab → Installing additional resources …`
@@ -58,7 +58,7 @@ const install = (options) =>
         `⊙ patternlab → Installed following plugins: ${plugins.join(', ')}`
       );
     }
-    yield writeJsonAsync(options.parent.config, config);
+    yield writeJsonAsync(options.config, config);
     spinner.succeed(`⊙ patternlab → Updated config`);
   });
 

packages/cli/bin/cli-actions/serve.js

@@ -5,7 +5,7 @@ const wrapAsync = require('../utils').wrapAsync;
 
 const serve = (options) =>
   wrapAsync(function* () {
-    const config = yield resolveConfig(options.parent.config);
+    const config = yield resolveConfig(options.config);
     servePatterns(config, options);
   });
 

packages/cli/bin/patternlab.js

@@ -1,7 +1,8 @@
 #!/usr/bin/env node
 /* eslint-disable no-unused-vars */
 'use strict';
-const cli = require('commander');
+const { Command } = require('commander');
+const cli = new Command();
 const path = require('path');
 const build = require('./cli-actions/build');
 const disable = require('./cli-actions/disable');
@@ -38,15 +39,7 @@ const list = (val) => val.split(',');
 cli
   .version(version(pkg), '-V, --version')
   .usage('<cmd> [options]')
-  .arguments('<cmd> [options]')
-  .option(
-    '-c, --config <path>',
-    'Specify config file. Default looks up the project dir',
-    (val) => val.trim(),
-    path.resolve(process.cwd(), 'patternlab-config.json')
-  )
-  .option('-v, --verbose', 'Show verbose console logs', verboseLogs)
-  .option('--silent', 'Turn off console logs', silenceLogs);
+  .arguments('<cmd> [options]');
 
 /**
  * build
@@ -134,6 +127,20 @@ cli
   .option('--no-watch', 'Start watching for changes')
   .action(serve);
 
+// Common options can be added manually after setting up program and subcommands.
+// If the options are unsorted in the help, these will appear last.
+cli.commands.forEach((command) => {
+  command
+    .option(
+      '-c, --config <path>',
+      'Specify config file. Default looks up the project dir',
+      (val) => val.trim(),
+      path.resolve(process.cwd(), 'patternlab-config.json')
+    )
+    .option('-v, --verbose', 'Show verbose console logs', verboseLogs)
+    .option('--silent', 'Turn off console logs', silenceLogs);
+});
+
 // Show additional help
 cli.on('--help', help);
 

packages/cli/package.json

@@ -12,7 +12,7 @@
     "@pattern-lab/core": "^5.17.0",
     "archiver": "5.3.0",
     "chalk": "4.1.0",
-    "commander": "6.2.1",
+    "commander": "9.4.1",
     "deepmerge": "^4.2.2",
     "execa": "5.0.0",
     "fs-extra": "10.0.0",

packages/edition-node/README.md

@@ -24,7 +24,7 @@ This Edition uses [Node](https://nodejs.org) for core processing and [npm](https
 
 ## Installing
 
-Pattern Lab Node can be used different ways. Editions lilke this one are **example** pairings of Pattern Lab code and do not always have an upgrade path or simple means to run as a dependency within a larger project. Users wishing to be most current and have the greatest flexibility are encouraged to consume `core` directly. Users wanting to learn more about Pattern Lab and have a tailored default experience are encouraged to start with an Edition. Both methods still expect to interact with other elements of the [Pattern Lab Ecosystem](https://github.com/pattern-lab/patternlab-node/tree/master/packages/core#ecosystem).
+The Pattern Lab Node can be used in different ways. Editions like this one are **example** pairings of Pattern Lab code and do not always have an upgrade path or simple means to run as a dependency within a larger project. Users wishing to be most current and have the greatest flexibility are encouraged to consume `core` directly. Users wanting to learn more about Pattern Lab and have a tailored default experience are encouraged to start with an edition. Both methods still expect to interact with other elements of the [Pattern Lab Ecosystem](https://github.com/pattern-lab/patternlab-node/tree/master/packages/core#ecosystem).
 
 Read the [installation instructions](https://github.com/pattern-lab/patternlab-node/tree/master#installation).