From d74a07eff6fd97d2e28cdfa32249063877c9e0ee Mon Sep 17 00:00:00 2001
From: patrick <pa.trickjlp@gmail.com>
Date: Thu, 24 Aug 2023 13:51:24 +0200
Subject: [PATCH] add gjs/gts recommended configs

---
 .eslintignore                 |  4 ++-
 README.md                     | 46 +++++++++++++++++++++++++++++++----
 docs/svgs/gjs.svg             | 16 ++++++++++++
 docs/svgs/gts.svg             | 16 ++++++++++++
 lib/config/base.js            | 27 ++++++++++++++++++++
 lib/config/recommended-gjs.js |  7 ++++++
 lib/config/recommended-gts.js |  7 ++++++
 lib/config/recommended.js     | 33 ++-----------------------
 lib/recommended-rules-gjs.js  |  7 ++++++
 lib/recommended-rules-gts.js  |  7 ++++++
 scripts/update-rules.js       | 45 +++++++++++++++++++---------------
 tests/plugin-exports.js       | 10 +++++++-
 12 files changed, 167 insertions(+), 58 deletions(-)
 create mode 100644 docs/svgs/gjs.svg
 create mode 100644 docs/svgs/gts.svg
 create mode 100644 lib/config/base.js
 create mode 100644 lib/config/recommended-gjs.js
 create mode 100644 lib/config/recommended-gts.js
 create mode 100644 lib/recommended-rules-gjs.js
 create mode 100644 lib/recommended-rules-gts.js

diff --git a/.eslintignore b/.eslintignore
index 6374debcdc..071bd5627c 100644
--- a/.eslintignore
+++ b/.eslintignore
@@ -1,6 +1,8 @@
 coverage/
 node_modules
 lib/recommended-rules.js
+lib/recommended-rules-gjs.js
+lib/recommended-rules-gts.js
 
 # Contains <template> in js markdown
-docs/rules/no-empty-glimmer-component-classes.md
\ No newline at end of file
+docs/rules/no-empty-glimmer-component-classes.md
diff --git a/README.md b/README.md
index ad397700b2..3f41e289b6 100644
--- a/README.md
+++ b/README.md
@@ -53,9 +53,42 @@ learn more [here](https://github.com/ember-template-imports/ember-template-impor
 module.exports = {
   overrides: [
     {
-      files: ['**/*.gts', '**/*.gjs'],
+      files: ['**/*.{js,ts,gjs,gts}'],
+      plugins: ['ember'],
+      extends: [
+        'eslint:recommended',
+        'plugin:ember/gts-recommended', // or other configuration
+      ],
+      rules: {
+        // override / enable optional rules
+        'ember/no-replace-test-comments': 'error'
+      }
+    },
+    {
+      files: ['**/*.gts'],
+      parser: 'eslint-plugin-ember/gjs-gts-parser',
+      plugins: ['ember'],
+      extends: [
+        'eslint:recommended',
+        'plugin:ember/gts-recommended', // or other configuration
+      ],
+    },
+    {
+      files: ['**/*.gjs'],
       parser: 'eslint-plugin-ember/gjs-gts-parser',
-    }
+      plugins: ['ember'],
+      extends: [
+        'eslint:recommended',
+        'plugin:ember/gjs-recommended', // or other configuration
+      ],
+    },
+    {
+      files: ['tests/**/*.{js,ts,gjs,gts}'],
+      rules: {
+        // override / enable optional rules
+        'ember/no-replace-test-comments': 'error'
+      }
+    },
   ],
 };
 ```
@@ -64,9 +97,12 @@ module.exports = {
 
 <!-- begin auto-generated configs list -->
 
-|    | Name          |
-| :- | :------------ |
-| ✅  | `recommended` |
+|    | Name              |
+| :- | :---------------- |
+|    | `base`            |
+| ✅  | `recommended`     |
+|    | `recommended-gjs` |
+|    | `recommended-gts` |
 
 <!-- end auto-generated configs list -->
 
diff --git a/docs/svgs/gjs.svg b/docs/svgs/gjs.svg
new file mode 100644
index 0000000000..9f38666366
--- /dev/null
+++ b/docs/svgs/gjs.svg
@@ -0,0 +1,16 @@
+<svg xmlns="http://www.w3.org/2000/svg"  version="1.1" width="15" height="15" viewBox="0 0 15 15" xml:space="preserve">
+	<g transform="matrix(0.07 0 0 0.07 5.28 7.97)">
+<g style="">
+		<g transform="matrix(1 0 0 1 222.86 55.69)">
+<path style="stroke: none; stroke-width: 1; stroke-dasharray: none; stroke-linecap: butt; stroke-dashoffset: 0; stroke-linejoin: miter; stroke-miterlimit: 4; fill: rgb(33,33,33); fill-rule: nonzero; opacity: 1;" transform=" translate(-353.36, -167.69)" d="M 353.357 167.687 z" stroke-linecap="round"/>
+</g>
+	<g transform="matrix(1 0 0 1 29.81 0.31)">
+<path style="stroke: none; stroke-width: 1; stroke-dasharray: none; stroke-linecap: butt; stroke-dashoffset: 0; stroke-linejoin: miter; stroke-miterlimit: 4; fill: rgb(224,78,57); fill-rule: nonzero; opacity: 1;" transform=" translate(-160.31, -112.31)" d="M 260.62 112.31 c 0 55.399 -44.911 100.31 -100.31 100.31 c -55.4 0 -100.31 -44.912 -100.31 -100.31 C 60 56.91 104.91 12 160.31 12 c 55.399 0 100.31 44.91 100.31 100.31" stroke-linecap="round"/>
+</g>
+	<g transform="matrix(1 0 0 1 30.77 1.11)">
+<path style="stroke: none; stroke-width: 1; stroke-dasharray: none; stroke-linecap: butt; stroke-dashoffset: 0; stroke-linejoin: miter; stroke-miterlimit: 4; fill: rgb(255,255,255); fill-rule: nonzero; opacity: 1;" transform=" translate(-161.27, -113.11)" d="M 121.62 122.003 a 8.926 8.926 0 0 1 -6.232 -2.524 a 8.956 8.956 0 0 1 -0.2 -12.664 l 60.455 -62.395 a 8.956 8.956 0 1 1 12.864 12.464 l -60.454 62.395 a 8.931 8.931 0 0 1 -6.434 2.724 h 0.001 z m 39.427 2.38 a 8.929 8.929 0 0 1 -6.411 -15.141 l 47.746 -49.28 a 8.93 8.93 0 0 1 12.825 12.425 l -47.747 49.28 a 8.904 8.904 0 0 1 -6.413 2.716 z m -19.35 62.134 a 8.92 8.92 0 0 1 -6.23 -2.525 a 8.956 8.956 0 0 1 -0.202 -12.664 l 83.514 -86.195 a 8.957 8.957 0 0 1 12.864 12.465 l -83.513 86.195 a 8.931 8.931 0 0 1 -6.433 2.724 z m -26.205 -15.237 a 8.924 8.924 0 0 1 -6.231 -2.524 a 8.954 8.954 0 0 1 -0.2 -12.664 l 22.767 -23.499 a 8.957 8.957 0 0 1 12.865 12.464 l -22.768 23.5 a 8.931 8.931 0 0 1 -6.433 2.723 z m -18.165 -67.992 A 8.956 8.956 0 0 1 90.895 88.1 l 22.768 -23.5 a 8.957 8.957 0 0 1 12.865 12.465 l -22.768 23.499 a 8.932 8.932 0 0 1 -6.433 2.724 z m 117.106 51.17 a 8.926 8.926 0 0 1 -6.231 -2.525 a 8.956 8.956 0 0 1 -0.2 -12.664 l 10.778 -11.124 a 8.955 8.955 0 0 1 12.664 -0.2 a 8.956 8.956 0 0 1 0.2 12.664 l -10.778 11.124 a 8.931 8.931 0 0 1 -6.433 2.724 v 0.001 z m -20.987 22.207 a 8.956 8.956 0 0 1 -8.957 8.956 a 8.956 8.956 0 1 1 8.957 -8.956 z m -85.595 -40.12 a 8.957 8.957 0 1 1 -17.913 0 a 8.957 8.957 0 0 1 17.913 0 z m 42.541 -87.883 a 8.956 8.956 0 0 1 -8.956 8.956 a 8.957 8.957 0 1 1 8.956 -8.956 z" stroke-linecap="round"/>
+</g>
+</g>
+</g>
+  <text font-family="monospace" y="13px" x="7" font-size="8">js</text>
+</svg>
diff --git a/docs/svgs/gts.svg b/docs/svgs/gts.svg
new file mode 100644
index 0000000000..75b97712f4
--- /dev/null
+++ b/docs/svgs/gts.svg
@@ -0,0 +1,16 @@
+<svg xmlns="http://www.w3.org/2000/svg"  version="1.1" width="15" height="15" viewBox="0 0 15 15" xml:space="preserve">
+	<g transform="matrix(0.07 0 0 0.07 5.28 7.97)">
+<g style="">
+		<g transform="matrix(1 0 0 1 222.86 55.69)">
+<path style="stroke: none; stroke-width: 1; stroke-dasharray: none; stroke-linecap: butt; stroke-dashoffset: 0; stroke-linejoin: miter; stroke-miterlimit: 4; fill: rgb(33,33,33); fill-rule: nonzero; opacity: 1;" transform=" translate(-353.36, -167.69)" d="M 353.357 167.687 z" stroke-linecap="round"/>
+</g>
+	<g transform="matrix(1 0 0 1 29.81 0.31)">
+<path style="stroke: none; stroke-width: 1; stroke-dasharray: none; stroke-linecap: butt; stroke-dashoffset: 0; stroke-linejoin: miter; stroke-miterlimit: 4; fill: rgb(57,78, 170); fill-rule: nonzero; opacity: 1;" transform=" translate(-160.31, -112.31)" d="M 260.62 112.31 c 0 55.399 -44.911 100.31 -100.31 100.31 c -55.4 0 -100.31 -44.912 -100.31 -100.31 C 60 56.91 104.91 12 160.31 12 c 55.399 0 100.31 44.91 100.31 100.31" stroke-linecap="round"/>
+</g>
+	<g transform="matrix(1 0 0 1 30.77 1.11)">
+<path style="stroke: none; stroke-width: 1; stroke-dasharray: none; stroke-linecap: butt; stroke-dashoffset: 0; stroke-linejoin: miter; stroke-miterlimit: 4; fill: rgb(255,255,255); fill-rule: nonzero; opacity: 1;" transform=" translate(-161.27, -113.11)" d="M 121.62 122.003 a 8.926 8.926 0 0 1 -6.232 -2.524 a 8.956 8.956 0 0 1 -0.2 -12.664 l 60.455 -62.395 a 8.956 8.956 0 1 1 12.864 12.464 l -60.454 62.395 a 8.931 8.931 0 0 1 -6.434 2.724 h 0.001 z m 39.427 2.38 a 8.929 8.929 0 0 1 -6.411 -15.141 l 47.746 -49.28 a 8.93 8.93 0 0 1 12.825 12.425 l -47.747 49.28 a 8.904 8.904 0 0 1 -6.413 2.716 z m -19.35 62.134 a 8.92 8.92 0 0 1 -6.23 -2.525 a 8.956 8.956 0 0 1 -0.202 -12.664 l 83.514 -86.195 a 8.957 8.957 0 0 1 12.864 12.465 l -83.513 86.195 a 8.931 8.931 0 0 1 -6.433 2.724 z m -26.205 -15.237 a 8.924 8.924 0 0 1 -6.231 -2.524 a 8.954 8.954 0 0 1 -0.2 -12.664 l 22.767 -23.499 a 8.957 8.957 0 0 1 12.865 12.464 l -22.768 23.5 a 8.931 8.931 0 0 1 -6.433 2.723 z m -18.165 -67.992 A 8.956 8.956 0 0 1 90.895 88.1 l 22.768 -23.5 a 8.957 8.957 0 0 1 12.865 12.465 l -22.768 23.499 a 8.932 8.932 0 0 1 -6.433 2.724 z m 117.106 51.17 a 8.926 8.926 0 0 1 -6.231 -2.525 a 8.956 8.956 0 0 1 -0.2 -12.664 l 10.778 -11.124 a 8.955 8.955 0 0 1 12.664 -0.2 a 8.956 8.956 0 0 1 0.2 12.664 l -10.778 11.124 a 8.931 8.931 0 0 1 -6.433 2.724 v 0.001 z m -20.987 22.207 a 8.956 8.956 0 0 1 -8.957 8.956 a 8.956 8.956 0 1 1 8.957 -8.956 z m -85.595 -40.12 a 8.957 8.957 0 1 1 -17.913 0 a 8.957 8.957 0 0 1 17.913 0 z m 42.541 -87.883 a 8.956 8.956 0 0 1 -8.956 8.956 a 8.957 8.957 0 1 1 8.956 -8.956 z" stroke-linecap="round"/>
+</g>
+</g>
+</g>
+  <text font-family="monospace" y="13px" x="7" font-size="8">ts</text>
+</svg>
diff --git a/lib/config/base.js b/lib/config/base.js
new file mode 100644
index 0000000000..9bb27a994c
--- /dev/null
+++ b/lib/config/base.js
@@ -0,0 +1,27 @@
+module.exports = {
+  root: true,
+
+  parserOptions: {
+    ecmaVersion: 2020,
+    sourceType: 'module',
+  },
+
+  env: {
+    browser: true,
+    es2020: true,
+  },
+
+  plugins: ['ember'],
+
+  overrides: [
+    /**
+     * We don't want to *always* have the preprocessor active,
+     * it's only relevant on gjs and gts files to detect if eslint config is correctly setup for this files.
+     */
+    {
+      files: ['**/*.{gts,gjs}'],
+      parser: 'eslint-plugin-ember/gjs-gts-parser',
+      processor: 'ember/<noop>',
+    },
+  ],
+};
diff --git a/lib/config/recommended-gjs.js b/lib/config/recommended-gjs.js
new file mode 100644
index 0000000000..924c05ff2e
--- /dev/null
+++ b/lib/config/recommended-gjs.js
@@ -0,0 +1,7 @@
+const base = require('./base');
+const gjsRules = require('../recommended-rules-gjs');
+
+module.exports = {
+  ...base,
+  rules: gjsRules,
+};
diff --git a/lib/config/recommended-gts.js b/lib/config/recommended-gts.js
new file mode 100644
index 0000000000..c29d094dd3
--- /dev/null
+++ b/lib/config/recommended-gts.js
@@ -0,0 +1,7 @@
+const base = require('./base');
+const gtsRules = require('../recommended-rules-gts');
+
+module.exports = {
+  ...base,
+  rules: gtsRules,
+};
diff --git a/lib/config/recommended.js b/lib/config/recommended.js
index c3b9227f0b..7f83b5711c 100644
--- a/lib/config/recommended.js
+++ b/lib/config/recommended.js
@@ -1,36 +1,7 @@
+const base = require('./base');
 const rules = require('../recommended-rules');
 
 module.exports = {
-  root: true,
-
-  parserOptions: {
-    ecmaVersion: 2020,
-    sourceType: 'module',
-  },
-
-  env: {
-    browser: true,
-    es2020: true,
-  },
-
-  plugins: ['ember'],
-
+  ...base,
   rules,
-
-  overrides: [
-    /**
-     * We don't want to *always* have the preprocessor active,
-     * it's only relevant on gjs and gts files.
-     *
-     * Additionally, we need to declare a global (which is private API)
-     * so that ESLint doesn't report errors about the variable being undefined.
-     * While this is true, it's a temporary thing for babel to do further processing
-     * on -- and isn't relevant to user-land code.
-     */
-    {
-      files: ['**/*.gts', '**/*.gjs'],
-      parser: 'eslint-plugin-ember/gjs-gts-parser',
-      processor: 'ember/<noop>',
-    },
-  ],
 };
diff --git a/lib/recommended-rules-gjs.js b/lib/recommended-rules-gjs.js
new file mode 100644
index 0000000000..7c4139bf61
--- /dev/null
+++ b/lib/recommended-rules-gjs.js
@@ -0,0 +1,7 @@
+/*
+ * IMPORTANT!
+ * This file has been automatically generated.
+ * In order to update its content based on rules'
+ * definitions, execute "npm run update"
+ */
+module.exports = {}
\ No newline at end of file
diff --git a/lib/recommended-rules-gts.js b/lib/recommended-rules-gts.js
new file mode 100644
index 0000000000..7c4139bf61
--- /dev/null
+++ b/lib/recommended-rules-gts.js
@@ -0,0 +1,7 @@
+/*
+ * IMPORTANT!
+ * This file has been automatically generated.
+ * In order to update its content based on rules'
+ * definitions, execute "npm run update"
+ */
+module.exports = {}
\ No newline at end of file
diff --git a/scripts/update-rules.js b/scripts/update-rules.js
index 814fb5c49f..dbf00f3fb4 100644
--- a/scripts/update-rules.js
+++ b/scripts/update-rules.js
@@ -18,25 +18,25 @@ const path = require('path');
 // Main
 // ------------------------------------------------------------------------------
 
-const root = path.resolve(__dirname, '../lib/rules');
-const recommendedRulesFile = path.resolve(__dirname, '../lib/recommended-rules.js');
-
-const rules = fs
-  .readdirSync(root)
-  .filter((file) => path.extname(file) === '.js')
-  .map((file) => path.basename(file, '.js'))
-  .map((fileName) => [fileName, require(path.join(root, fileName))]); // eslint-disable-line import/no-dynamic-require
-
-const recommendedRules = rules.reduce((obj, entry) => {
-  const name = `ember/${entry[0]}`;
-  const recommended = entry[1].meta.docs.recommended;
-  if (recommended) {
-    obj[name] = 'error'; // eslint-disable-line no-param-reassign
-  }
-  return obj;
-}, {});
-
-const recommendedRulesContent = `/*
+function generate(filename, filter) {
+  const root = path.resolve(__dirname, '../lib/rules');
+  const recommendedRulesFile = path.resolve(__dirname, filename);
+
+  const rules = fs
+    .readdirSync(root)
+    .filter((file) => path.extname(file) === '.js')
+    .map((file) => path.basename(file, '.js'))
+    .map((fileName) => [fileName, require(path.join(root, fileName))]); // eslint-disable-line import/no-dynamic-require
+
+  const recommendedRules = rules.reduce((obj, entry) => {
+    const name = `ember/${entry[0]}`;
+    if (filter(entry)) {
+      obj[name] = 'error'; // eslint-disable-line no-param-reassign
+    }
+    return obj;
+  }, {});
+
+  const recommendedRulesContent = `/*
  * IMPORTANT!
  * This file has been automatically generated.
  * In order to update its content based on rules'
@@ -44,4 +44,9 @@ const recommendedRulesContent = `/*
  */
 module.exports = ${JSON.stringify(recommendedRules, null, 2)}`;
 
-fs.writeFileSync(recommendedRulesFile, recommendedRulesContent);
+  fs.writeFileSync(recommendedRulesFile, recommendedRulesContent);
+}
+
+generate('../lib/recommended-rules.js', (entry) => entry[1].meta.docs.recommended);
+generate('../lib/recommended-rules-gjs.js', (entry) => entry[1].meta.docs.category === 'gjs');
+generate('../lib/recommended-rules-gts.js', (entry) => entry[1].meta.docs.category === 'gts');
diff --git a/tests/plugin-exports.js b/tests/plugin-exports.js
index af06146cd6..88f6c5b356 100644
--- a/tests/plugin-exports.js
+++ b/tests/plugin-exports.js
@@ -2,7 +2,10 @@
 
 const plugin = require('../lib');
 const ember = require('../lib/utils/ember');
+const base = require('../lib/config/base');
 const recommended = require('../lib/config/recommended');
+const recommendedGjs = require('../lib/config/recommended-gjs');
+const recommendedGts = require('../lib/config/recommended-gts');
 
 describe('plugin exports', () => {
   describe('utils', () => {
@@ -13,7 +16,12 @@ describe('plugin exports', () => {
 
   describe('configs', () => {
     it('has the right configurations', () => {
-      expect(plugin.configs).toStrictEqual({ recommended });
+      expect(plugin.configs).toStrictEqual({
+        base,
+        recommended,
+        'recommended-gjs': recommendedGjs,
+        'recommended-gts': recommendedGts,
+      });
     });
   });
 });