From 74b121cb9e652e82bac2e3d32808e00d21f5e3f0 Mon Sep 17 00:00:00 2001 From: Maximilian Franzke <787658+mfranzke@users.noreply.github.com> Date: Mon, 26 Dec 2022 13:13:33 +0100 Subject: [PATCH 1/4] refactor: the CLI package needed an update regarding handlebars as the successor of mustache --- packages/cli/package.json | 5 -- packages/cli/readme.md | 4 +- packages/cli/test/cli-build.test.js | 2 +- packages/cli/test/cli-disable.test.js | 2 +- packages/cli/test/cli-enable.test.js | 2 +- packages/cli/test/cli-export.test.js | 2 +- packages/cli/test/cli-init.test.js | 2 +- .../cli/test/fixtures/patternlab-config.json | 2 +- packages/cli/test/install-starterkit.test.js | 48 ++++--------------- 9 files changed, 17 insertions(+), 52 deletions(-) diff --git a/packages/cli/package.json b/packages/cli/package.json index 6adf96639..6e3dc7115 100644 --- a/packages/cli/package.json +++ b/packages/cli/package.json @@ -23,17 +23,12 @@ "ora": "5.4.0" }, "devDependencies": { - "@pattern-lab/starterkit-mustache-base": "3.0.3", "dos2unix-cli": "^1.0.1", "eslint": "4.18.2", "eslint-config-prettier": "2.9.0", "eslint-plugin-prettier": "2.6.0", "prettier": "2.2.1", "proxyquire": "2.1.3", - "starterkit-mustache-acidtest": "0.0.3", - "starterkit-mustache-bootstrap": "0.1.1", - "starterkit-mustache-foundation": "0.1.1", - "starterkit-mustache-materialdesign": "0.1.2", "tap": "14.11.0" }, "files": [ diff --git a/packages/cli/readme.md b/packages/cli/readme.md index b1445ae7b..af10e0d42 100644 --- a/packages/cli/readme.md +++ b/packages/cli/readme.md @@ -94,8 +94,8 @@ Passing no options starts the init in interactive mode Options: -h, --help output usage information -p, --project-dir Specify a project directory. Default: ./ - -e, --edition Specify an edition to install. Default: edition-node - -k, --starterkit Specify a starterkit to install. Default: starterkit-mustache-base + -e, --edition Specify an edition to install. Default: @pattern-lab/edition-node + -k, --starterkit Specify a starterkit to install. Default: @pattern-lab/starterkit-handlebars-vanilla ``` ### Serve Pattern Lab diff --git a/packages/cli/test/cli-build.test.js b/packages/cli/test/cli-build.test.js index 22b61a9c5..644d56429 100644 --- a/packages/cli/test/cli-build.test.js +++ b/packages/cli/test/cli-build.test.js @@ -17,7 +17,7 @@ tap.test('Init and build ->', (t) => '--edition', '@pattern-lab/edition-node', '--starterkit', - '@pattern-lab/starterkit-mustache-demo', + '@pattern-lab/starterkit-handlebars-demo', ]); yield spawnCmd([ 'build', diff --git a/packages/cli/test/cli-disable.test.js b/packages/cli/test/cli-disable.test.js index c21a1adf1..dfe2f2925 100644 --- a/packages/cli/test/cli-disable.test.js +++ b/packages/cli/test/cli-disable.test.js @@ -16,7 +16,7 @@ tap.test('Disable ->', (t) => '--edition', '@pattern-lab/edition-node', '--starterkit', - '@pattern-lab/starterkit-mustache-base', + '@pattern-lab/starterkit-handlebars-vanilla', ]); yield spawnCmd([ 'install', diff --git a/packages/cli/test/cli-enable.test.js b/packages/cli/test/cli-enable.test.js index 160c5ed49..8ea48d7ef 100644 --- a/packages/cli/test/cli-enable.test.js +++ b/packages/cli/test/cli-enable.test.js @@ -16,7 +16,7 @@ tap.test('Enable ->', (t) => '--edition', '@pattern-lab/edition-node', '--starterkit', - '@pattern-lab/starterkit-mustache-base', + '@pattern-lab/starterkit-handlebars-vanilla', ]); yield spawnCmd([ 'install', diff --git a/packages/cli/test/cli-export.test.js b/packages/cli/test/cli-export.test.js index a6da1fab1..e0caa8e7d 100644 --- a/packages/cli/test/cli-export.test.js +++ b/packages/cli/test/cli-export.test.js @@ -17,7 +17,7 @@ tap.test('Init and export ->', (t) => '--edition', '@pattern-lab/edition-node', '--starterkit', - '@pattern-lab/starterkit-mustache-base', + '@pattern-lab/starterkit-handlebars-vanilla', ]); yield spawnCmd([ 'export', diff --git a/packages/cli/test/cli-init.test.js b/packages/cli/test/cli-init.test.js index a14de8e98..34ad1d190 100644 --- a/packages/cli/test/cli-init.test.js +++ b/packages/cli/test/cli-init.test.js @@ -17,7 +17,7 @@ tap.test('Init ->', (t) => '--edition', '@pattern-lab/edition-node', '--starterkit', - '@pattern-lab/starterkit-mustache-base', + '@pattern-lab/starterkit-handlebars-vanilla', ]); t.ok( fs.existsSync(path.resolve(projectRoot)), diff --git a/packages/cli/test/fixtures/patternlab-config.json b/packages/cli/test/fixtures/patternlab-config.json index 8fdff2714..4ecc87893 100644 --- a/packages/cli/test/fixtures/patternlab-config.json +++ b/packages/cli/test/fixtures/patternlab-config.json @@ -68,7 +68,7 @@ "css": "./test/fixtures/public/css" } }, - "patternExtension": "mustache", + "patternExtension": "hbs", "patternStateCascade": ["inprogress", "inreview", "complete"], "patternExportDirectory": "./pattern_exports/", "patternExportPatternPartials": [], diff --git a/packages/cli/test/install-starterkit.test.js b/packages/cli/test/install-starterkit.test.js index fc651eca9..97a7599c1 100644 --- a/packages/cli/test/install-starterkit.test.js +++ b/packages/cli/test/install-starterkit.test.js @@ -14,64 +14,34 @@ const minimalConfig = { }, }; -tap.test('Install starterkit-mustache-demo ->', (t) => +tap.test('Install @pattern-lab/starterkit-handlebars-vanilla ->', (t) => wrapAsync(function* () { yield installStarterkit( - '@pattern-lab/starterkit-mustache-demo', + '@pattern-lab/starterkit-handlebars-vanilla', minimalConfig ); - const pkg = yield moduleExist('@pattern-lab/starterkit-mustache-demo'); + const pkg = yield moduleExist('@pattern-lab/starterkit-handlebars-vanilla'); t.ok(pkg, 'module should exist after install'); t.end(); }) ); -tap.test('Install starterkit-mustache-base ->', (t) => +tap.test('Install @pattern-lab/starterkit-handlebars-demo ->', (t) => wrapAsync(function* () { yield installStarterkit( - '@pattern-lab/starterkit-mustache-base', + '@pattern-lab/starterkit-handlebars-demo', minimalConfig ); - const pkg = yield moduleExist('@pattern-lab/starterkit-mustache-base'); + const pkg = yield moduleExist('@pattern-lab/starterkit-handlebars-demo'); t.ok(pkg, 'module should exist after install'); t.end(); }) ); -tap.test('Install starterkit-mustache-bootstrap ->', (t) => +tap.test('Install @pattern-lab/starterkit-twig-demo ->', (t) => wrapAsync(function* () { - yield installStarterkit('starterkit-mustache-bootstrap', minimalConfig); - const pkg = yield moduleExist('starterkit-mustache-bootstrap'); - t.ok(pkg, 'module should exist after install'); - t.end(); - }) -); - -tap.test('Install starterkit-mustache-foundation ->', (t) => - wrapAsync(function* () { - yield installStarterkit('starterkit-mustache-foundation', minimalConfig); - const pkg = yield moduleExist('starterkit-mustache-foundation'); - t.ok(pkg, 'module should exist after install'); - t.end(); - }) -); - -tap.test('Install starterkit-mustache-acidtest ->', (t) => - wrapAsync(function* () { - yield installStarterkit('starterkit-mustache-acidtest', minimalConfig); - const pkg = yield moduleExist('starterkit-mustache-acidtest'); - t.ok(pkg, 'module should exist after install'); - t.end(); - }) -); - -tap.test('Install starterkit-mustache-materialdesign ->', (t) => - wrapAsync(function* () { - yield installStarterkit( - 'starterkit-mustache-materialdesign', - minimalConfig - ); - const pkg = yield moduleExist('starterkit-mustache-materialdesign'); + yield installStarterkit('@pattern-lab/starterkit-twig-demo', minimalConfig); + const pkg = yield moduleExist('@pattern-lab/starterkit-twig-demo'); t.ok(pkg, 'module should exist after install'); t.end(); }) From 7b2890f2ceaadfeb8bde4c351e422267767f796e Mon Sep 17 00:00:00 2001 From: Maximilian Franzke <787658+mfranzke@users.noreply.github.com> Date: Mon, 26 Dec 2022 13:27:39 +0100 Subject: [PATCH 2/4] chore: corrected the default starterkit for CI --- packages/cli/readme.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/cli/readme.md b/packages/cli/readme.md index af10e0d42..b415e63dd 100644 --- a/packages/cli/readme.md +++ b/packages/cli/readme.md @@ -95,7 +95,7 @@ Passing no options starts the init in interactive mode -h, --help output usage information -p, --project-dir Specify a project directory. Default: ./ -e, --edition Specify an edition to install. Default: @pattern-lab/edition-node - -k, --starterkit Specify a starterkit to install. Default: @pattern-lab/starterkit-handlebars-vanilla + -k, --starterkit Specify a starterkit to install. Default: @pattern-lab/starterkit-handlebars-demo ``` ### Serve Pattern Lab From 8a5e79d01f13214fa65c56dbdbaa202c9218915a Mon Sep 17 00:00:00 2001 From: Maximilian Franzke <787658+mfranzke@users.noreply.github.com> Date: Mon, 26 Dec 2022 13:33:56 +0100 Subject: [PATCH 3/4] refactor: regenerated yarn.lock file --- yarn.lock | 25 ------------------------- 1 file changed, 25 deletions(-) diff --git a/yarn.lock b/yarn.lock index 2ffddd8a3..e8504f439 100644 --- a/yarn.lock +++ b/yarn.lock @@ -2031,11 +2031,6 @@ dependencies: "@octokit/openapi-types" "^11.2.0" -"@pattern-lab/starterkit-mustache-base@3.0.3": - version "3.0.3" - resolved "https://registry.yarnpkg.com/@pattern-lab/starterkit-mustache-base/-/starterkit-mustache-base-3.0.3.tgz#8ce9bc8e0d2254ee970a09c4bdc76d4f6131c91d" - integrity sha512-AALdLim5L4ODDjUevRGBY/omhzTU38tSJMRRLaCnwoZ9dxn2QOZNampxj5T7Fhn4oTQnyjhawslVbqVekoViig== - "@reach/visually-hidden@^0.1.2": version "0.1.4" resolved "https://registry.yarnpkg.com/@reach/visually-hidden/-/visually-hidden-0.1.4.tgz#0dc4ecedf523004337214187db70a46183bd945b" @@ -14959,26 +14954,6 @@ standard-version@9.1.1: stringify-package "^1.0.1" yargs "^16.0.0" -starterkit-mustache-acidtest@0.0.3: - version "0.0.3" - resolved "https://registry.yarnpkg.com/starterkit-mustache-acidtest/-/starterkit-mustache-acidtest-0.0.3.tgz#8ad2b69f955b487ce60415b4d2b0e2177aa0af29" - integrity sha1-itK2n5VbSHzmBBW00rDiF3qgryk= - -starterkit-mustache-bootstrap@0.1.1: - version "0.1.1" - resolved "https://registry.yarnpkg.com/starterkit-mustache-bootstrap/-/starterkit-mustache-bootstrap-0.1.1.tgz#1cc0b988a8e6fc084dbb9604bf166af17b4216e6" - integrity sha1-HMC5iKjm/AhNu5YEvxZq8XtCFuY= - -starterkit-mustache-foundation@0.1.1: - version "0.1.1" - resolved "https://registry.yarnpkg.com/starterkit-mustache-foundation/-/starterkit-mustache-foundation-0.1.1.tgz#083bf6c1cf6a605ce8729555d502726fa419fd01" - integrity sha1-CDv2wc9qYFzocpVV1QJyb6QZ/QE= - -starterkit-mustache-materialdesign@0.1.2: - version "0.1.2" - resolved "https://registry.yarnpkg.com/starterkit-mustache-materialdesign/-/starterkit-mustache-materialdesign-0.1.2.tgz#1806fa26c87a79ed343cffc139d215a634b7994a" - integrity sha1-GAb6Jsh6ee00PP/BOdIVpjS3mUo= - static-extend@^0.1.1: version "0.1.2" resolved "https://registry.yarnpkg.com/static-extend/-/static-extend-0.1.2.tgz#60809c39cbff55337226fd5e0b520f341f1fb5c6" From 093770544fb96e283a9d0934daa360ee334fd408 Mon Sep 17 00:00:00 2001 From: Maximilian <787658+mfranzke@users.noreply.github.com> Date: Tue, 27 Dec 2022 11:17:10 +0100 Subject: [PATCH 4/4] refactor: corrected those references they were pointing to an older version of that package --- packages/starterkit-handlebars-demo/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/starterkit-handlebars-demo/README.md b/packages/starterkit-handlebars-demo/README.md index 36488cb54..66b0e8969 100644 --- a/packages/starterkit-handlebars-demo/README.md +++ b/packages/starterkit-handlebars-demo/README.md @@ -6,7 +6,7 @@ The Demo StarterKit for Handlebars is meant to be used as a demonstration of a H The Base StarterKit for Handlebars requires the following PatternEngine: -- `@pattern-lab/patternengine-node-handlebars`: [npm](https://www.npmjs.com/package/@pattern-lab/patternengine-node-handlebars), [Github](https://github.com/pattern-lab/patternengine-node-handlebars) +- `@pattern-lab/engine-handlebars`: [npm](https://www.npmjs.com/package/@pattern-lab/engine-handlebars), [Github](https://github.com/pattern-lab/patternlab-node/tree/dev/packages/engine-handlebars) ## Install