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

JosefBredereck · web-flow · commit 1e51849b9776 · 2023-01-07T17:47:05.000+01:00
diff --git a/packages/cli/bin/cli-actions/build.js b/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) {
diff --git a/packages/cli/bin/cli-actions/disable.js b/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`);
   });
 
diff --git a/packages/cli/bin/cli-actions/enable.js b/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`);
   });
 
diff --git a/packages/cli/bin/cli-actions/export.js b/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);
   });
 
diff --git a/packages/cli/bin/cli-actions/help.js b/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 */
 };
diff --git a/packages/cli/bin/cli-actions/install.js b/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`);
   });
 
diff --git a/packages/cli/bin/cli-actions/serve.js b/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);
   });
 
diff --git a/packages/cli/bin/patternlab.js b/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);
 
diff --git a/packages/cli/package.json b/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",
diff --git a/packages/edition-node/README.md b/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).
 
diff --git a/packages/engine-react/lib/engine_react.js b/packages/engine-react/lib/engine_react.js
@@ -14,7 +14,7 @@ const path = require('path');
 const React = require('react');
 const ReactDOMServer = require('react-dom/server');
 const Babel = require('babel-core');
-const Hogan = require('hogan');
+const Handlebars = require('handlebars');
 const beautify = require('js-beautify');
 const cheerio = require('cheerio');
 const _require = require;
@@ -44,8 +44,8 @@ let patternLabConfig = {};
 
 let enableRuntimeCode = true;
 
-const outputTemplate = Hogan.compile(
-  fs.readFileSync(path.join(__dirname, './outputTemplate.mustache'), 'utf8')
+const outputTemplate = Handlebars.compile(
+  fs.readFileSync(path.join(__dirname, './outputTemplate.hbs'), 'utf8')
 );
 
 let registeredComponents = {
@@ -106,7 +106,7 @@ var engine_react = {
       React.createFactory(transpiledModule)(data)
     );
 
-    renderedHTML = outputTemplate.render({
+    renderedHTML = outputTemplate({
       htmlOutput: staticMarkup,
     });
 
diff --git a/packages/engine-react/lib/outputTemplate.hbs b/packages/engine-react/lib/outputTemplate.hbs
@@ -0,0 +1 @@
+{{{htmlOutput}}}
diff --git a/packages/engine-react/lib/outputTemplate.mustache b/packages/engine-react/lib/outputTemplate.mustache
diff --git a/packages/engine-react/package.json b/packages/engine-react/package.json
@@ -9,7 +9,7 @@
     "babel-plugin-transform-es2015-modules-commonjs": "6.16.0",
     "babel-preset-react": "6.16.0",
     "cheerio": "0.22.0",
-    "hogan": "1.0.2",
+    "handlebars": "4.7.7",
     "js-beautify": "1.13.5",
     "react": "15.3.2",
     "react-dom": "15.3.2"
diff --git a/yarn.lock b/yarn.lock
@@ -4676,10 +4676,10 @@ commander@2.17.x:
   resolved "https://registry.yarnpkg.com/commander/-/commander-2.17.1.tgz#bd77ab7de6de94205ceacc72f1716d29f20a77bf"
   integrity sha512-wPMUt6FnH2yzG95SA6mzjQOEKUU3aLaDEmzs1ti+1E9h+CsrZghRlqEM/EJ4KscsQVG8uNN4uVreUeT8+drlgg==
 
-commander@6.2.1:
-  version "6.2.1"
-  resolved "https://registry.yarnpkg.com/commander/-/commander-6.2.1.tgz#0792eb682dfbc325999bb2b84fddddba110ac73c"
-  integrity sha512-U7VdrJFnJgo4xjrHpTzu0yrHPGImdsmD95ZlgYSEajAn2JKzDhDTPG9kBTefmObL2w/ngeZnilk+OV9CG3d7UA==
+commander@9.4.1:
+  version "9.4.1"
+  resolved "https://registry.yarnpkg.com/commander/-/commander-9.4.1.tgz#d1dd8f2ce6faf93147295c0df13c7c21141cfbdd"
+  integrity sha512-5EEkTNyHNGFPD2H+c/dXXfQZYa/scCKasxWcXJaWnNJ99pnQN9Vnmqow+p+PlFPE63Q6mThaZws1T+HxfpgtPw==
 
 commander@^2.19.0, commander@^2.2.0, commander@^2.20.0:
   version "2.20.3"
@@ -7972,7 +7972,7 @@ hamljs@^0.6.2:
   resolved "https://registry.yarnpkg.com/hamljs/-/hamljs-0.6.2.tgz#7b7116cf6dbe7278e42b3f6ef8725a33e177c8e3"
   integrity sha1-e3EWz22+cnjkKz9u+HJaM+F3yOM=
 
-handlebars@^4.7.6, handlebars@^4.7.7:
+handlebars@4.7.7, handlebars@^4.7.6, handlebars@^4.7.7:
   version "4.7.7"
   resolved "https://registry.yarnpkg.com/handlebars/-/handlebars-4.7.7.tgz#9ce33416aad02dbd6c8fafa8240d5d98004945a1"
   integrity sha512-aAcXm5OAfE/8IXkcZvCepKU3VzW1/39Fb5ZuqMtgI/hT8X2YgoMvBY5dLhq/cpOvw7Lk1nK/UF71aLG/ZnVYRA==
@@ -8181,21 +8181,6 @@ hmac-drbg@^1.0.1:
     minimalistic-assert "^1.0.0"
     minimalistic-crypto-utils "^1.0.1"
 
-hogan.js@*:
-  version "3.0.2"
-  resolved "https://registry.yarnpkg.com/hogan.js/-/hogan.js-3.0.2.tgz#4cd9e1abd4294146e7679e41d7898732b02c7bfd"
-  integrity sha512-RqGs4wavGYJWE07t35JQccByczmNUXQT0E12ZYV1VKYu5UiAU9lsos/yBAcf840+zrUQQxgVduCR5/B8nNtibg==
-  dependencies:
-    mkdirp "0.3.0"
-    nopt "1.0.10"
-
-hogan@1.0.2:
-  version "1.0.2"
-  resolved "https://registry.yarnpkg.com/hogan/-/hogan-1.0.2.tgz#d8d5e57fae0e7787b3e01e14256f9d588a23d1f0"
-  integrity sha512-2RV7G4f+Rt9YIYDu01r6pgZvP+XhrXi/JKlXd4b+vRybXk94ui4PQjbh/lFaH8gQtxCygy/WKkqmpm0IyZysJA==
-  dependencies:
-    hogan.js "*"
-
 home-or-tmp@^2.0.0:
   version "2.0.0"
   resolved "https://registry.yarnpkg.com/home-or-tmp/-/home-or-tmp-2.0.0.tgz#e36c3f2d2cae7d746a857e38d18d5f32a7882db8"
@@ -11072,11 +11057,6 @@ mkdirp2@^1.0.4:
   resolved "https://registry.yarnpkg.com/mkdirp2/-/mkdirp2-1.0.5.tgz#68bbe61defefafce4b48948608ec0bac942512c2"
   integrity sha512-xOE9xbICroUDmG1ye2h4bZ8WBie9EGmACaco8K8cx6RlkJJrxGIqjGqztAI+NMhexXBcdGbSEzI6N3EJPevxZw==
 
-mkdirp@0.3.0:
-  version "0.3.0"
-  resolved "https://registry.yarnpkg.com/mkdirp/-/mkdirp-0.3.0.tgz#1bbf5ab1ba827af23575143490426455f481fe1e"
-  integrity sha512-OHsdUcVAQ6pOtg5JYWpCBo9W/GySVuwvP9hueRMW7UqshC0tbfzLv8wjySTPm3tfUZ/21CE9E1pJagOA91Pxew==
-
 mkdirp@0.5.1:
   version "0.5.1"
   resolved "https://registry.yarnpkg.com/mkdirp/-/mkdirp-0.5.1.tgz#30057438eac6cf7f8c4767f38648d6697d75c903"
@@ -11418,13 +11398,6 @@ noms@0.0.0:
     inherits "^2.0.1"
     readable-stream "~1.0.31"
 
-nopt@1.0.10:
-  version "1.0.10"
-  resolved "https://registry.yarnpkg.com/nopt/-/nopt-1.0.10.tgz#6ddd21bd2a31417b92727dd585f8a6f37608ebee"
-  integrity sha512-NWmpvLSqUrgrAC9HCuxEvb+PSloHpqVu+FqcO4eeF2h5qYRhA7ev6KvelyQAKtegUbC6RypJnlEOhd8vloNKYg==
-  dependencies:
-    abbrev "1"
-
 nopt@^4.0.1:
   version "4.0.3"
   resolved "https://registry.yarnpkg.com/nopt/-/nopt-4.0.3.tgz#a375cad9d02fd921278d954c2254d5aa57e15e48"

Original file line number	Diff line number	Diff line change
`@@ -35,7 +35,7 @@ const enable = (options) =>`
`35`	`35`	`}`
`36`	`36`	`});`
`37`	`37`	`}`
`38`		`- yield writeJsonAsync(options.parent.config, config);`
	`38`	`+ yield writeJsonAsync(options.config, config);`
`39`	`39`	spinner.succeed(`⊙ patternlab → Updated config`);
`40`	`40`	`});`
`41`	`41`
Original file line number	Diff line number	Diff line change
`@@ -33,7 +33,7 @@ const enable = (options) =>`
`33`	`33`	`}`
`34`	`34`	`});`
`35`	`35`	`}`
`36`		`- yield writeJsonAsync(options.parent.config, config);`
	`36`	`+ yield writeJsonAsync(options.config, config);`
`37`	`37`	spinner.succeed(`⊙ patternlab → Updated config`);
`38`	`38`	`});`
`39`	`39`