feat: allow to alias also subpaths

Author: dword-design

README.md

@@ -125,6 +125,14 @@ If you have a special project setup that does not have a babel config in the pro
 }
 ```
 
+By default, the plugin will convert parent paths to aliases (like `../model/foo`), but will keep subpath imports relative. You can change that to also convert subpaths to aliased imports by passing the `aliasForSubpaths` option to the rule like so:
+
+```json
+"rules": {
+  "@dword-design/import-alias/prefer-alias": ["error", { "aliasForSubpaths": true }]
+}
+```
+
 <!-- LICENSE/ -->
 ## Contribute
 

src/rules/prefer-alias.js

@@ -97,7 +97,11 @@ export default {
           options,
         );
 
-        if (!(importWithoutAlias |> isParentImport) && hasAlias) {
+        if (
+          !(importWithoutAlias |> isParentImport) &&
+          hasAlias &&
+          !options.allowSubpathWithAlias
+        ) {
           return context.report({
             fix: fixer =>
               fixer.replaceTextRange(
@@ -118,7 +122,10 @@ export default {
     schema: [
       {
         additionalProperties: false,
-        properties: { alias: { type: 'object' } },
+        properties: {
+          alias: { type: 'object' },
+          aliasForSubpaths: { default: false, type: 'boolean' },
+        },
         type: 'object',
       },
     ],

src/rules/prefer-alias.spec.js

@@ -74,6 +74,23 @@ export default tester(
         output: "import foo from './foo'",
       });
     },
+    aliasForSubpaths: async () => {
+      await outputFiles({
+        '.babelrc.json': JSON.stringify({
+          plugins: [
+            [
+              packageName`babel-plugin-module-resolver`,
+              { alias: { '@': '.' }, aliasForSubpaths: false },
+            ],
+          ],
+        }),
+        'foo.js': '',
+      });
+
+      expect(
+        lint("import foo from '@/foo'", { filename: 'sub/index.js' }).messages,
+      ).toEqual([]);
+    },
     'custom alias': async () => {
       await outputFiles({ 'foo.js': '', 'package.json': JSON.stringify({}) });