@putout/plugin-esm 3.0.0 → 4.1.0

package/README.md

@@ -18,6 +18,7 @@ npm i putout @putout/plugin-esm -D
 
 ## Rules
 
+- ✅ [add-index-to-import](#add-index-to-import);
 - ✅ [apply-export-from](#apply-export-from);
 - ✅ [declare-imports-first](#declare-imports-first);
 - ✅ [group-imports-by-source](#group-imports-by-source);
@@ -26,12 +27,14 @@ 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
 
 ```json
 {
     "rules": {
+        "esm/add-index-to-import": "on",
         "esm/apply-export-from": "on",
         "esm/declare-imports-first": "on",
         "esm/group-imports-by-source": "on",
@@ -41,20 +44,46 @@ 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"
     }
 }
 ```
 
-## apply-export-from
+## Rules
+
+### add-index-to-import
+
+ESM doesn't add `index.js`, so it can be left after [`@putout/plugin-convert-esm-to-commonjs`](https://github.com/coderaiser/putout/blob/master/packages/plugin-convert-esm-to-commonjs#readme).
+Checkout in 🐊[**Putout Editor**](https://putout.cloudcmd.io/#/gist/b7c489710767efee95ecf3dd16e232a2/9f974f0a345ef4d0cb39b011097dff82e6c32b75).
+
+#### ❌ Example of incorrect code
+
+```js
+import insertRust from './insert-rust.js';
+import addAction from './add-action.js';
+
+export const rules = {};
+```
+
+#### ✅ Example of correct code
+
+```js
+import insertRust from './insert-rust/index.js';
+import addAction from './add-action/index.js';
+
+export const rules = {};
+```
+
+### apply-export-from
 
 > The `export` declaration is used to export values from a JavaScript module.
 >
 > (c) [MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/export)
 
-Check out in 🐊[**Putout Editor**](https://putout.cloudcmd.io/#/gist/c9a3983d269745da89c1c7560f3b7fac/3ecb9aa6b910ce3816605bae11c8dd86bdc457e5).
+Check out in 🐊[**Putout Editor**](https://putout.cloudcmd.io/##/gist/c9a3983d269745da89c1c7560f3b7fac/3ecb9aa6b910ce3816605bae11c8dd86bdc457e5).
 
-## ❌ Example of incorrect code
+#### ❌ Example of incorrect code
 
 ```js
 import * as ns_1 from 'x';
@@ -64,24 +93,24 @@ export {
 };
 ```
 
-## ✅ Example of correct code
+#### ✅ Example of correct code
 
 ```js
 export * as ns from 'x';
 ```
 
-## declare-imports-first
+### declare-imports-first
 
 Check out in 🐊[**Putout Editor**](https://putout.cloudcmd.io/#/gist/b1c18e5d726afe4ebb69d6b7a7dda82b/8189590815a1b8adb35bb8a846e28228e3c7fadf). For **CommonJS** use [nodejs/declare-after-require](https://github.com/coderaiser/putout/tree/master/packages/plugin-nodejs#declare-after-require).
 
-## ❌ Example of incorrect code
+#### ❌ Example of incorrect code
 
 ```js
 const [arg] = process.argv;
 import esbuild from 'esbuild';
 ```
 
-## ✅ Example of correct code
+#### ✅ Example of correct code
 
 ```js
 import esbuild from 'esbuild';
@@ -89,7 +118,7 @@ import esbuild from 'esbuild';
 const [arg] = process.argv;
 ```
 
-## group-imports-by-source
+### group-imports-by-source
 
 Group order:
 
@@ -100,7 +129,7 @@ Group order:
 
 Checkout in 🐊[**Putout Editor**](https://putout.cloudcmd.io/#/gist/3cc782acf95211f9d456d63a99032ee1/0674223d050bba572f5271ffdccf8616cb441af5).
 
-## ❌ Example of incorrect code
+#### ❌ Example of incorrect code
 
 ```js
 import fs from 'node:fs';
@@ -114,7 +143,7 @@ import parse from '#parser';
 const c = 5;
 ```
 
-## ✅ Example of correct code
+#### ✅ Example of correct code
 
 ```js
 import fs from 'node:fs';
@@ -128,9 +157,9 @@ import ss from '../../bb/ss.js';
 const c = 5;
 ```
 
-## merge-duplicate-imports
+### merge-duplicate-imports
 
-### join
+#### join
 
 To disable use:
 
@@ -142,20 +171,20 @@ To disable use:
 }
 ```
 
-#### ❌ Example of incorrect code
+##### ❌ Example of incorrect code
 
 ```js
 import test from 'supertape';
 import {stub} from 'supertape';
 ```
 
-#### ✅ Example of correct code
+##### ✅ Example of correct code
 
 ```js
 import test, {stub} from 'supertape';
 ```
 
-### rename
+#### rename
 
 Checkout in 🐊[**Putout Editor**](https://putout.cloudcmd.io/#/gist/6604936dec6b1eed8ce0d143f2962f15/17b310a6e4d85b0b8615a8b91d0e27414e8af291).
 
@@ -169,7 +198,7 @@ To disable use:
 }
 ```
 
-#### ❌ Example of incorrect code
+##### ❌ Example of incorrect code
 
 ```js
 import putout from './putout.js';
@@ -180,7 +209,7 @@ console.log(all);
 console.log(x);
 ```
 
-#### ✅ Example of correct code
+##### ✅ Example of correct code
 
 ```js
 import putout from './putout.js';
@@ -189,39 +218,39 @@ console.log(putout);
 console.log(putout);
 ```
 
-## remove-empty-export
+### remove-empty-export
 
 ```diff
 -export {};
 ```
 
-## remove-empty-import
+### remove-empty-import
 
 ```diff
 -import 'abc';
 ```
 
-## remove-quotes-from-import-assertions
+### remove-quotes-from-import-assertions
 
 Checkout in 🐊[**Putout Editor**](https://putout.cloudcmd.io/#/gist/f9f34acddbefba0ded53225ca10fa44e/7b4dba44602b9b2d28fe3a98989474a4b0d8d73d).
 
-### ❌ Example of incorrect code
+#### ❌ Example of incorrect code
 
 ```js
 import json from './mod.json' with { type: 'json' };
 ```
 
-## ✅ Example of correct code
+#### ✅ Example of correct code
 
 ```js
 import json from './mod.json' with { type: 'json' };
 ```
 
-## sort-imports-by-specifiers
+### sort-imports-by-specifiers
 
 Checkout in 🐊[**Putout Editor**](https://putout.cloudcmd.io/#/gist/521e2ff199243a7ce1f65db7140c272e/28c0588281286f8a6765b8aa2ecabbfcde2973a7).
 
-### ❌ Example of incorrect code
+#### ❌ Example of incorrect code
 
 ```js
 import {
@@ -233,7 +262,7 @@ import {
 import a1 from 'a1';
 ```
 
-### ✅ Example of correct code
+#### ✅ Example of correct code
 
 ```js
 import a1 from 'a1';
@@ -245,7 +274,7 @@ import {
 } from 'd';
 ```
 
-## convert-assert-to-with
+### convert-assert-to-with
 
 > This feature would ideally use the `with` keyword to denote attributes, but there are existing implementations based on a previous version of the proposal using the `assert` keyword. Due to potential web compatibility risks, the proposal still includes `assert` marked as deprecated. Usage of the old syntax is discouraged, and its removal is being investigated.
 >
@@ -253,7 +282,7 @@ import {
 
 Check out in 🐊[**Putout Editor**](https://putout.cloudcmd.io/#/gist/9f85897b998c6458efc19db6a5414b79/57ef7cdd113c7a0087e0f7a6e70522f60baa04f4).
 
-## ❌ Example of incorrect code
+#### ❌ Example of incorrect code
 
 ```js
 import json from './foo.json' assert { type: 'json' };
@@ -265,7 +294,7 @@ import('foo.json', {
 });
 ```
 
-## ✅ Example of correct code
+#### ✅ Example of correct code
 
 ```js
 import json from './foo.json' with { type: 'json' };
@@ -277,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

package/lib/add-index-to-import/index.js

@@ -0,0 +1,31 @@
+import {extname} from 'node:path';
+import {operator} from 'putout';
+
+const {setLiteralValue} = operator;
+
+export const report = (path) => {
+    const {value} = path.node.source;
+    return `Add 'index.js' to import: '${value}' -> '${value}/index.js'`;
+};
+
+export const fix = (path) => {
+    const {source} = path.node;
+    const {value} = source;
+    
+    setLiteralValue(source, `${value}/index.js`);
+};
+
+export const traverse = ({push}) => ({
+    ImportDeclaration: (path) => {
+        const {value} = path.node.source;
+        const ext = extname(value);
+        
+        if (ext)
+            return;
+        
+        if (!value.startsWith('.'))
+            return;
+        
+        push(path);
+    },
+});

package/lib/index.js

@@ -1,3 +1,5 @@
+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';
 import * as removeQuotesFromImportAssertions from './remove-quotes-from-import-assertions/index.js';
@@ -9,13 +11,15 @@ import * as convertAssertToWith from './convert-assert-to-with/index.js';
 import * as applyExportFrom from './apply-export-from/index.js';
 
 export const rules = {
-    ...mergeDuplicateImports.rules,
+    'add-index-to-import': addIndexToImport,
+    'apply-export-from': applyExportFrom,
+    'convert-assert-to-with': convertAssertToWith,
     'declare-imports-first': declareImportsFirst,
     'group-imports-by-source': groupImportsBySource,
+    ...mergeDuplicateImports.rules,
     'remove-quotes-from-import-assertions': removeQuotesFromImportAssertions,
     'remove-empty-import': removeEmptyImport,
     'remove-empty-export': removeEmptyExport,
     'sort-imports-by-specifiers': sortImportsBySpecifiers,
-    'convert-assert-to-with': convertAssertToWith,
-    'apply-export-from': applyExportFrom,
+    'resolve-imported-file': ['off', resolveImportedFile],
 };

package/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}'`,
+    };
+};

package/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);
+};

package/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;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@putout/plugin-esm",
-  "version": "3.0.0",
+  "version": "4.1.0",
   "type": "module",
   "author": "coderaiser <mnemonic.enemy@gmail.com> (https://github.com/coderaiser)",
   "description": "🐊Putout plugin improves ability to transform ESM code",
@@ -56,7 +56,7 @@
     "supertape": "^11.0.3"
   },
   "peerDependencies": {
-    "putout": ">=39"
+    "putout": ">=40"
   },
   "license": "MIT",
   "engines": {