chore: refactor auto-generation scripts (#48)

ota-meshi · web-flow · commit 81fc6a29bece · 2023-01-26T10:33:21.000+09:00
* chore: refactor auto-generated scripts

* refactor
diff --git a/docs/rules/README.md b/docs/rules/README.md
@@ -235,8 +235,8 @@ There are multiple configs that enable all rules in this category: `plugin:es-x/
 
 ## Legacy
 
-Rules in this category disallow the syntax contained in [Annex B](https://tc39.es/ecma262/multipage/additional-ecmascript-features-for-web-browsers.html) or Legacy.  
-The rules are not included in any preset.
+Rules in this category disallow the syntax contained in [Annex B](https://tc39.es/ecma262/multipage/additional-ecmascript-features-for-web-browsers.html) or Legacy. \
+Rules in this category are not included in any preset.
 
 | Rule ID | Description |    |
 |:--------|:------------|:--:|
diff --git a/scripts/rules.js b/scripts/rules.js
@@ -18,42 +18,86 @@ const libRoot = path.resolve(__dirname, "../lib/rules")
 /**
  * @typedef {Object} Category
  * @property {string} id The category name.
- * @property {number} revision The revision number.
- * @property {string} configName The config name.
- * @property {string} aboveConfigName The config name for disallowing features all above.
+ * @property {string} title The category title.
+ * @property {number} [edition] The edition number.
+ * @property {string} [configName] The config name.
+ * @property {string} [aboveConfigName] The config name for disallowing features all above.
  * @property {Rule[]} rules The rules in this category.
  * @property {boolean} [experimental] The flag to be belong to experimental configs.
+ * @property {string} [comment] The category comment.
+ * @property {"ecma262" | "ecma402"} specKind The specification kind.
  */
 
 /** @type {Record<string, Category>} */
-const categories = [14, 13, 12, 11, 10, 9, 8, 7, 6, 5].reduce(
-    (map, revision, _, [latest]) => {
-        const year = revision <= 5 ? 5 : 2009 + revision
-        const id = `ES${year}`
-        map[id] = {
-            id,
-            title: id,
-            revision,
-            rules: [],
-            experimental: revision === latest,
+const categories = [
+    2023,
+    2022,
+    2021,
+    2020,
+    2019,
+    2018,
+    2017,
+    2016,
+    2015,
+    [5, 1],
+    [3, null],
+]
+    .map((esVersion) =>
+        Array.isArray(esVersion) ? esVersion : [esVersion, esVersion],
+    )
+    .reduce((map, versions, index, list) => {
+        const experimental = index === 0
+        const [vFor262, _vFor402] = versions
+        const [prevVFor262, _prevVFor402] = list[index + 1] || [null, null]
+        const ecma262Id = `ES${vFor262}`
+        if (prevVFor262) {
+            map[ecma262Id] = {
+                id: ecma262Id,
+                title: `ES${vFor262}`,
+                edition: vFor262 > 5 ? vFor262 - 2009 : vFor262,
+                rules: [],
+                experimental,
+                specKind: "ecma262",
+                configName: experimental
+                    ? "no-new-in-esnext"
+                    : `no-new-in-es${vFor262}`,
+                aboveConfigName: experimental
+                    ? undefined
+                    : `restrict-to-es${prevVFor262}`,
+            }
         }
+        // TODO: https://github.com/eslint-community/eslint-plugin-es-x/issues/45
+        // if (vFor402 && prevVFor402) {
+        //     const ecma402Id = `ES${vFor402}-Intl-API`
+        //     map[ecma402Id] = {
+        //         id: ecma402Id,
+        //         title: `ES${vFor402} Intl API`,
+        //         edition: vFor402 - 2013,
+        //         rules: [],
+        //         experimental,
+        //         specKind: "ecma402",
+        //         configName: experimental
+        //             ? "no-new-in-esnext-intl-api"
+        //             : `no-new-in-es${vFor402}-intl-api`,
+        //         aboveConfigName: experimental
+        //             ? undefined
+        //             : prevVFor402 === 1
+        //             ? "restrict-to-es-intl-api-1st-edition"
+        //             : `restrict-to-es${prevVFor402}-intl-api`,
+        //     }
+        // }
         return map
-    },
-    {},
-)
+    }, {})
 categories.legacy = {
     id: "legacy",
     title: "Legacy",
-    ignorePreset: true,
-    comment: `Rules in this category disallow the syntax contained in [Annex B](https://tc39.es/ecma262/multipage/additional-ecmascript-features-for-web-browsers.html) or Legacy.  
-The rules are not included in any preset.`,
+    comment:
+        "Rules in this category disallow the syntax contained in [Annex B](https://tc39.es/ecma262/multipage/additional-ecmascript-features-for-web-browsers.html) or Legacy.",
     rules: [],
 }
 categories.uncategorized = {
     id: "uncategorized",
     title: "Uncategorized",
-    ignorePreset: true,
-    comment: "Rules in this category are not included in any preset.",
     rules: [],
 }
 
diff --git a/scripts/update-docs-readme.js b/scripts/update-docs-readme.js
@@ -45,8 +45,13 @@ ${ruleSectionContent}
 
 function extractCategoryId(filePath) {
     const basename = path.basename(filePath, ".js")
-    const match = /no-new-in-(es\d+)/u.exec(basename)
-    return match ? match[1].toUpperCase() : undefined
+    const category = Object.values(categories).find(
+        ({ configName }) => configName === basename,
+    )
+    if (category) {
+        return category.id
+    }
+    return undefined
 }
 
 /**
@@ -57,17 +62,24 @@ function toSection(category) {
     if (!category.rules.length) {
         return undefined
     }
-    const configIds = formatList(
-        configs
-            .filter((c) => c.categoryIds.includes(category.id))
-            .map((c) => `\`${c.id}\``)
-            .sort(collator.compare.bind(collator)),
-    )
-    const comment =
-        category.comment ||
-        (configIds
-            ? `There are multiple configs that enable all rules in this category: ${configIds}`
-            : "There is a config that enables the rules in this category: `plugin:es-x/no-new-in-esnext`")
+    const configIds = configs
+        .filter((c) => c.categoryIds.includes(category.id))
+        .map((c) => `\`${c.id}\``)
+        .sort(collator.compare.bind(collator))
+
+    let comment = ""
+    if (category.comment) {
+        comment = `${category.comment} \\\n`
+    }
+    comment += !configIds.length
+        ? "Rules in this category are not included in any preset."
+        : configIds.length > 1
+        ? `There are multiple configs that enable all rules in this category: ${formatList(
+              configIds,
+          )}`
+        : `There is a config that enables the rules in this category: ${formatList(
+              configIds,
+          )}`
 
     return `## ${category.title}
 
diff --git a/scripts/update-lib-configs.js b/scripts/update-lib-configs.js
@@ -10,17 +10,6 @@ const { ESLint } = require("eslint")
 const { categories } = require("./rules")
 const Root = path.resolve(__dirname, "../lib/configs")
 
-function configNameToDisallowNewIn(revision) {
-    const year = revision <= 5 ? revision : 2009 + revision
-    return `no-new-in-es${year}`
-}
-
-function configNameToRestrictToPreviousOf(revision) {
-    const prevRev = revision === 5 ? 3 : revision - 1
-    const year = prevRev <= 5 ? prevRev : 2009 + prevRev
-    return `restrict-to-es${year}`
-}
-
 function wrapCode(code) {
     return `/**
  * DON'T EDIT THIS FILE.
@@ -32,33 +21,35 @@ module.exports = ${code}
 `
 }
 
-for (const { experimental, revision, rules, ignorePreset } of Object.values(
-    categories,
-)) {
-    if (ignorePreset) {
+for (const {
+    edition,
+    rules,
+    configName,
+    aboveConfigName,
+    specKind,
+} of Object.values(categories)) {
+    if (!configName) {
         continue
     }
     const ruleSetting = rules.map((r) => `"es-x/${r.ruleId}":"error"`).join(",")
-    const extendSetting = Object.values(categories)
-        .filter((c) => c.revision >= revision && !c.experimental)
-        .map(
-            (c) =>
-                `require.resolve("./${configNameToDisallowNewIn(c.revision)}")`,
-        )
-        .join(",")
 
-    if (experimental) {
-        fs.writeFileSync(
-            path.join(Root, "no-new-in-esnext.js"),
-            wrapCode(`{ plugins: ["es-x"], rules: { ${ruleSetting} } }`),
-        )
-    } else {
-        fs.writeFileSync(
-            path.join(Root, `${configNameToDisallowNewIn(revision)}.js`),
-            wrapCode(`{ plugins: ["es-x"], rules: { ${ruleSetting} } }`),
-        )
+    fs.writeFileSync(
+        path.join(Root, `${configName}.js`),
+        wrapCode(`{ plugins: ["es-x"], rules: { ${ruleSetting} } }`),
+    )
+    if (aboveConfigName) {
+        const extendSetting = Object.values(categories)
+            .filter(
+                (c) =>
+                    c.edition >= edition &&
+                    c.specKind === specKind &&
+                    !c.experimental &&
+                    c.configName,
+            )
+            .map((c) => `require.resolve("./${c.configName}")`)
+            .join(",")
         fs.writeFileSync(
-            path.join(Root, `${configNameToRestrictToPreviousOf(revision)}.js`),
+            path.join(Root, `${aboveConfigName}.js`),
             wrapCode(`{ extends: [${extendSetting}] }`),
         )
     }
