feature: @putout/plugin-esm: add resolve-imported-file

coderaiser · coderaiser · commit c5da21dde151 · 2025-04-09T23:57:04.000+03:00
diff --git a/packages/plugin-esm/README.md b/packages/plugin-esm/README.md
@@ -27,6 +27,7 @@ npm i putout @putout/plugin-esm -D
 - ✅ [remove-empty-import](#remove-empty-import);
 - ✅ [remove-empty-export](#remove-empty-export);
 - ✅ [sort-imports-by-specifiers](#sort-imports-by-specifiers);
+- ✅ [resolve-imported-file](#resolve-imported-file);
 
 ## Config
 
@@ -43,7 +44,8 @@ npm i putout @putout/plugin-esm -D
         "esm/remove-empty-import": ["on", {
             "ignore": []
         }],
-        "esm/sort-imports-by-specifiers": "on"
+        "esm/sort-imports-by-specifiers": "on",
+        "esm/resolve-imported-file": "on"
     }
 }
 ```
@@ -304,6 +306,37 @@ import('foo.json', {
 });
 ```
 
+### resolve-imported-file
+
+Check out in 🐊**Putout Editor**:
+
+- ✅ [`resolve-imported-file`](https://putout.cloudcmd.io/#/gist/241489cb2781dd37ec96baf0115cde4e/83c2f2e9f490850b7fda432f8d25ae6a64ed07e3);
+- ✅ [`get-imports`](https://putout.cloudcmd.io/#/gist/ee10100fed86e4db926885dd54298668/7538bca7a9ae006d976f41261c0ed4c0e1902ace);
+- ✅ [`change-imports`](https://putout.cloudcmd.io/#/gist/23a6dc6741b772c03fbed95feda2b451/1fbecac6fc40282bcda0593aa666a8c213ef85b7);
+
+Let's consider file structure:
+
+```
+/
+|-- lib/
+|  `-- index.js
+|  `-- a.js
+```
+
+In this case `index.js` can be fixed:
+
+#### ❌ Example of incorrect code
+
+```js
+import a from './a';
+```
+
+#### ✅ Example of correct code
+
+```js
+import a from './a.js';
+```
+
 ## License
 
 MIT
diff --git a/packages/plugin-esm/eslint.config.js b/packages/plugin-esm/eslint.config.js
@@ -6,6 +6,7 @@ export const match = {
     '*.md{js}': {
         'n/no-deprecated-api': 'off',
         'n/no-unsupported-features/node-builtins': 'off',
+        'putout/no-unresolved': 'off',
     },
 };
 
diff --git a/packages/plugin-esm/lib/index.js b/packages/plugin-esm/lib/index.js
@@ -1,3 +1,4 @@
+import * as resolveImportedFile from './resolve-imported-file/index.js';
 import * as addIndexToImport from './add-index-to-import/index.js';
 import * as declareImportsFirst from './declare-imports-first/index.js';
 import * as groupImportsBySource from './group-imports-by-source/index.js';
@@ -10,7 +11,7 @@ import * as convertAssertToWith from './convert-assert-to-with/index.js';
 import * as applyExportFrom from './apply-export-from/index.js';
 
 export const rules = {
-    'add-index-to-import': addIndexToImport,
+    'add-index-to-import': ['off', addIndexToImport],
     'apply-export-from': applyExportFrom,
     'convert-assert-to-with': convertAssertToWith,
     'declare-imports-first': declareImportsFirst,
@@ -20,4 +21,5 @@ export const rules = {
     'remove-empty-import': removeEmptyImport,
     'remove-empty-export': removeEmptyExport,
     'sort-imports-by-specifiers': sortImportsBySpecifiers,
+    'resolve-imported-file': ['off', resolveImportedFile],
 };
diff --git a/packages/plugin-esm/lib/resolve-imported-file/change-imports/fixture/change-imports-fix.js b/packages/plugin-esm/lib/resolve-imported-file/change-imports/fixture/change-imports-fix.js
@@ -0,0 +1 @@
+import a from './a.js';
diff --git a/packages/plugin-esm/lib/resolve-imported-file/change-imports/fixture/change-imports.js b/packages/plugin-esm/lib/resolve-imported-file/change-imports/fixture/change-imports.js
@@ -0,0 +1 @@
+import a from './a';
diff --git a/packages/plugin-esm/lib/resolve-imported-file/change-imports/index.js b/packages/plugin-esm/lib/resolve-imported-file/change-imports/index.js
@@ -0,0 +1,11 @@
+export const report = () => '';
+export const replace = ({options}) => {
+    const {from = '', to = ''} = options;
+    
+    if (!from || !to)
+        return {};
+    
+    return {
+        [`import __imports from '${from}'`]: `import __imports from '${to}'`,
+    };
+};
diff --git a/packages/plugin-esm/lib/resolve-imported-file/change-imports/index.spec.js b/packages/plugin-esm/lib/resolve-imported-file/change-imports/index.spec.js
@@ -0,0 +1,29 @@
+import {createTest} from '@putout/test';
+import * as plugin from './index.js';
+
+const test = createTest(import.meta.url, {
+    plugins: [
+        ['change-imports', plugin],
+    ],
+});
+
+test('putout: esm: resolve-imported-file: no report: change-imports', (t) => {
+    t.noReport('change-imports');
+    t.end();
+});
+
+test('putout: esm: resolve-imported-file: report: change-imports', (t) => {
+    t.reportWithOptions('change-imports', ``, {
+        from: './a',
+        to: './a.js',
+    });
+    t.end();
+});
+
+test('putout: esm: resolve-imported-file: transform: change-imports', (t) => {
+    t.transformWithOptions('change-imports', {
+        from: './a',
+        to: './a.js',
+    });
+    t.end();
+});
diff --git a/packages/plugin-esm/lib/resolve-imported-file/fixture/no-package.js b/packages/plugin-esm/lib/resolve-imported-file/fixture/no-package.js
@@ -0,0 +1,7 @@
+__putout_processor_filesystem([
+    '/',
+    '/lib/',
+    ['/lib/index.js', `
+        import dotdot from '..';
+    `],
+]);
diff --git a/packages/plugin-esm/lib/resolve-imported-file/fixture/resolve-imported-file-fix.js b/packages/plugin-esm/lib/resolve-imported-file/fixture/resolve-imported-file-fix.js
@@ -0,0 +1,9 @@
+__putout_processor_filesystem([
+    "/",
+    "/lib/",
+    ["/lib/index.js", "aW1wb3J0IGEgZnJvbSAnLi9hLmpzJzsKaW1wb3J0IGIgZnJvbSAnLi9iL2luZGV4LmpzJzsKaW1wb3J0IGUgZnJvbSAnLi4vZSc7CmltcG9ydCBmcyBmcm9tICdmcyc7CmltcG9ydCBjIGZyb20gJy4vYy5qcyc7CmltcG9ydCBkIGZyb20gJy4vZC5tanMnOwppbXBvcnQgY2pzIGZyb20gJy4vZS5janMnOwppbXBvcnQgZG90ZG90IGZyb20gJy4uL2xpYi9pbmRleC5qcyc7Cg=="],
+    ["/lib/a.js", "ZXhwb3J0IGRlZmF1bHQgNVxcbg=="],
+    "/lib/b/",
+    ["/lib/b/index.js", "export default 7\n"],
+    ["/package.json", "{"main": "lib/index.js"}"]
+]);
diff --git a/packages/plugin-esm/lib/resolve-imported-file/fixture/resolve-imported-file.js b/packages/plugin-esm/lib/resolve-imported-file/fixture/resolve-imported-file.js
@@ -0,0 +1,18 @@
+__putout_processor_filesystem([
+    '/',
+    '/lib/',
+    ['/lib/index.js', `
+        import a from "./a";
+        import b from "./b";
+        import e from "../e";
+        import fs from "fs";
+        import c from "./c.js";
+        import d from "./d.mjs";
+        import cjs from "./e.cjs";
+        import dotdot from '..';
+    `],
+    ['/lib/a.js', `export default 5\\n`],
+    '/lib/b/',
+    ['/lib/b/index.js', 'export default 7\\n'],
+    ['/package.json', '{"main": "lib/index.js"}'],
+]);
diff --git a/packages/plugin-esm/lib/resolve-imported-file/get-imports-source/fixture/get-imports.js b/packages/plugin-esm/lib/resolve-imported-file/get-imports-source/fixture/get-imports.js
@@ -0,0 +1 @@
+import a from './a';
diff --git a/packages/plugin-esm/lib/resolve-imported-file/get-imports-source/index.js b/packages/plugin-esm/lib/resolve-imported-file/get-imports-source/index.js
@@ -0,0 +1,16 @@
+export const report = (path) => path.node.source.value;
+
+export const fix = () => {};
+
+export const include = () => [
+    'ImportDeclaration',
+];
+
+export const filter = (path) => {
+    const {value} = path.node.source;
+    
+    if (!value.startsWith('.'))
+        return false;
+    
+    return !/\.[m|c]?js/.test(value);
+};
diff --git a/packages/plugin-esm/lib/resolve-imported-file/get-imports-source/index.spec.js b/packages/plugin-esm/lib/resolve-imported-file/get-imports-source/index.spec.js
@@ -0,0 +1,28 @@
+import {createTest} from '@putout/test';
+import * as plugin from './index.js';
+
+const test = createTest(import.meta.url, {
+    plugins: [
+        ['get-imports-source', plugin],
+    ],
+});
+
+test('putout: esm: resolve-imported-file: report: get-imports', (t) => {
+    t.report('get-imports', `./a`);
+    t.end();
+});
+
+test('putout: esm: resolve-imported-file: no report: external', (t) => {
+    t.noReportCode(`import a from 'a'`);
+    t.end();
+});
+
+test('putout: esm: resolve-imported-file: no report: js', (t) => {
+    t.noReportCode(`import a from './a.js'`);
+    t.end();
+});
+
+test('putout: esm: resolve-imported-file: no transform: get-imports', (t) => {
+    t.noTransform('get-imports');
+    t.end();
+});
diff --git a/packages/plugin-esm/lib/resolve-imported-file/index.js b/packages/plugin-esm/lib/resolve-imported-file/index.js
@@ -0,0 +1,121 @@
+import {join, dirname} from 'node:path';
+import {
+    parse,
+    print,
+    transform,
+    operator,
+} from 'putout';
+import * as getImportsSource from './get-imports-source/index.js';
+import * as changeImports from './change-imports/index.js';
+
+const {
+    findFile,
+    getFilename,
+    readFileContent,
+    writeFileContent,
+} = operator;
+
+const getMessage = (a) => a.message;
+
+export const report = (file, {from, to}) => `Resolve import source: '${from}' -> '${to}'`;
+export const fix = (file, {content, ast, from, to}) => {
+    transform(ast, content, {
+        rules: {
+            'change-imports': ['on', {
+                from,
+                to,
+            }],
+        },
+        plugins: [
+            ['change-imports', changeImports],
+        ],
+    });
+    
+    const newContent = print(ast);
+    
+    writeFileContent(file, newContent);
+};
+
+export const scan = (rootPath, {push, trackFile}) => {
+    const mask = [
+        '*.js',
+        '*.mjs',
+    ];
+    
+    for (const file of trackFile(rootPath, mask)) {
+        const content = readFileContent(file);
+        
+        if (!content.includes('import'))
+            continue;
+        
+        const ast = parse(content);
+        
+        const places = transform(ast, content, {
+            plugins: [
+                ['get-imports-source', getImportsSource],
+            ],
+        });
+        
+        const imports = places.map(getMessage);
+        const filename = getFilename(file);
+        const dir = dirname(filename);
+        const importsTuples = buildImports(dir, imports);
+        const resolvedTuples = buildResolved(rootPath, importsTuples);
+        
+        for (const [from, to] of resolvedTuples) {
+            push(file, {
+                from,
+                to,
+                content,
+                ast,
+            });
+        }
+    }
+};
+
+function buildImports(dir, imports) {
+    const list = [];
+    
+    for (const current of imports) {
+        const full = join(dir, current);
+        list.push([current, full]);
+    }
+    
+    return list;
+}
+
+function buildResolved(rootPath, importsTuples) {
+    const result = [];
+    
+    for (const [relative, current] of importsTuples) {
+        const withIndex = join(current, 'index.js');
+        const withJs = `${current}.js`;
+        
+        if (findFile(rootPath, withIndex).length) {
+            result.push([relative, `${relative}/index.js`]);
+            continue;
+        }
+        
+        if (relative === '..') {
+            const withPackage = join(current, 'package.json');
+            const [packageJson] = findFile(rootPath, withPackage);
+            
+            if (!packageJson)
+                continue;
+            
+            const json = readFileContent(packageJson);
+            const {main} = JSON.parse(json);
+            
+            result.push([relative, join(relative, main)]);
+            
+            continue;
+        }
+        
+        if (findFile(rootPath, withJs).length) {
+            result.push([relative, `${relative}.js`]);
+            continue;
+        }
+    }
+    
+    return result;
+}
diff --git a/packages/plugin-esm/lib/resolve-imported-file/index.spec.js b/packages/plugin-esm/lib/resolve-imported-file/index.spec.js
@@ -0,0 +1,23 @@
+import {createTest} from '@putout/test';
+import * as plugin from './index.js';
+
+const test = createTest(import.meta.url, {
+    plugins: [
+        ['resolve-imported-file', plugin],
+    ],
+});
+
+test('esm: resolve-imported-file: report', (t) => {
+    t.report('resolve-imported-file', `Resolve import source: './a' -> './a.js'`);
+    t.end();
+});
+
+test('esm: resolve-imported-file: transform', (t) => {
+    t.transform('resolve-imported-file');
+    t.end();
+});
+
+test('esm: resolve-imported-file: no report: no-package', (t) => {
+    t.noReport('no-package');
+    t.end();
+});
diff --git a/packages/plugin-esm/test/add-index-to-import.js b/packages/plugin-esm/test/add-index-to-import.js
@@ -0,0 +1,16 @@
+import {createTest} from '@putout/test';
+import * as esm from '../lib/index.js';
+
+const test = createTest(import.meta.url, {
+    rules: {
+        'esm/add-index-to-import': 'on',
+    },
+    plugins: [
+        ['esm', esm],
+    ],
+});
+
+test('plugin-esm: transform: add-index-to-import-on', (t) => {
+    t.transform('add-index-to-import-on');
+    t.end();
+});
diff --git a/packages/plugin-esm/test/esm.js b/packages/plugin-esm/test/esm.js
@@ -56,3 +56,8 @@ test('plugin-esm: transform: apply-export-from', (t) => {
     t.transform('apply-export-from');
     t.end();
 });
+
+test('plugin-esm: no report: resolve-imported-file', (t) => {
+    t.noReport('resolve-imported-file');
+    t.end();
+});
diff --git a/packages/plugin-esm/test/fixture/add-index-to-import-fix.js b/packages/plugin-esm/test/fixture/add-index-to-import-fix.js
@@ -1,4 +1,4 @@
-import insertRust from './insert-rust/index.js';
+import insertRust from './insert-rust';
 import addAction from './add-action.js';
 
 export const rules = {};
diff --git a/packages/plugin-esm/test/fixture/add-index-to-import-on-fix.js b/packages/plugin-esm/test/fixture/add-index-to-import-on-fix.js
@@ -0,0 +1,4 @@
+import insertRust from './insert-rust/index.js';
+import addAction from './add-action.js';
+
+export const rules = {};
diff --git a/packages/plugin-esm/test/fixture/add-index-to-import-on.js b/packages/plugin-esm/test/fixture/add-index-to-import-on.js
diff --git a/packages/plugin-esm/test/fixture/add-indext-to-import-on.js b/packages/plugin-esm/test/fixture/add-indext-to-import-on.js
diff --git a/packages/plugin-esm/test/fixture/group-imports-by-source-fix.js b/packages/plugin-esm/test/fixture/group-imports-by-source-fix.js
diff --git a/packages/plugin-esm/test/fixture/resolve-imported-file-on-fix.js b/packages/plugin-esm/test/fixture/resolve-imported-file-on-fix.js
diff --git a/packages/plugin-esm/test/fixture/resolve-imported-file-on.js b/packages/plugin-esm/test/fixture/resolve-imported-file-on.js
diff --git a/packages/plugin-esm/test/fixture/resolve-imported-file.js b/packages/plugin-esm/test/fixture/resolve-imported-file.js
diff --git a/packages/plugin-esm/test/resolve-imported-file.js b/packages/plugin-esm/test/resolve-imported-file.js
diff --git a/packages/putout/putout.json b/packages/putout/putout.json
diff --git a/packages/putout/test/config.js b/packages/putout/test/config.js
