@dword-design/eslint-plugin-import-alias 5.1.2 → 6.0.3

package/README.md

@@ -3,49 +3,49 @@
 <!-- /TITLE -->
 
 <!-- BADGES/ -->
-  <p>
-    <a href="https://npmjs.org/package/@dword-design/eslint-plugin-import-alias">
-      <img
-        src="https://img.shields.io/npm/v/@dword-design/eslint-plugin-import-alias.svg"
-        alt="npm version"
-      >
-    </a><img src="https://img.shields.io/badge/os-linux%20%7C%C2%A0macos%20%7C%C2%A0windows-blue" alt="Linux macOS Windows compatible"><a href="https://github.com/dword-design/eslint-plugin-import-alias/actions">
-      <img
-        src="https://github.com/dword-design/eslint-plugin-import-alias/workflows/build/badge.svg"
-        alt="Build status"
-      >
-    </a><a href="https://codecov.io/gh/dword-design/eslint-plugin-import-alias">
-      <img
-        src="https://codecov.io/gh/dword-design/eslint-plugin-import-alias/branch/master/graph/badge.svg"
-        alt="Coverage status"
-      >
-    </a><a href="https://david-dm.org/dword-design/eslint-plugin-import-alias">
-      <img src="https://img.shields.io/david/dword-design/eslint-plugin-import-alias" alt="Dependency status">
-    </a><img src="https://img.shields.io/badge/renovate-enabled-brightgreen" alt="Renovate enabled"><br/><a href="https://gitpod.io/#https://github.com/dword-design/eslint-plugin-import-alias">
-      <img
-        src="https://gitpod.io/button/open-in-gitpod.svg"
-        alt="Open in Gitpod"
-        width="114"
-      >
-    </a><a href="https://www.buymeacoffee.com/dword">
-      <img
-        src="https://www.buymeacoffee.com/assets/img/guidelines/download-assets-sm-2.svg"
-        alt="Buy Me a Coffee"
-        width="114"
-      >
-    </a><a href="https://paypal.me/SebastianLandwehr">
-      <img
-        src="https://sebastianlandwehr.com/images/paypal.svg"
-        alt="PayPal"
-        width="163"
-      >
-    </a><a href="https://www.patreon.com/dworddesign">
-      <img
-        src="https://sebastianlandwehr.com/images/patreon.svg"
-        alt="Patreon"
-        width="163"
-      >
-    </a>
+<p>
+  <a href="https://npmjs.org/package/@dword-design/eslint-plugin-import-alias">
+    <img
+      src="https://img.shields.io/npm/v/@dword-design/eslint-plugin-import-alias.svg"
+      alt="npm version"
+    >
+  </a><img src="https://img.shields.io/badge/os-linux%20%7C%C2%A0macos%20%7C%C2%A0windows-blue" alt="Linux macOS Windows compatible"><a href="https://github.com/dword-design/eslint-plugin-import-alias/actions">
+    <img
+      src="https://github.com/dword-design/eslint-plugin-import-alias/workflows/build/badge.svg"
+      alt="Build status"
+    >
+  </a><a href="https://codecov.io/gh/dword-design/eslint-plugin-import-alias">
+    <img
+      src="https://codecov.io/gh/dword-design/eslint-plugin-import-alias/branch/master/graph/badge.svg"
+      alt="Coverage status"
+    >
+  </a><a href="https://david-dm.org/dword-design/eslint-plugin-import-alias">
+    <img src="https://img.shields.io/david/dword-design/eslint-plugin-import-alias" alt="Dependency status">
+  </a><img src="https://img.shields.io/badge/renovate-enabled-brightgreen" alt="Renovate enabled"><br/><a href="https://gitpod.io/#https://github.com/dword-design/eslint-plugin-import-alias">
+    <img
+      src="https://gitpod.io/button/open-in-gitpod.svg"
+      alt="Open in Gitpod"
+      width="114"
+    >
+  </a><a href="https://www.buymeacoffee.com/dword">
+    <img
+      src="https://www.buymeacoffee.com/assets/img/guidelines/download-assets-sm-2.svg"
+      alt="Buy Me a Coffee"
+      width="114"
+    >
+  </a><a href="https://paypal.me/SebastianLandwehr">
+    <img
+      src="https://sebastianlandwehr.com/images/paypal.svg"
+      alt="PayPal"
+      width="163"
+    >
+  </a><a href="https://www.patreon.com/dworddesign">
+    <img
+      src="https://sebastianlandwehr.com/images/patreon.svg"
+      alt="Patreon"
+      width="163"
+    >
+  </a>
 </p>
 <!-- /BADGES -->
 
@@ -56,15 +56,15 @@ An ESLint plugin that enforces the use of import aliases. Also supports autofixi
 Aliases are a great thing to make imports more readable and you do not have to change import paths that often when a file path is changed.
 
 ```js
-import foo from '../../model/sub/foo'
-import bar from '../other/bar'
+import foo from '../../model/sub/foo';
+import bar from '../other/bar';
 ```
 
 changes to
 
 ```js
-import foo from '@/model/sub/foo'
-import bar from '@/sub/other/bar'
+import foo from '@/model/sub/foo';
+import bar from '@/sub/other/bar';
 ```
 
 Now what if you are in a bigger team or you have a lot of projects to update. Or you just want to make sure that everything is consistent. This is where a linter comes into the play. This rule allows you to detect inconsistent imports and even autofix them. This works by matching alias paths agains the imports and replacing the import paths with the first matching aliased path.
@@ -85,12 +85,13 @@ $ yarn add @dword-design/eslint-plugin-import-alias
 
 Add the plugin to your ESLint config:
 
-```json
-{
-  "extends": [
-    "plugin:@dword-design/import-alias/recommended"
-  ],
-}
+```js
+import { defineConfig } from 'eslint/config';
+import importAlias from '@dword-design/import-alias';
+
+export default defineConfig([
+  importAlias.configs.recommended,
+]);
 ```
 
 Alright, now you have to tell the plugin which aliases to use. In the simplest case, you are already using [babel-plugin-module-resolver](https://www.npmjs.com/package/babel-plugin-module-resolver) for your aliases. Your babel config would look something like this:

package/dist/index.js

@@ -1,14 +1,10 @@
-import preferAlias from "./rules/prefer-alias.js";
+import preferAlias from './rules/prefer-alias.js';
+const plugin = { rules: { 'prefer-alias': preferAlias } };
 export default {
-  configs: {
-    recommended: {
-      plugins: ['@dword-design/import-alias'],
-      rules: {
-        '@dword-design/import-alias/prefer-alias': 'error'
-      }
-    }
-  },
-  rules: {
-    'prefer-alias': preferAlias
-  }
-};
+    configs: {
+        recommended: {
+            plugins: { '@dword-design/import-alias': plugin },
+            rules: { '@dword-design/import-alias/prefer-alias': 'error' },
+        },
+    },
+};

package/dist/rules/prefer-alias.js

@@ -1,96 +1,87 @@
-import { OptionManager } from '@babel/core';
-import { find, keys, replace, some, startsWith } from '@dword-design/functions';
+import pathLib from 'node:path';
+import { loadOptions } from '@babel/core';
+import defu from '@dword-design/defu';
 import { resolvePath as defaultResolvePath } from 'babel-plugin-module-resolver';
-import deepmerge from 'deepmerge';
-import P from 'path';
 const isParentImport = path => /^(\.\/)?\.\.\//.test(path);
 const findMatchingAlias = (sourcePath, currentFile, options) => {
-  const resolvePath = options.resolvePath || defaultResolvePath;
-  const absoluteSourcePath = P.resolve(P.dirname(currentFile), sourcePath);
-  for (const aliasName of (_options$alias = options.alias, keys(_options$alias))) {
-    var _options$alias, _absoluteSourcePath;
-    const path = P.resolve(P.dirname(currentFile), resolvePath(`${aliasName}/`, currentFile, options));
-    if (_absoluteSourcePath = absoluteSourcePath, startsWith(path)(_absoluteSourcePath)) {
-      return {
-        name: aliasName,
-        path
-      };
+    const resolvePath = options.resolvePath || defaultResolvePath;
+    const absoluteSourcePath = pathLib.resolve(pathLib.dirname(currentFile), sourcePath);
+    for (const aliasName of Object.keys(options.alias)) {
+        const path = pathLib.resolve(pathLib.dirname(currentFile), resolvePath(`${aliasName}/`, currentFile, options));
+        if (absoluteSourcePath.startsWith(path)) {
+            return { name: aliasName, path };
+        }
     }
-  }
-  return undefined;
 };
 export default {
-  create: context => {
-    var _babelConfig$plugins;
-    const currentFile = context.getFilename();
-    const folder = P.dirname(currentFile);
-    // can't check a non-file
-    if (currentFile === '<text>') return {};
-    const manager = new OptionManager();
-    const babelConfig = manager.init({
-      filename: currentFile
-    });
-    const plugin = (_babelConfig$plugins = babelConfig.plugins, find({
-      key: 'module-resolver'
-    })(_babelConfig$plugins));
-    const options = deepmerge.all([{
-      alias: []
-    }, plugin?.options || {}, context.options[0] || {}]);
-    if (options.alias.length === 0) {
-      throw new Error('No alias configured. You have to define aliases by either passing them to the babel-plugin-module-resolver plugin in your Babel config, or directly to the prefer-alias rule.');
-    }
-    const resolvePath = options.resolvePath || defaultResolvePath;
-    return {
-      ImportDeclaration: node => {
-        var _ref, _options$alias2, _sourcePath2, _importWithoutAlias;
-        const sourcePath = node.source.value;
-        const hasAlias = (_ref = (_options$alias2 = options.alias, keys(_options$alias2)), some(alias => {
-          var _sourcePath;
-          return _sourcePath = sourcePath, startsWith(`${alias}/`)(_sourcePath);
-        })(_ref));
-
-        // relative parent
-        if (_sourcePath2 = sourcePath, isParentImport(_sourcePath2)) {
-          var _P$relative;
-          const matchingAlias = findMatchingAlias(sourcePath, currentFile, options);
-          if (!matchingAlias) {
-            return undefined;
-          }
-          const absoluteImportPath = P.resolve(folder, sourcePath);
-          const rewrittenImport = `${matchingAlias.name}/${_P$relative = P.relative(matchingAlias.path, absoluteImportPath), replace(/\\/g, '/')(_P$relative)}`;
-          return context.report({
-            fix: fixer => fixer.replaceTextRange([node.source.range[0] + 1, node.source.range[1] - 1], rewrittenImport),
-            message: `Unexpected parent import '${sourcePath}'. Use '${rewrittenImport}' instead`,
-            node
-          });
+    create: context => {
+        const currentFile = context.getFilename();
+        const folder = pathLib.dirname(currentFile);
+        // can't check a non-file
+        if (currentFile === '<text>')
+            return {};
+        const optionsFromRule = context.options[0] ?? {};
+        const babelConfig = (loadOptions({
+            filename: currentFile,
+            ...optionsFromRule.babelOptions,
+        }) || {});
+        const optionsFromPlugin = babelConfig?.plugins?.find(_ => _.key === 'module-resolver')?.options ??
+            {};
+        const options = defu(optionsFromRule, optionsFromPlugin, {
+            alias: [],
+            cwd: context.cwd,
+        });
+        if (options.alias.length === 0) {
+            throw new Error('No alias configured. You have to define aliases by either passing them to the babel-plugin-module-resolver plugin in your Babel config, or directly to the prefer-alias rule.');
         }
-        const importWithoutAlias = resolvePath(sourcePath, currentFile, options);
-        if (!(_importWithoutAlias = importWithoutAlias, isParentImport(_importWithoutAlias)) && hasAlias && !options.allowSubpathWithAlias) {
-          return context.report({
-            fix: fixer => fixer.replaceTextRange([node.source.range[0] + 1, node.source.range[1] - 1], importWithoutAlias),
-            message: `Unexpected subpath import via alias '${sourcePath}'. Use '${importWithoutAlias}' instead`,
-            node
-          });
-        }
-        return undefined;
-      }
-    };
-  },
-  meta: {
-    fixable: true,
-    schema: [{
-      additionalProperties: false,
-      properties: {
-        alias: {
-          type: 'object'
-        },
-        aliasForSubpaths: {
-          default: false,
-          type: 'boolean'
-        }
-      },
-      type: 'object'
-    }],
-    type: 'suggestion'
-  }
-};
+        const resolvePath = options.resolvePath || defaultResolvePath;
+        return {
+            ImportDeclaration: node => {
+                const sourcePath = node.source.value;
+                const hasAlias = Object.keys(options.alias).some(alias => sourcePath.startsWith(`${alias}/`));
+                // relative parent
+                if (isParentImport(sourcePath)) {
+                    const matchingAlias = findMatchingAlias(sourcePath, currentFile, options);
+                    if (!matchingAlias) {
+                        return;
+                    }
+                    const absoluteImportPath = pathLib.resolve(folder, sourcePath);
+                    const rewrittenImport = `${matchingAlias.name}/${pathLib
+                        .relative(matchingAlias.path, absoluteImportPath)
+                        .replaceAll('\\', '/')}`;
+                    return context.report({
+                        fix: fixer => fixer.replaceTextRange([node.source.range[0] + 1, node.source.range[1] - 1], rewrittenImport),
+                        message: `Unexpected parent import '${sourcePath}'. Use '${rewrittenImport}' instead`,
+                        node,
+                    });
+                }
+                const importWithoutAlias = resolvePath(sourcePath, currentFile, options);
+                if (!isParentImport(importWithoutAlias) &&
+                    hasAlias &&
+                    !options.aliasForSubpaths) {
+                    return context.report({
+                        fix: fixer => fixer.replaceTextRange([node.source.range[0] + 1, node.source.range[1] - 1], importWithoutAlias),
+                        message: `Unexpected subpath import via alias '${sourcePath}'. Use '${importWithoutAlias}' instead`,
+                        node,
+                    });
+                }
+                return;
+            },
+        };
+    },
+    meta: {
+        fixable: true,
+        schema: [
+            {
+                additionalProperties: false,
+                properties: {
+                    alias: { type: 'object' },
+                    aliasForSubpaths: { default: false, type: 'boolean' },
+                    babelOptions: { type: 'object' },
+                },
+                type: 'object',
+            },
+        ],
+        type: 'suggestion',
+    },
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dword-design/eslint-plugin-import-alias",
-  "version": "5.1.2",
+  "version": "6.0.3",
   "description": "An ESLint plugin that enforces the use of import aliases. Also supports autofixing.",
   "keywords": [
     "alias",
@@ -28,7 +28,8 @@
   "license": "MIT",
   "author": "Sebastian Landwehr <info@sebastianlandwehr.com>",
   "type": "module",
-  "main": "dist/cjs-fallback.cjs",
+  "exports": "./dist/index.js",
+  "main": "dist/index.js",
   "files": [
     "dist"
   ],
@@ -43,23 +44,21 @@
     "test": "base test"
   },
   "dependencies": {
-    "@babel/core": "^7.10.2",
-    "@dword-design/functions": "^6.0.0",
-    "babel-plugin-module-resolver": "^5.0.0",
-    "deepmerge": "^4.3.1",
-    "jiti": "^1.18.2"
+    "@babel/core": "^7.27.4",
+    "@dword-design/defu": "^1.0.0",
+    "babel-plugin-module-resolver": "^5.0.2"
   },
   "devDependencies": {
-    "@dword-design/base": "^11.0.7",
-    "@dword-design/tester": "^2.0.19",
-    "@dword-design/tester-plugin-tmp-dir": "^2.1.26",
+    "@dword-design/base": "^13.0.1",
+    "@playwright/test": "^1.52.0",
     "depcheck-package-name": "^3.0.1",
-    "eslint": "^8.0.0",
-    "execa": "^9.3.1",
-    "fs-extra": "^11.1.1",
-    "output-files": "^2.0.0"
+    "endent": "npm:@dword-design/endent@^1.4.1",
+    "eslint": "^9.28.0",
+    "lodash-es": "^4.17.21",
+    "output-files": "^2.0.32",
+    "typescript-eslint": "^8.33.1"
   },
-  "packageManager": "pnpm@9.7.1+sha512.faf344af2d6ca65c4c5c8c2224ea77a81a5e8859cbc4e06b1511ddce2f0151512431dd19e6aff31f2c6a8f5f2aced9bd2273e1fed7dd4de1868984059d2c4247",
+  "packageManager": "pnpm@10.11.1+sha512.e519b9f7639869dc8d5c3c5dfef73b3f091094b0a006d7317353c72b124e80e1afd429732e28705ad6bfa1ee879c1fce46c128ccebd3192101f43dd67c667912",
   "engines": {
     "node": ">=18"
   },

package/dist/cjs-fallback.cjs

@@ -1,4 +0,0 @@
-const jiti = require('jiti')(__filename, { interopDefault: true })
-const api = jiti('.')
-
-module.exports = api