chore: Run readmes.js in CI (#15690)

babel · Jun 13, 2023 · be8fccd · be8fccd
1 parent d062d47
commit be8fccd
Show file tree

Hide file tree

Showing 156 changed files with 179 additions and 173 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -121,6 +121,9 @@ jobs:
       - name: Build Makefile.js
         run: |
           node ./scripts/pack-script.js
+      - name: Generate readmes
+        run: |
+          make generate-readme
       - name: Ensure cwd does not contain uncommitted changes
         run: |
           node ./scripts/assert-dir-git-clean.js build

diff --git a/Makefile b/Makefile
@@ -60,9 +60,10 @@ code-quality: tscheck lint
 tscheck:
 	$(MAKEJS) tscheck
 
-lint-ci: lint check-compat-data-ci
+lint-ci: lint check-compat-data
 
-check-compat-data-ci: check-compat-data
+generate-readme:
+	$(NODE) scripts/generators/readmes.js
 
 lint:
 	$(MAKEJS) lint

diff --git a/packages/babel-cli/README.md b/packages/babel-cli/README.md
@@ -2,7 +2,7 @@
 
 > Babel command line.
 
-See our website [@babel/cli](https://babeljs.io/docs/en/babel-cli) for more information or the [issues](https://github.com/babel/babel/issues?utf8=%E2%9C%93&q=is%3Aissue+label%3A%22pkg%3A%20cli%22+is%3Aopen) associated with this package.
+See our website [@babel/cli](https://babeljs.io/docs/babel-cli) for more information or the [issues](https://github.com/babel/babel/issues?utf8=%E2%9C%93&q=is%3Aissue+label%3A%22pkg%3A%20cli%22+is%3Aopen) associated with this package.
 
 ## Install
 

diff --git a/packages/babel-code-frame/README.md b/packages/babel-code-frame/README.md
@@ -2,7 +2,7 @@
 
 > Generate errors that contain a code frame that point to source locations.
 
-See our website [@babel/code-frame](https://babeljs.io/docs/en/babel-code-frame) for more information.
+See our website [@babel/code-frame](https://babeljs.io/docs/babel-code-frame) for more information.
 
 ## Install
 

diff --git a/packages/babel-compat-data/README.md b/packages/babel-compat-data/README.md
@@ -2,7 +2,7 @@
 
 > 
 
-See our website [@babel/compat-data](https://babeljs.io/docs/en/babel-compat-data) for more information.
+See our website [@babel/compat-data](https://babeljs.io/docs/babel-compat-data) for more information.
 
 ## Install
 

diff --git a/packages/babel-core/README.md b/packages/babel-core/README.md
@@ -2,7 +2,7 @@
 
 > Babel compiler core.
 
-See our website [@babel/core](https://babeljs.io/docs/en/babel-core) for more information or the [issues](https://github.com/babel/babel/issues?utf8=%E2%9C%93&q=is%3Aissue+label%3A%22pkg%3A%20core%22+is%3Aopen) associated with this package.
+See our website [@babel/core](https://babeljs.io/docs/babel-core) for more information or the [issues](https://github.com/babel/babel/issues?utf8=%E2%9C%93&q=is%3Aissue+label%3A%22pkg%3A%20core%22+is%3Aopen) associated with this package.
 
 ## Install
 

diff --git a/packages/babel-generator/README.md b/packages/babel-generator/README.md
@@ -2,7 +2,7 @@
 
 > Turns an AST into code.
 
-See our website [@babel/generator](https://babeljs.io/docs/en/babel-generator) for more information or the [issues](https://github.com/babel/babel/issues?utf8=%E2%9C%93&q=is%3Aissue+label%3A%22pkg%3A%20generator%22+is%3Aopen) associated with this package.
+See our website [@babel/generator](https://babeljs.io/docs/babel-generator) for more information or the [issues](https://github.com/babel/babel/issues?utf8=%E2%9C%93&q=is%3Aissue+label%3A%22pkg%3A%20generator%22+is%3Aopen) associated with this package.
 
 ## Install
 

diff --git a/packages/babel-helper-annotate-as-pure/README.md b/packages/babel-helper-annotate-as-pure/README.md
@@ -2,7 +2,7 @@
 
 > Helper function to annotate paths and nodes with #__PURE__ comment
 
-See our website [@babel/helper-annotate-as-pure](https://babeljs.io/docs/en/babel-helper-annotate-as-pure) for more information.
+See our website [@babel/helper-annotate-as-pure](https://babeljs.io/docs/babel-helper-annotate-as-pure) for more information.
 
 ## Install
 

diff --git a/packages/babel-helper-builder-binary-assignment-operator-visitor/README.md b/packages/babel-helper-builder-binary-assignment-operator-visitor/README.md
@@ -2,7 +2,7 @@
 
 > Helper function to build binary assignment operator visitors
 
-See our website [@babel/helper-builder-binary-assignment-operator-visitor](https://babeljs.io/docs/en/babel-helper-builder-binary-assignment-operator-visitor) for more information.
+See our website [@babel/helper-builder-binary-assignment-operator-visitor](https://babeljs.io/docs/babel-helper-builder-binary-assignment-operator-visitor) for more information.
 
 ## Install
 

diff --git a/packages/babel-helper-builder-react-jsx/README.md b/packages/babel-helper-builder-react-jsx/README.md
@@ -2,7 +2,7 @@
 
 > Helper function to build react jsx
 
-See our website [@babel/helper-builder-react-jsx](https://babeljs.io/docs/en/babel-helper-builder-react-jsx) for more information.
+See our website [@babel/helper-builder-react-jsx](https://babeljs.io/docs/babel-helper-builder-react-jsx) for more information.
 
 ## Install
 

diff --git a/packages/babel-helper-compilation-targets/README.md b/packages/babel-helper-compilation-targets/README.md
@@ -2,7 +2,7 @@
 
 > Helper functions on Babel compilation targets
 
-See our website [@babel/helper-compilation-targets](https://babeljs.io/docs/en/babel-helper-compilation-targets) for more information.
+See our website [@babel/helper-compilation-targets](https://babeljs.io/docs/babel-helper-compilation-targets) for more information.
 
 ## Install
 

diff --git a/packages/babel-helper-create-class-features-plugin/README.md b/packages/babel-helper-create-class-features-plugin/README.md
@@ -2,7 +2,7 @@
 
 > Compile class public and private fields, private methods and decorators to ES6
 
-See our website [@babel/helper-create-class-features-plugin](https://babeljs.io/docs/en/babel-helper-create-class-features-plugin) for more information.
+See our website [@babel/helper-create-class-features-plugin](https://babeljs.io/docs/babel-helper-create-class-features-plugin) for more information.
 
 ## Install
 

diff --git a/packages/babel-helper-create-regexp-features-plugin/README.md b/packages/babel-helper-create-regexp-features-plugin/README.md
@@ -2,7 +2,7 @@
 
 > Compile ESNext Regular Expressions to ES5
 
-See our website [@babel/helper-create-regexp-features-plugin](https://babeljs.io/docs/en/babel-helper-create-regexp-features-plugin) for more information.
+See our website [@babel/helper-create-regexp-features-plugin](https://babeljs.io/docs/babel-helper-create-regexp-features-plugin) for more information.
 
 ## Install
 

diff --git a/packages/babel-helper-environment-visitor/README.md b/packages/babel-helper-environment-visitor/README.md
@@ -2,7 +2,7 @@
 
 > Helper visitor to only visit nodes in the current 'this' context
 
-See our website [@babel/helper-environment-visitor](https://babeljs.io/docs/en/babel-helper-environment-visitor) for more information.
+See our website [@babel/helper-environment-visitor](https://babeljs.io/docs/babel-helper-environment-visitor) for more information.
 
 ## Install
 

diff --git a/packages/babel-helper-fixtures/README.md b/packages/babel-helper-fixtures/README.md
@@ -2,7 +2,7 @@
 
 > Helper function to support fixtures
 
-See our website [@babel/helper-fixtures](https://babeljs.io/docs/en/babel-helper-fixtures) for more information.
+See our website [@babel/helper-fixtures](https://babeljs.io/docs/babel-helper-fixtures) for more information.
 
 ## Install
 

diff --git a/packages/babel-helper-function-name/README.md b/packages/babel-helper-function-name/README.md
@@ -2,7 +2,7 @@
 
 > Helper function to change the property 'name' of every function
 
-See our website [@babel/helper-function-name](https://babeljs.io/docs/en/babel-helper-function-name) for more information.
+See our website [@babel/helper-function-name](https://babeljs.io/docs/babel-helper-function-name) for more information.
 
 ## Install
 

diff --git a/packages/babel-helper-hoist-variables/README.md b/packages/babel-helper-hoist-variables/README.md
@@ -2,7 +2,7 @@
 
 > Helper function to hoist variables
 
-See our website [@babel/helper-hoist-variables](https://babeljs.io/docs/en/babel-helper-hoist-variables) for more information.
+See our website [@babel/helper-hoist-variables](https://babeljs.io/docs/babel-helper-hoist-variables) for more information.
 
 ## Install
 

diff --git a/packages/babel-helper-member-expression-to-functions/README.md b/packages/babel-helper-member-expression-to-functions/README.md
@@ -2,7 +2,7 @@
 
 > Helper function to replace certain member expressions with function calls
 
-See our website [@babel/helper-member-expression-to-functions](https://babeljs.io/docs/en/babel-helper-member-expression-to-functions) for more information.
+See our website [@babel/helper-member-expression-to-functions](https://babeljs.io/docs/babel-helper-member-expression-to-functions) for more information.
 
 ## Install
 

diff --git a/packages/babel-helper-module-imports/README.md b/packages/babel-helper-module-imports/README.md
@@ -2,7 +2,7 @@
 
 > Babel helper functions for inserting module loads
 
-See our website [@babel/helper-module-imports](https://babeljs.io/docs/en/babel-helper-module-imports) for more information.
+See our website [@babel/helper-module-imports](https://babeljs.io/docs/babel-helper-module-imports) for more information.
 
 ## Install
 

diff --git a/packages/babel-helper-module-transforms/README.md b/packages/babel-helper-module-transforms/README.md
@@ -2,7 +2,7 @@
 
 > Babel helper functions for implementing ES6 module transformations
 
-See our website [@babel/helper-module-transforms](https://babeljs.io/docs/en/babel-helper-module-transforms) for more information.
+See our website [@babel/helper-module-transforms](https://babeljs.io/docs/babel-helper-module-transforms) for more information.
 
 ## Install
 

diff --git a/packages/babel-helper-optimise-call-expression/README.md b/packages/babel-helper-optimise-call-expression/README.md
@@ -2,7 +2,7 @@
 
 > Helper function to optimise call expression
 
-See our website [@babel/helper-optimise-call-expression](https://babeljs.io/docs/en/babel-helper-optimise-call-expression) for more information.
+See our website [@babel/helper-optimise-call-expression](https://babeljs.io/docs/babel-helper-optimise-call-expression) for more information.
 
 ## Install
 

diff --git a/packages/babel-helper-plugin-test-runner/README.md b/packages/babel-helper-plugin-test-runner/README.md
@@ -2,7 +2,7 @@
 
 > Helper function to support test runner
 
-See our website [@babel/helper-plugin-test-runner](https://babeljs.io/docs/en/babel-helper-plugin-test-runner) for more information.
+See our website [@babel/helper-plugin-test-runner](https://babeljs.io/docs/babel-helper-plugin-test-runner) for more information.
 
 ## Install
 

diff --git a/packages/babel-helper-plugin-utils/README.md b/packages/babel-helper-plugin-utils/README.md
@@ -2,7 +2,7 @@
 
 > General utilities for plugins to use
 
-See our website [@babel/helper-plugin-utils](https://babeljs.io/docs/en/babel-helper-plugin-utils) for more information.
+See our website [@babel/helper-plugin-utils](https://babeljs.io/docs/babel-helper-plugin-utils) for more information.
 
 ## Install
 

diff --git a/packages/babel-helper-remap-async-to-generator/README.md b/packages/babel-helper-remap-async-to-generator/README.md
@@ -2,7 +2,7 @@
 
 > Helper function to remap async functions to generators
 
-See our website [@babel/helper-remap-async-to-generator](https://babeljs.io/docs/en/babel-helper-remap-async-to-generator) for more information.
+See our website [@babel/helper-remap-async-to-generator](https://babeljs.io/docs/babel-helper-remap-async-to-generator) for more information.
 
 ## Install
 

diff --git a/packages/babel-helper-replace-supers/README.md b/packages/babel-helper-replace-supers/README.md
@@ -2,7 +2,7 @@
 
 > Helper function to replace supers
 
-See our website [@babel/helper-replace-supers](https://babeljs.io/docs/en/babel-helper-replace-supers) for more information.
+See our website [@babel/helper-replace-supers](https://babeljs.io/docs/babel-helper-replace-supers) for more information.
 
 ## Install
 

diff --git a/packages/babel-helper-simple-access/README.md b/packages/babel-helper-simple-access/README.md
@@ -2,7 +2,7 @@
 
 > Babel helper for ensuring that access to a given value is performed through simple accesses
 
-See our website [@babel/helper-simple-access](https://babeljs.io/docs/en/babel-helper-simple-access) for more information.
+See our website [@babel/helper-simple-access](https://babeljs.io/docs/babel-helper-simple-access) for more information.
 
 ## Install
 

diff --git a/packages/babel-helper-skip-transparent-expression-wrappers/README.md b/packages/babel-helper-skip-transparent-expression-wrappers/README.md
@@ -2,7 +2,7 @@
 
 > Helper which skips types and parentheses
 
-See our website [@babel/helper-skip-transparent-expression-wrappers](https://babeljs.io/docs/en/babel-helper-skip-transparent-expression-wrappers) for more information.
+See our website [@babel/helper-skip-transparent-expression-wrappers](https://babeljs.io/docs/babel-helper-skip-transparent-expression-wrappers) for more information.
 
 ## Install
 

diff --git a/packages/babel-helper-split-export-declaration/README.md b/packages/babel-helper-split-export-declaration/README.md
@@ -2,7 +2,7 @@
 
 > 
 
-See our website [@babel/helper-split-export-declaration](https://babeljs.io/docs/en/babel-helper-split-export-declaration) for more information.
+See our website [@babel/helper-split-export-declaration](https://babeljs.io/docs/babel-helper-split-export-declaration) for more information.
 
 ## Install
 

diff --git a/packages/babel-helper-string-parser/README.md b/packages/babel-helper-string-parser/README.md
@@ -2,7 +2,7 @@
 
 > A utility package to parse strings
 
-See our website [@babel/helper-string-parser](https://babeljs.io/docs/en/babel-helper-string-parser) for more information.
+See our website [@babel/helper-string-parser](https://babeljs.io/docs/babel-helper-string-parser) for more information.
 
 ## Install
 

diff --git a/packages/babel-helper-transform-fixture-test-runner/README.md b/packages/babel-helper-transform-fixture-test-runner/README.md
@@ -2,7 +2,7 @@
 
 > Transform test runner for @babel/helper-fixtures module
 
-See our website [@babel/helper-transform-fixture-test-runner](https://babeljs.io/docs/en/babel-helper-transform-fixture-test-runner) for more information.
+See our website [@babel/helper-transform-fixture-test-runner](https://babeljs.io/docs/babel-helper-transform-fixture-test-runner) for more information.
 
 ## Install
 

diff --git a/packages/babel-helper-validator-identifier/README.md b/packages/babel-helper-validator-identifier/README.md
@@ -2,7 +2,7 @@
 
 > Validate identifier/keywords name
 
-See our website [@babel/helper-validator-identifier](https://babeljs.io/docs/en/babel-helper-validator-identifier) for more information.
+See our website [@babel/helper-validator-identifier](https://babeljs.io/docs/babel-helper-validator-identifier) for more information.
 
 ## Install
 

diff --git a/packages/babel-helper-validator-option/README.md b/packages/babel-helper-validator-option/README.md
@@ -2,7 +2,7 @@
 
 > Validate plugin/preset options
 
-See our website [@babel/helper-validator-option](https://babeljs.io/docs/en/babel-helper-validator-option) for more information.
+See our website [@babel/helper-validator-option](https://babeljs.io/docs/babel-helper-validator-option) for more information.
 
 ## Install
 

diff --git a/packages/babel-helper-wrap-function/README.md b/packages/babel-helper-wrap-function/README.md
@@ -2,7 +2,7 @@
 
 > Helper to wrap functions inside a function call.
 
-See our website [@babel/helper-wrap-function](https://babeljs.io/docs/en/babel-helper-wrap-function) for more information.
+See our website [@babel/helper-wrap-function](https://babeljs.io/docs/babel-helper-wrap-function) for more information.
 
 ## Install
 

diff --git a/packages/babel-helpers/README.md b/packages/babel-helpers/README.md
@@ -2,7 +2,7 @@
 
 > Collection of helper functions used by Babel transforms.
 
-See our website [@babel/helpers](https://babeljs.io/docs/en/babel-helpers) for more information.
+See our website [@babel/helpers](https://babeljs.io/docs/babel-helpers) for more information.
 
 ## Install
 

diff --git a/packages/babel-highlight/README.md b/packages/babel-highlight/README.md
@@ -2,7 +2,7 @@
 
 > Syntax highlight JavaScript strings for output in terminals.
 
-See our website [@babel/highlight](https://babeljs.io/docs/en/babel-highlight) for more information.
+See our website [@babel/highlight](https://babeljs.io/docs/babel-highlight) for more information.
 
 ## Install
 

diff --git a/packages/babel-node/README.md b/packages/babel-node/README.md
@@ -2,7 +2,7 @@
 
 > Babel command line
 
-See our website [@babel/node](https://babeljs.io/docs/en/babel-node) for more information.
+See our website [@babel/node](https://babeljs.io/docs/babel-node) for more information.
 
 ## Install
 

diff --git a/packages/babel-parser/README.md b/packages/babel-parser/README.md
@@ -2,7 +2,7 @@
 
 > A JavaScript parser
 
-See our website [@babel/parser](https://babeljs.io/docs/en/babel-parser) for more information or the [issues](https://github.com/babel/babel/issues?utf8=%E2%9C%93&q=is%3Aissue+label%3A%22pkg%3A%20parser%20(babylon)%22+is%3Aopen) associated with this package.
+See our website [@babel/parser](https://babeljs.io/docs/babel-parser) for more information or the [issues](https://github.com/babel/babel/issues?utf8=%E2%9C%93&q=is%3Aissue+label%3A%22pkg%3A%20parser%22+is%3Aopen) associated with this package.
 
 ## Install
 

diff --git a/...lugin-bugfix-safari-id-destructuring-collision-in-function-expression/README.md b/...lugin-bugfix-safari-id-destructuring-collision-in-function-expression/README.md
@@ -2,7 +2,7 @@
 
 > Rename destructuring parameter to workaround https://bugs.webkit.org/show_bug.cgi?id=220517
 
-See our website [@babel/plugin-bugfix-safari-id-destructuring-collision-in-function-expression](https://babeljs.io/docs/en/babel-plugin-bugfix-safari-id-destructuring-collision-in-function-expression) for more information.
+See our website [@babel/plugin-bugfix-safari-id-destructuring-collision-in-function-expression](https://babeljs.io/docs/babel-plugin-bugfix-safari-id-destructuring-collision-in-function-expression) for more information.
 
 ## Install
 

diff --git a/packages/babel-plugin-bugfix-v8-spread-parameters-in-optional-chaining/README.md b/packages/babel-plugin-bugfix-v8-spread-parameters-in-optional-chaining/README.md
@@ -2,7 +2,7 @@
 
 > Transform optional chaining operators to workaround https://crbug.com/v8/11558
 
-See our website [@babel/plugin-bugfix-v8-spread-parameters-in-optional-chaining](https://babeljs.io/docs/en/babel-plugin-bugfix-v8-spread-parameters-in-optional-chaining) for more information.
+See our website [@babel/plugin-bugfix-v8-spread-parameters-in-optional-chaining](https://babeljs.io/docs/babel-plugin-bugfix-v8-spread-parameters-in-optional-chaining) for more information.
 
 ## Install
 

diff --git a/packages/babel-plugin-external-helpers/README.md b/packages/babel-plugin-external-helpers/README.md
@@ -2,7 +2,7 @@
 
 > This plugin contains helper functions that’ll be placed at the top of the generated code
 
-See our website [@babel/plugin-external-helpers](https://babeljs.io/docs/en/babel-plugin-external-helpers) for more information.
+See our website [@babel/plugin-external-helpers](https://babeljs.io/docs/babel-plugin-external-helpers) for more information.
 
 ## Install
 

diff --git a/packages/babel-plugin-proposal-async-do-expressions/README.md b/packages/babel-plugin-proposal-async-do-expressions/README.md
@@ -2,7 +2,7 @@
 
 > Transform async do expressions to ES2021
 
-See our website [@babel/plugin-proposal-async-do-expressions](https://babeljs.io/docs/en/babel-plugin-proposal-async-do-expressions) for more information.
+See our website [@babel/plugin-proposal-async-do-expressions](https://babeljs.io/docs/babel-plugin-proposal-async-do-expressions) for more information.
 
 ## Install
 

diff --git a/packages/babel-plugin-proposal-decorators/README.md b/packages/babel-plugin-proposal-decorators/README.md
@@ -2,7 +2,7 @@
 
 > Compile class and object decorators to ES5
 
-See our website [@babel/plugin-proposal-decorators](https://babeljs.io/docs/en/babel-plugin-proposal-decorators) for more information.
+See our website [@babel/plugin-proposal-decorators](https://babeljs.io/docs/babel-plugin-proposal-decorators) for more information.
 
 ## Install
 

diff --git a/packages/babel-plugin-proposal-destructuring-private/README.md b/packages/babel-plugin-proposal-destructuring-private/README.md
@@ -2,7 +2,7 @@
 
 > Transform destructuring private proposal
 
-See our website [@babel/plugin-proposal-destructuring-private](https://babeljs.io/docs/en/babel-plugin-proposal-destructuring-private) for more information.
+See our website [@babel/plugin-proposal-destructuring-private](https://babeljs.io/docs/babel-plugin-proposal-destructuring-private) for more information.
 
 ## Install