From 88f5c45a09eb7bc9ab1dee6f29dbb3aeb3e3d001 Mon Sep 17 00:00:00 2001 From: Patrick McElhaney Date: Thu, 15 Sep 2022 15:35:42 -0400 Subject: [PATCH 1/9] chore: standardize npm script names per #14827 --- package.json | 28 ++++++++++++++-------------- 1 file changed, 14 insertions(+), 14 deletions(-) diff --git a/package.json b/package.json index d002a6023fe..4e8527545e9 100644 --- a/package.json +++ b/package.json @@ -13,22 +13,22 @@ "./use-at-your-own-risk": "./lib/unsupported-api.js" }, "scripts": { + "build:docs:update-links": "node tools/fetch-docs-links.js", + "build:release": "node Makefile.js generateRelease", + "build:release:alpha": "node Makefile.js generatePrerelease -- alpha", + "build:release:beta": "node Makefile.js generatePrerelease -- beta", + "build:release:publish": "node Makefile.js publishRelease", + "build:release:rc": "node Makefile.js generatePrerelease -- rc", + "build:site": "node Makefile.js gensite", + "build:webpack": "node Makefile.js webpack", + "lint": "node Makefile.js lint", + "lint:docs:js": "node Makefile.js lintDocsJS", + "lint:docs:js:fix": "node Makefile.js lintDocsJS -- fix", + "lint:fix": "node Makefile.js lint -- fix", "test": "node Makefile.js test", "test:cli": "mocha", - "lint": "node Makefile.js lint", - "lint:docsjs": "node Makefile.js lintDocsJS", - "fix": "node Makefile.js lint -- fix", - "fix:docsjs": "node Makefile.js lintDocsJS -- fix", - "fuzz": "node Makefile.js fuzz", - "generate-release": "node Makefile.js generateRelease", - "generate-alpharelease": "node Makefile.js generatePrerelease -- alpha", - "generate-betarelease": "node Makefile.js generatePrerelease -- beta", - "generate-rcrelease": "node Makefile.js generatePrerelease -- rc", - "publish-release": "node Makefile.js publishRelease", - "gensite": "node Makefile.js gensite", - "webpack": "node Makefile.js webpack", - "perf": "node Makefile.js perf", - "docs:update-links": "node tools/fetch-docs-links.js" + "test:fuzz": "node Makefile.js fuzz", + "test:performance": "node Makefile.js perf" }, "gitHooks": { "pre-commit": "lint-staged" From fbdf6da65f74abaa206be47b22600bb21aff9c4a Mon Sep 17 00:00:00 2001 From: Patrick McElhaney Date: Thu, 15 Sep 2022 16:02:58 -0400 Subject: [PATCH 2/9] put lint:fix right after lint --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index 4e8527545e9..f9c85315df8 100644 --- a/package.json +++ b/package.json @@ -22,9 +22,9 @@ "build:site": "node Makefile.js gensite", "build:webpack": "node Makefile.js webpack", "lint": "node Makefile.js lint", + "lint:fix": "node Makefile.js lint -- fix", "lint:docs:js": "node Makefile.js lintDocsJS", "lint:docs:js:fix": "node Makefile.js lintDocsJS -- fix", - "lint:fix": "node Makefile.js lint -- fix", "test": "node Makefile.js test", "test:cli": "mocha", "test:fuzz": "node Makefile.js fuzz", From 552072afa27bdc5377bb1aaf509dc826eed6afe9 Mon Sep 17 00:00:00 2001 From: Patrick McElhaney Date: Fri, 11 Nov 2022 18:57:31 -0500 Subject: [PATCH 3/9] chore: fix ordering of :fix Co-authored-by: Milos Djermanovic --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index f9c85315df8..d853afdb14b 100644 --- a/package.json +++ b/package.json @@ -24,7 +24,7 @@ "lint": "node Makefile.js lint", "lint:fix": "node Makefile.js lint -- fix", "lint:docs:js": "node Makefile.js lintDocsJS", - "lint:docs:js:fix": "node Makefile.js lintDocsJS -- fix", + "lint:fix:docs:js": "node Makefile.js lintDocsJS -- fix", "test": "node Makefile.js test", "test:cli": "mocha", "test:fuzz": "node Makefile.js fuzz", From 60bf6f855bfc8330db2e8dab74d0d1ad35b83c4a Mon Sep 17 00:00:00 2001 From: Patrick McElhaney Date: Mon, 28 Nov 2022 13:33:28 -0500 Subject: [PATCH 4/9] chore: change release scripts to have "release:" prefix Co-authored-by: Milos Djermanovic --- package.json | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/package.json b/package.json index d853afdb14b..e70210eebfe 100644 --- a/package.json +++ b/package.json @@ -14,11 +14,11 @@ }, "scripts": { "build:docs:update-links": "node tools/fetch-docs-links.js", - "build:release": "node Makefile.js generateRelease", - "build:release:alpha": "node Makefile.js generatePrerelease -- alpha", - "build:release:beta": "node Makefile.js generatePrerelease -- beta", - "build:release:publish": "node Makefile.js publishRelease", - "build:release:rc": "node Makefile.js generatePrerelease -- rc", + "release:generate:latest": "node Makefile.js generateRelease", + "release:generate:alpha": "node Makefile.js generatePrerelease -- alpha", + "release:generate:beta": "node Makefile.js generatePrerelease -- beta", + "release:publish": "node Makefile.js publishRelease", + "release:generate:rc": "node Makefile.js generatePrerelease -- rc", "build:site": "node Makefile.js gensite", "build:webpack": "node Makefile.js webpack", "lint": "node Makefile.js lint", From bb930b4c7d87013d524e469b664aff71c5cfca9c Mon Sep 17 00:00:00 2001 From: Patrick McElhaney Date: Mon, 28 Nov 2022 15:53:18 -0500 Subject: [PATCH 5/9] docs: update package.json naming to include 'release' --- .../package-json-conventions.md | 30 +++++++++---------- 1 file changed, 14 insertions(+), 16 deletions(-) diff --git a/docs/src/developer-guide/package-json-conventions.md b/docs/src/developer-guide/package-json-conventions.md index 4733b425264..f7727fa7654 100644 --- a/docs/src/developer-guide/package-json-conventions.md +++ b/docs/src/developer-guide/package-json-conventions.md @@ -10,22 +10,16 @@ The following applies to the "scripts" section of `package.json` files. npm script names MUST contain only lower case letters, `:` to separate parts, `-` to separate words, and `+` to separate file extensions. Each part name SHOULD be either a full English word (e.g. `coverage` not `cov`) or a well-known initialism in all lowercase (e.g. `wasm`). -Here is a summary of the proposal in EBNF. - -```ebnf -name = life-cycle | main ":fix"? target? option* ":watch"? - -life-cycle = prepare | preinstall | install | postinstall | prepublish | preprepare | prepare | postprepare | prepack | postpack | prepublishOnly; - -main = "build" | "lint" | "start" | "test"; - -target = ":" word ("-" word)* | extension ("+" extension)*; - -option = ":" word ("-" word)*; - -word = [a-z]+; - -extension = [a-z0-9]+; +Here is a summary of the proposal in ABNF. + +```abnf +name = life-cycle / main target? option* ":watch"? +life-cycle = "prepare" / "preinstall" / "install" / "postinstall" / "prepublish" / "preprepare" / "prepare" / "postprepare" / "prepack" / "postpack" / "prepublishOnly" +main = "build" / "lint" ":fix"? / "release" / "start" / "test" +target = ":" word ("-" word)* / extension ("+" extension)* +option = ":" word ("-" word)* +word = ALPHA + +extension = ( ALPHA / DIGIT )+ ``` ## Order @@ -42,6 +36,10 @@ Scripts that generate a set of files from source code and / or data MUST have na If a package contains any `build:*` scripts, there MAY be a script named `build`. If so, SHOULD produce the same output as running each of the `build` scripts individually. It MUST produce a subset of the output from running those scripts. +### Release + +Scripts that have public side effects (publishing the web site, committing to Git, etc.) MUST begin with `release`. + ### Lint Scripts that statically analyze files (mostly, but not limited to running `eslint` itself) MUST have names that begin with `lint`. From c7007c3980d32ccfc8372cc31c8cc69a2db404e2 Mon Sep 17 00:00:00 2001 From: Patrick McElhaney Date: Mon, 28 Nov 2022 16:07:12 -0500 Subject: [PATCH 6/9] docs: add css so abnf code formats okay --- docs/src/assets/scss/syntax-highlighter.scss | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/src/assets/scss/syntax-highlighter.scss b/docs/src/assets/scss/syntax-highlighter.scss index b0160f7e614..36c2f721775 100644 --- a/docs/src/assets/scss/syntax-highlighter.scss +++ b/docs/src/assets/scss/syntax-highlighter.scss @@ -106,6 +106,12 @@ pre[class*="language-"] { cursor: help; } +.language-abnf .token { + display: inline; + padding: 0; + margin: 0; +} + pre { counter-reset: lineNumber; } From ccd3370172b8f9503b9c742f2bdd2d9edea2eac9 Mon Sep 17 00:00:00 2001 From: Patrick McElhaney Date: Thu, 8 Dec 2022 14:51:40 -0500 Subject: [PATCH 7/9] chore: exclude linting from npm test --- Makefile.js | 1 - 1 file changed, 1 deletion(-) diff --git a/Makefile.js b/Makefile.js index cbfc0c0ea02..25d9303947e 100644 --- a/Makefile.js +++ b/Makefile.js @@ -629,7 +629,6 @@ target.karma = () => { }; target.test = function() { - target.lint(); target.checkRuleFiles(); target.mocha(); target.karma(); From e445fcd57f31d64d0b29fd0f5251f32bad94abd3 Mon Sep 17 00:00:00 2001 From: Patrick McElhaney Date: Tue, 13 Dec 2022 16:51:51 -0500 Subject: [PATCH 8/9] Revert "docs: add css so abnf code formats okay" This reverts commit c7007c3980d32ccfc8372cc31c8cc69a2db404e2. --- docs/src/assets/scss/syntax-highlighter.scss | 6 ------ 1 file changed, 6 deletions(-) diff --git a/docs/src/assets/scss/syntax-highlighter.scss b/docs/src/assets/scss/syntax-highlighter.scss index 392e0d5fa45..997e4319788 100644 --- a/docs/src/assets/scss/syntax-highlighter.scss +++ b/docs/src/assets/scss/syntax-highlighter.scss @@ -100,12 +100,6 @@ pre[class*="language-"] { cursor: help; } -.language-abnf .token { - display: inline; - padding: 0; - margin: 0; -} - pre { counter-reset: lineNumber; } From 9ee75d7aba06e4623874df16b56108172686baca Mon Sep 17 00:00:00 2001 From: Patrick McElhaney Date: Tue, 13 Dec 2022 16:55:00 -0500 Subject: [PATCH 9/9] docs: remove counter-reset. I guess that was a merge error --- docs/src/assets/scss/syntax-highlighter.scss | 4 ---- 1 file changed, 4 deletions(-) diff --git a/docs/src/assets/scss/syntax-highlighter.scss b/docs/src/assets/scss/syntax-highlighter.scss index 997e4319788..18269425cb1 100644 --- a/docs/src/assets/scss/syntax-highlighter.scss +++ b/docs/src/assets/scss/syntax-highlighter.scss @@ -100,10 +100,6 @@ pre[class*="language-"] { cursor: help; } -pre { - counter-reset: lineNumber; -} - .line-numbers-wrapper { position: absolute; top: 0;