feat: migrate to ESM primary (#271)

Author: JounQin

.changeset/thin-beans-speak.md

@@ -0,0 +1,5 @@
+---
+"eslint-plugin-import-x": minor
+---
+
+feat: migrate to ESM primary

.env.yarn

@@ -0,0 +1,11 @@
+import { format } from 'prettier'
+
+import prettierRC from './.prettierrc.js'
+
+/** @type {import('eslint-doc-generator').GenerateOptions} */
+const config = {
+  postprocess: content =>
+    format(content, { ...prettierRC, parser: 'markdown' }),
+}
+
+export default config

.eslint-doc-generatorrc.js

@@ -1,6 +1,10 @@
+// ! This file is here for testing `no-unused-modules` rule for eslintrc
+
 const { version } = require('eslint/package.json')
 
-const nonLatestEslint = +version.split('.')[0] < 9
+const noEslintrc = +version.split('.')[0] > 8
+
+const testCompiled = process.env.TEST_COMPILED === '1'
 
 /**
  * @type {import('eslint').Linter.Config}
@@ -12,15 +16,15 @@ module.exports = {
     'eslint:recommended',
     'plugin:@typescript-eslint/recommended',
     'plugin:eslint-plugin/recommended',
-    'plugin:import-x/recommended',
+    testCompiled && 'plugin:import-x/recommended',
     'plugin:json/recommended-legacy',
     'plugin:mdx/recommended',
     'plugin:n/recommended',
-    'plugin:unicorn/recommended',
+    !noEslintrc && 'plugin:unicorn/recommended',
     'plugin:yml/standard',
     'plugin:yml/prettier',
     'plugin:prettier/recommended',
-  ],
+  ].filter(Boolean),
   env: {
     node: true,
     es6: true,
@@ -34,7 +38,7 @@ module.exports = {
     '@typescript-eslint/no-non-null-assertion': 'off',
     '@typescript-eslint/no-require-imports': 'off',
 
-    'no-constant-condition': nonLatestEslint ? 'off' : 'error',
+    'no-constant-condition': noEslintrc ? 'error' : 'off',
 
     'eslint-plugin/consistent-output': ['error', 'always'],
     'eslint-plugin/meta-property-ordering': 'error',
@@ -52,31 +56,36 @@ module.exports = {
     'n/no-missing-import': 'off',
     'n/no-missing-require': 'off',
     'n/no-unsupported-features/es-syntax': 'off',
-    'unicorn/filename-case': [
-      'error',
-      {
-        case: 'kebabCase',
-        ignore: [String.raw`^(CONTRIBUTING|README)\.md$`],
-      },
-    ],
+    ...(noEslintrc || {
+      'unicorn/filename-case': [
+        'error',
+        {
+          case: 'kebabCase',
+          ignore: [String.raw`^(CONTRIBUTING|README)\.md$`],
+        },
+      ],
+    }),
     'unicorn/no-array-callback-reference': 'off',
     'unicorn/no-array-reduce': 'off',
     'unicorn/no-null': 'off',
     'unicorn/prefer-module': 'off',
     'unicorn/prevent-abbreviations': 'off',
     'unicorn/prefer-at': 'off',
+    'unicorn/prefer-export-from': ['error', { ignoreUsedVariables: true }],
 
     // dog fooding
-    'import-x/no-extraneous-dependencies': [
-      'error',
-      {
-        devDependencies: ['test/**'],
-        optionalDependencies: false,
-        peerDependencies: true,
-        bundledDependencies: false,
-      },
-    ],
-    'import-x/unambiguous': 'off',
+    ...(testCompiled && {
+      'import-x/no-extraneous-dependencies': [
+        'error',
+        {
+          devDependencies: ['test/**'],
+          optionalDependencies: false,
+          peerDependencies: true,
+          bundledDependencies: false,
+        },
+      ],
+      'import-x/unambiguous': 'off',
+    }),
   },
 
   overrides: [
@@ -104,16 +113,18 @@ module.exports = {
             varsIgnorePattern: '^_',
           },
         ],
-        'import-x/consistent-type-specifier-style': 'error',
-        'import-x/order': [
-          'error',
-          {
-            alphabetize: {
-              order: 'asc',
+        ...(testCompiled && {
+          'import-x/consistent-type-specifier-style': 'error',
+          'import-x/order': [
+            'error',
+            {
+              alphabetize: {
+                order: 'asc',
+              },
+              'newlines-between': 'always',
             },
-            'newlines-between': 'always',
-          },
-        ],
+          ],
+        }),
       },
       settings: {
         'import-x/resolver': {

.eslint-doc-generatorrc.mjs

@@ -22,9 +22,9 @@ jobs:
           - 20
           - 22
         eslint:
-          - '8.56'
-          - '8'
-          - '9'
+          - 8.56
+          - 8
+          - 9
 
         include:
           - executeLint: true
@@ -44,22 +44,20 @@ jobs:
           cache: yarn
 
       - name: Install ESLint ${{ matrix.eslint }}
+        if: ${{ matrix.eslint != 9 }}
         run: |
-          yarn add -D eslint@${{ matrix.eslint }}
+          yarn add -D eslint@${{ matrix.eslint }} eslint-plugin-unicorn@56
 
       - name: Install Dependencies
         run: yarn --immutable
 
       - name: Build and Test
-        run: |
-          yarn test-compiled
-          yarn test
+        run: yarn run-s test-compiled test
 
       - name: Lint
         run: yarn lint
         if: ${{ matrix.executeLint }}
         env:
-          EFF_NO_LINK_RULES: true
           PARSER_NO_WATCH: true
 
       - name: Codecov

.eslintignore

@@ -1,8 +1,8 @@
 name: CodeQL
 
 on:
-  push:
-  pull_request:
+  push: null
+  pull_request: null
   schedule:
     - cron: '41 19 * * 6'