✅ add eslint tests

Author: dudeofawesome

eslint-config-node/test/index.ts

@@ -1,19 +1,23 @@
 import { describe, it } from 'node:test';
 import { ESLint } from 'eslint';
-import { testRuleFail, noLintMessage } from '../../utils/testing/eslint';
+import {
+  testRuleFail,
+  testNoFail,
+  defaultTestSet,
+} from '../../utils/testing/eslint';
 
 const linter = new ESLint({ cwd: __dirname });
 
 describe('eslint-config-node', () => {
+  defaultTestSet(linter);
+
   describe('passes', () => {
     it(`should pass radix`, async () =>
-      linter.lintText(`parseInt('10');\n`).then(noLintMessage));
+      testNoFail(linter, `parseInt('10');\n`));
   });
+
   describe('fails', () => {
     it(`should fail no-console`, () =>
       testRuleFail(linter, `console.log('foo');\n`, 'no-console'));
-
-    it(`should fail eqeqeq`, () =>
-      testRuleFail(linter, `if (Number == true) Number();\n`, 'eqeqeq'));
   });
 });

eslint-config-typescript/.eslintrc.yaml

@@ -1,29 +1,10 @@
 extends:
   - 'plugin:@typescript-eslint/recommended'
-  - 'plugin:@shopify/typescript'
   - 'plugin:import/typescript'
-  - 'plugin:prettier/recommended'
-plugins:
-  - '@typescript-eslint'
-
-parser: '@typescript-eslint/parser'
 
 rules:
-  'id-length': 'off'
-  'no-negated-condition': 'off'
-  'no-nested-ternary': 'off'
-  '@typescript-eslint/no-explicit-any': 'error'
   '@typescript-eslint/no-inferrable-types': 'off'
   '@typescript-eslint/no-unused-vars':
     ['warn', { args: 'none', destructuredArrayIgnorePattern: '^_' }]
-  '@typescript-eslint/no-use-before-define': 'error'
   '@typescript-eslint/naming-convention': 'off'
-  'prettier/prettier': 'warn'
-  'import/order':
-    - 'error'
-    - groups:
-        - 'builtin'
-        - 'external'
-      newlines-between: 'ignore'
-  'import/no-cycle': 'off'
   '@shopify/binary-assignment-parens': 'off'

eslint-config-typescript/package.json

@@ -17,7 +17,7 @@
   "license": "MIT",
   "main": ".eslintrc.yaml",
   "scripts": {
-    "test": "echo 'No tests'; exit 0"
+    "test": "node --require ts-node/register --test test/index.ts"
   },
   "dependencies": {
     "@typescript-eslint/eslint-plugin": "^5.30.7",

eslint-config-typescript/test/.eslintrc.yaml

@@ -0,0 +1,6 @@
+root: true
+extends:
+  - '@dudeofawesome'
+  - '@dudeofawesome/typescript'
+parserOptions:
+  ecmaVersion: 2022

eslint-config-typescript/test/index.ts

@@ -0,0 +1,38 @@
+import { describe, it } from 'node:test';
+import { ESLint } from 'eslint';
+import {
+  defaultTestSet,
+  testNoFail,
+  testRuleFail,
+} from '../../utils/testing/eslint';
+
+const linter = new ESLint({ cwd: __dirname });
+
+describe('eslint-config-typescript', () => {
+  defaultTestSet(linter);
+
+  describe('passes', () => {
+    it(`should parse typescript`, () =>
+      testNoFail(linter, `((a: string): string[] => a.split(''))()\n`, true));
+
+    it(`should parse javascript`, () =>
+      testNoFail(linter, `((a) => a.split(''))()\n`));
+
+    it(`should not give eslint error on use before define`, () =>
+      testNoFail(
+        linter,
+        `Number(a);
+const a = 10;\n`,
+        true,
+      ));
+  });
+
+  describe('fails', () => {
+    it(`should fail radix`, async () =>
+      testRuleFail(linter, `parseInt('10');\n`, 'radix', true));
+
+    // TODO: test for shopify rule
+
+    // TODO: test for prettier rule
+  });
+});

eslint-config/.eslintrc.yaml

@@ -3,6 +3,7 @@ extends:
   - 'plugin:prettier/recommended'
 parserOptions:
   ecmaVersion: 2022 # Version is inline with Node 16
+  sourceType: 'module'
 
 rules:
   '@babel/new-cap': 'off'
@@ -13,6 +14,7 @@ rules:
         - 'builtin'
         - 'external'
         - 'internal'
+      newlines-between: 'ignore'
   import/no-default-export: 'error'
   line-comment-position: 'off'
   no-empty-function: 'warn'
@@ -32,4 +34,5 @@ rules:
   lines-between-class-members: 'off'
   no-useless-return: 'off'
   no-use-before-define: 'off'
+  eslint-comments/no-use: 'warn'
   '@shopify/binary-assignment-parens': 'off'

eslint-config/test/index.ts

@@ -1,16 +1,38 @@
 import { describe, it } from 'node:test';
 import { ESLint } from 'eslint';
-import { testRuleFail } from '../../utils/testing/eslint';
+import {
+  defaultTestSet,
+  testNoFail,
+  testRuleFail,
+} from '../../utils/testing/eslint';
+import { equal, strictEqual } from 'node:assert';
 
 const linter = new ESLint({ cwd: __dirname });
 
-describe('eslint-config-node', () => {
+describe('eslint-config', () => {
+  defaultTestSet(linter);
+
   describe('passes', () => {});
-  describe('fails', () => {
-    it(`should fail eqeqeq`, () =>
-      testRuleFail(linter, `if (Number == true) Number();\n`, 'eqeqeq'));
 
+  describe('fails', () => {
     it(`should fail radix`, async () =>
       testRuleFail(linter, `parseInt('10');\n`, 'radix'));
+
+    it(`should not parse typescript`, () =>
+      linter
+        .lintText(`((a: string): string[] => a.split(''))()\n`, {
+          filePath: 'input.ts',
+        })
+        .then((res) => {
+          equal(res[0].messages[0].ruleId, null);
+          strictEqual(
+            res[0].messages[0].message,
+            'Parsing error: Unexpected token, expected "," (1:3)',
+          );
+        }));
+
+    // TODO: test for shopify rule
+
+    // TODO: test for prettier rule
   });
 });

utils/testing/eslint.ts

@@ -1,23 +1,34 @@
+import { describe, it } from 'node:test';
 import { strictEqual } from 'node:assert';
 import { ESLint } from 'eslint';
 
-export async function testRuleFail(
-  linter: ESLint,
-  code: string,
-  ruleId: string,
-) {
-  const res = await linter.lintText(code);
-  singleLintMessage(res);
-  strictEqual(res[0].source, code);
-  strictEqual(res[0].messages[0].ruleId, ruleId);
+export function defaultTestSet(linter: ESLint) {
+  describe('[standard tests] passes', () => {
+    it(`should allow nested ternaries`, () =>
+      testNoFail(
+        linter,
+        `(() => (Number === true ? 1 : Boolean === true ? 2 : 3))();\n`,
+        true,
+      ));
+  });
+  describe('[standard tests] fails', () => {
+    it(`should fail eqeqeq`, () =>
+      testRuleFail(linter, `if (Number == true) Number();\n`, 'eqeqeq'));
+
+    it(`should warn on prettier`, () =>
+      testRuleFail(linter, `Number( '5')`, 'prettier/prettier'));
+
+    // TODO: test for shopify rule
+  });
 }
 
 export function noLintMessage(lint_results: ESLint.LintResult[]) {
-  strictEqual(lint_results.length, 1, `Expected there to be no lint results.`);
   strictEqual(
     lint_results[0].errorCount,
     0,
-    `Expected there to be no lint results.`,
+    `Expected there to be no lint errors, but found:\n${lint_results[0].messages
+      .map((m) => `  "${m.ruleId}": ${m.message}`)
+      .join('\n')}`,
   );
 }
 
@@ -35,3 +46,28 @@ export function singleLintMessage(lint_results: ESLint.LintResult[]) {
     }:\n${lint_results[0].messages.map((m) => `  "${m.message}"`).join('\n')}`,
   );
 }
+
+export async function testRuleFail(
+  linter: ESLint,
+  code: string,
+  ruleId: string,
+  typescript: boolean = false,
+) {
+  const res = await linter.lintText(code, {
+    filePath: `index.${typescript ? 'ts' : 'js'}`,
+  });
+  singleLintMessage(res);
+  strictEqual(res[0].source, code);
+  strictEqual(res[0].messages[0].ruleId, ruleId);
+}
+
+export async function testNoFail(
+  linter: ESLint,
+  code: string,
+  typescript: boolean = false,
+) {
+  const res = await linter.lintText(code, {
+    filePath: `index.${typescript ? 'ts' : 'js'}`,
+  });
+  noLintMessage(res);
+}