feat(toolchain/eslint-config): add more eslint-plugin-import rules (#19)

apps/sveltekit-example-app/vite.config.js

@@ -1,4 +1,5 @@
 import { sveltekit } from '@sveltejs/kit/vite'
+// eslint-disable-next-line import/no-extraneous-dependencies -- (as designed, vite is hoisted and available globally)
 import { defineConfig, mergeConfig } from 'vitest/config'
 
 import vitestSharedConfig from '@toolchain/vitest-config'

packages/example-pkg/vitest.config.js

@@ -1,3 +1,4 @@
+// eslint-disable-next-line import/no-extraneous-dependencies -- (as designed, vite is hoisted and available globally)
 import { defineConfig, mergeConfig } from 'vitest/config'
 
 import sharedConfig from '@toolchain/vitest-config'

toolchain/eslint-config/configs/js/import.js

@@ -34,6 +34,67 @@ export default defineFlatConfig({
      */
     'import/first': 'error',
 
+    /**
+     * Require a newline after the last import/require.
+     *
+     * 🔧 Fixable - https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/newline-after-import.md
+     */
+    'import/newline-after-import': 'error',
+
+    /**
+     * Disallow import of modules using absolute paths.
+     *
+     * 🚫 Not fixable - https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-absolute-path.md
+     */
+    'import/no-absolute-path': 'error',
+
+    /**
+     * Disallow cyclical dependencies between modules.
+     *
+     * 🚫 Not fixable - https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-cycle.md
+     */
+    'import/no-cycle': 'error',
+
+    /**
+     * Disallow the use of extraneous packages.
+     *
+     * 🚫 Not fixable - https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-extraneous-dependencies.md
+     */
+    'import/no-extraneous-dependencies': ['error', { includeTypes: true }],
+
+    /**
+     * Disallow mutable exports.
+     *
+     * 🚫 Not fixable - https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-mutable-exports.md
+     */
+    'import/no-mutable-exports': 'error',
+
+    /**
+     * Disallow importing packages through relative paths.
+     *
+     * 🚫 Not fixable - https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-relative-packages.md
+     */
+    'import/no-relative-packages': 'error',
+
+    /**
+     * Disallow a module from importing itself.
+     *
+     * 🚫 Not fixable - https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-self-import.md
+     */
+    'import/no-self-import': 'error',
+
+    /**
+     * Ensures that there are no useless path segments.
+     *
+     * 🚫 Not fixable - https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-useless-path-segments.md
+     */
+    'import/no-useless-path-segments': ['error'],
+
+    /**
+     * Enforce a module import order convention.
+     *
+     * 🔧 Fixable - https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/order.md
+     */
     'import/order': [
       'error',
       {

toolchain/eslint-config/configs/svelte.js

@@ -47,6 +47,14 @@ export default defineFlatConfig([
       ...plugin.configs.recommended.rules,
 
       'svelte/block-lang': ['error', { script: 'ts', style: ['postcss', 'css'] }],
+
+      /**
+       * Overrides rule defined in ./js/imports.js
+       *
+       * Svelte v4 requires mutable exports to work correctly for component props
+       * Revisit when upgrading to Svelte v5 and Runes
+       */
+      'import/no-mutable-exports': 'off',
     },
   },
   {

toolchain/eslint-config/eslint.config.js

@@ -1,2 +1,3 @@
 import config from './profile/node.js'
+
 export default config