chore: some ESLint improvements (#283)

* chore: update eslint config

* chore: auto enforce import sorting

* chore: fix unresolved shiki imports

* chore: remove unused file

* chore: enable import-x rules to all mjs files

* chore: remove unused eslint directive

* chore: remove eslint-config-prettier

* chore: use eslint globals.nodeBuiltin

* refactor: fix rebase issues

* refactor: fix rebase issues

Author: araujogui

bin/cli.mjs

@@ -1,11 +1,12 @@
 #!/usr/bin/env node
 
 import process from 'node:process';
+
 import { Argument, Command, Option } from 'commander';
 
+import commands from './commands/index.mjs';
 import interactive from './commands/interactive.mjs';
 import list, { types } from './commands/list.mjs';
-import commands from './commands/index.mjs';
 import { errorWrap } from './utils.mjs';
 
 const program = new Command()

bin/commands/generate.mjs

@@ -7,12 +7,12 @@ import {
   DOC_NODE_CHANGELOG_URL,
   DOC_NODE_VERSION,
 } from '../../src/constants.mjs';
-import createGenerator from '../../src/generators.mjs';
 import { publicGenerators } from '../../src/generators/index.mjs';
-import createNodeReleases from '../../src/releases.mjs';
-import { loadAndParse } from '../utils.mjs';
+import createGenerator from '../../src/generators.mjs';
 import createLinter from '../../src/linter/index.mjs';
 import { getEnabledRules } from '../../src/linter/utils/rules.mjs';
+import createNodeReleases from '../../src/releases.mjs';
+import { loadAndParse } from '../utils.mjs';
 
 const availableGenerators = Object.keys(publicGenerators);
 

bin/commands/lint.mjs

@@ -3,8 +3,8 @@ import process from 'node:process';
 import createLinter from '../../src/linter/index.mjs';
 import reporters from '../../src/linter/reporters/index.mjs';
 import rules from '../../src/linter/rules/index.mjs';
-import { loadAndParse } from '../utils.mjs';
 import { getEnabledRules } from '../../src/linter/utils/rules.mjs';
+import { loadAndParse } from '../utils.mjs';
 
 const availableRules = Object.keys(rules);
 const availableReporters = Object.keys(reporters);

eslint.config.mjs

@@ -1,16 +1,50 @@
 import pluginJs from '@eslint/js';
-import eslintConfigPrettier from 'eslint-config-prettier';
+import importX from 'eslint-plugin-import-x';
 import jsdoc from 'eslint-plugin-jsdoc';
 import globals from 'globals';
 
 export default [
-  // @see https://eslint.org/docs/latest/use/configure/configuration-files#specifying-files-and-ignores
+  pluginJs.configs.recommended,
+  importX.flatConfigs.recommended,
+  {
+    ignores: ['out/', 'src/generators/api-links/test/fixtures/'],
+  },
+  {
+    files: ['**/*.mjs'],
+    rules: {
+      'import-x/namespace': 'off',
+      'import-x/no-named-as-default': 'off',
+      'import-x/no-named-as-default-member': 'off',
+      'import-x/no-unresolved': 'off',
+      'import-x/order': [
+        'error',
+        {
+          groups: [
+            'builtin',
+            'external',
+            'internal',
+            ['sibling', 'parent'],
+            'index',
+            'unknown',
+          ],
+          'newlines-between': 'always',
+          alphabetize: {
+            order: 'asc',
+            caseInsensitive: true,
+          },
+        },
+      ],
+    },
+  },
   {
     files: ['src/**/*.mjs', 'bin/**/*.mjs'],
     plugins: {
       jsdoc: jsdoc,
     },
-    languageOptions: { globals: globals.node },
+    languageOptions: {
+      ecmaVersion: 'latest',
+      globals: { ...globals.nodeBuiltin },
+    },
     rules: {
       'jsdoc/check-alignment': 'error',
       'jsdoc/check-indentation': 'error',
@@ -39,15 +73,8 @@ export default [
       'jsdoc/require-param': 'off',
     },
   },
-  // @see https://eslint.org/docs/latest/use/configure/configuration-files#specifying-files-and-ignores
   {
     files: ['src/generators/legacy-html/assets/*.js'],
     languageOptions: { globals: { ...globals.browser } },
   },
-  // @see https://eslint.org/docs/latest/rules to learn more about these rules
-  pluginJs.configs.recommended,
-  eslintConfigPrettier,
-  {
-    ignores: ['src/generators/api-links/test/fixtures/**'],
-  },
 ];