@putout/plugin-esm 2.3.0 → 4.0.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);
@@ -32,6 +33,7 @@ npm i putout @putout/plugin-esm -D
 ```json
 {
     "rules": {
+        "esm/add-index-to-import": "on",
         "esm/apply-export-from": "on",
         "esm/declare-imports-first": "on",
         "esm/group-imports-by-source": "on",
@@ -46,15 +48,41 @@ npm i putout @putout/plugin-esm -D
 }
 ```
 
-## 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 +92,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 +117,7 @@ import esbuild from 'esbuild';
 const [arg] = process.argv;
 ```
 
-## group-imports-by-source
+### group-imports-by-source
 
 Group order:
 
@@ -100,7 +128,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 +142,7 @@ import parse from '#parser';
 const c = 5;
 ```
 
-## ✅ Example of correct code
+#### ✅ Example of correct code
 
 ```js
 import fs from 'node:fs';
@@ -128,9 +156,9 @@ import ss from '../../bb/ss.js';
 const c = 5;
 ```
 
-## merge-duplicate-imports
+### merge-duplicate-imports
 
-### join
+#### join
 
 To disable use:
 
@@ -142,20 +170,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 +197,7 @@ To disable use:
 }
 ```
 
-#### ❌ Example of incorrect code
+##### ❌ Example of incorrect code
 
 ```js
 import putout from './putout.js';
@@ -180,7 +208,7 @@ console.log(all);
 console.log(x);
 ```
 
-#### ✅ Example of correct code
+##### ✅ Example of correct code
 
 ```js
 import putout from './putout.js';
@@ -189,39 +217,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 +261,7 @@ import {
 import a1 from 'a1';
 ```
 
-### ✅ Example of correct code
+#### ✅ Example of correct code
 
 ```js
 import a1 from 'a1';
@@ -245,7 +273,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 +281,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 +293,7 @@ import('foo.json', {
 });
 ```
 
-## ✅ Example of correct code
+#### ✅ Example of correct code
 
 ```js
 import json from './foo.json' with { type: 'json' };

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/apply-export-from/index.js

@@ -1,6 +1,4 @@
-'use strict';
-
-const {types, operator} = require('putout');
+import {types, operator} from 'putout';
 
 const {
     compare,
@@ -8,13 +6,13 @@ const {
     remove,
 } = operator;
 
-const {ExportNamespaceSpecifier} = types;
+const {exportNamespaceSpecifier} = types;
 
-module.exports.report = () => `Use 'export *' instead of 'import/export'`;
+export const report = () => `Use 'export *' instead of 'import/export'`;
 
 const IMPORT = 'import * as __a from "__b"';
 
-module.exports.fix = ({path, current}) => {
+export const fix = ({path, current}) => {
     const {exported} = current.node.specifiers[0];
     
     current.node.source = path.node.source;
@@ -23,13 +21,13 @@ module.exports.fix = ({path, current}) => {
     delete current.node.exported;
     
     current.node.specifiers = [
-        ExportNamespaceSpecifier(exported),
+        exportNamespaceSpecifier(exported),
     ];
     
     remove(path);
 };
 
-module.exports.traverse = ({push}) => ({
+export const traverse = ({push}) => ({
     [IMPORT]: (path) => {
         const {__a} = getTemplateValues(path, IMPORT);
         const {name} = __a;

package/lib/convert-assert-to-with/index.js

@@ -1,17 +1,15 @@
-'use strict';
-
 const setImportType = (path, type) => {
     path.node.options.properties[0].key.name = type;
 };
 
-module.exports.report = () => `Use 'with' instead of 'assert'`;
+export const report = () => `Use 'with' instead of 'assert'`;
 
-module.exports.include = () => [
+export const include = () => [
     'ImportDeclaration',
     'import(__a, {assert: {type: "json"}})',
 ];
 
-module.exports.fix = (path) => {
+export const fix = (path) => {
     if (path.isImportDeclaration()) {
         delete path.node.extra.deprecatedAssertSyntax;
         return;
@@ -20,7 +18,7 @@ module.exports.fix = (path) => {
     setImportType(path, 'with');
 };
 
-module.exports.filter = (path) => {
+export const filter = (path) => {
     const {extra} = path.node;
     
     if (path.isImportDeclaration())

package/lib/declare-imports-first/index.js

@@ -1,6 +1,5 @@
-'use strict';
+import {types, operator} from 'putout';
 
-const {types, operator} = require('putout');
 const {
     isImportDeclaration,
     isExportDeclaration,
@@ -9,9 +8,9 @@ const {
 const {replaceWith} = operator;
 const isESMNode = (a) => isImportDeclaration(a) || isExportDeclaration(a);
 
-module.exports.report = () => `Declare imports first`;
+export const report = () => `Declare imports first`;
 
-module.exports.fix = ({path, importPath}) => {
+export const fix = ({path, importPath}) => {
     let prev = path;
     let preventInfiniteLoop = 500;
     
@@ -29,7 +28,7 @@ module.exports.fix = ({path, importPath}) => {
     }
 };
 
-module.exports.traverse = ({push, pathStore}) => ({
+export const traverse = ({push, pathStore}) => ({
     ImportDeclaration: (path) => {
         pathStore(path);
     },

package/lib/group-imports-by-source/index.js

@@ -1,7 +1,6 @@
-'use strict';
+import {isDeepStrictEqual} from 'node:util';
+import {types, operator} from 'putout';
 
-const {isDeepStrictEqual} = require('node:util');
-const {types, operator} = require('putout');
 const {isImportDeclaration} = types;
 
 const {
@@ -9,9 +8,9 @@ const {
     remove,
 } = operator;
 
-module.exports.report = () => `Group imports by source: 'builtins', 'external', 'hashed', 'internal'`;
+export const report = () => `Group imports by source: 'builtins', 'external', 'hashed', 'internal'`;
 
-module.exports.fix = ({grouped}) => {
+export const fix = ({grouped}) => {
     const [first, ...others] = grouped;
     const nodes = [first.node];
     
@@ -24,7 +23,7 @@ module.exports.fix = ({grouped}) => {
     replaceWithMultiple(first, nodes);
 };
 
-module.exports.traverse = ({pathStore, push}) => ({
+export const traverse = ({pathStore, push}) => ({
     ImportDeclaration: pathStore,
     Program: {
         exit(path) {

package/lib/index.js

@@ -1,23 +1,23 @@
-'use strict';
+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';
+import * as sortImportsBySpecifiers from './sort-imports-by-specifiers/index.js';
+import * as removeEmptyImport from './remove-empty-import/index.js';
+import * as removeEmptyExport from './remove-empty-export/index.js';
+import * as mergeDuplicateImports from './merge-duplicate-imports/index.js';
+import * as convertAssertToWith from './convert-assert-to-with/index.js';
+import * as applyExportFrom from './apply-export-from/index.js';
 
-const declareImportsFirst = require('./declare-imports-first');
-const groupImportsBySource = require('./group-imports-by-source');
-const removeQuotesFromImportAssertions = require('./remove-quotes-from-import-assertions');
-const sortImportsBySpecifiers = require('./sort-imports-by-specifiers');
-const removeEmptyImport = require('./remove-empty-import');
-const removeEmptyExport = require('./remove-empty-export');
-const mergeDuplicateImports = require('./merge-duplicate-imports');
-const convertAssertToWith = require('./convert-assert-to-with');
-const applyExportFrom = require('./apply-export-from');
-
-module.exports.rules = {
-    ...mergeDuplicateImports.rules,
+export const 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,
 };

package/lib/merge-duplicate-imports/index.js

@@ -1,9 +1,7 @@
-'use strict';
+import * as mergeDuplicateImportsJoin from './join/index.js';
+import * as mergeDuplicateImportsRename from './rename/index.js';
 
-const mergeDuplicateImportsJoin = require('./join');
-const mergeDuplicateImportsRename = require('./rename');
-
-module.exports.rules = {
+export const rules = {
     'merge-duplicate-imports-join': mergeDuplicateImportsJoin,
     'merge-duplicate-imports-rename': mergeDuplicateImportsRename,
 };

package/lib/merge-duplicate-imports/join/index.js

@@ -1,6 +1,4 @@
-'use strict';
-
-const {types, operator} = require('putout');
+import {types, operator} from 'putout';
 
 const {remove, compareAny} = operator;
 const {values} = Object;
@@ -11,9 +9,9 @@ const {
     isImportDeclaration,
 } = types;
 
-module.exports.report = () => `Avoid duplicate imports`;
+export const report = () => `Avoid duplicate imports`;
 
-module.exports.fix = ({path, imports}) => {
+export const fix = ({path, imports}) => {
     const all = [];
     
     for (const imp of imports) {
@@ -37,7 +35,7 @@ module.exports.fix = ({path, imports}) => {
     path.node.specifiers.push(...all);
 };
 
-module.exports.traverse = ({push, pathStore}) => ({
+export const traverse = ({push, pathStore}) => ({
     ImportDeclaration(path) {
         pathStore(path);
     },

package/lib/merge-duplicate-imports/rename/index.js

@@ -1,12 +1,11 @@
-'use strict';
+import {types, operator} from 'putout';
 
-const {types, operator} = require('putout');
 const {rename, remove} = operator;
 const {isImportDefaultSpecifier} = types;
 
-module.exports.report = () => 'Avoid duplicate imports';
+export const report = () => 'Avoid duplicate imports';
 
-module.exports.fix = ({path, imports}) => {
+export const fix = ({path, imports}) => {
     const {name} = path.node.specifiers[0].local;
     remove(path);
     
@@ -22,7 +21,7 @@ module.exports.fix = ({path, imports}) => {
     }
 };
 
-module.exports.traverse = ({push, uplist}) => ({
+export const traverse = ({push, uplist}) => ({
     ImportDeclaration: (path) => {
         const {value} = path.node.source;
         const [specifier, ...other] = path.node.specifiers;

package/lib/remove-empty-export/index.js

@@ -1,19 +1,18 @@
-'use strict';
+import {operator} from 'putout';
 
-const {operator} = require('putout');
 const {remove} = operator;
 
-module.exports.report = () => 'Remove empty export';
+export const report = () => 'Remove empty export';
 
-module.exports.fix = (path) => {
+export const fix = (path) => {
     remove(path);
 };
 
-module.exports.include = () => [
+export const include = () => [
     'ExportNamedDeclaration',
 ];
 
-module.exports.filter = (path) => {
+export const filter = (path) => {
     const {specifiers, declaration} = path.node;
     
     return !declaration && !specifiers.length;

package/lib/remove-empty-import/index.js

@@ -1,22 +1,21 @@
-'use strict';
+import {operator} from 'putout';
 
-const {operator} = require('putout');
 const {remove} = operator;
 
-module.exports.report = () => `Avoid empty 'import' statement`;
+export const report = () => `Avoid empty 'import' statement`;
 
-module.exports.fix = (path) => {
+export const fix = (path) => {
     remove(path);
 };
 
 const isCSS = (a) => /\.css/.test(a);
 const isMin = (a) => /\.min\./.test(a);
 
-module.exports.include = () => [
+export const include = () => [
     'ImportDeclaration',
 ];
 
-module.exports.filter = (path, {options}) => {
+export const filter = (path, {options}) => {
     const {specifiers, source} = path.node;
     
     const {ignore = []} = options;

package/lib/remove-quotes-from-import-assertions/index.js

@@ -1,7 +1,5 @@
-'use strict';
+export const report = () => 'Remove quotes from import assertions';
 
-module.exports.report = () => 'Remove quotes from import assertions';
-
-module.exports.replace = () => ({
+export const replace = () => ({
     'import __imports from "__a" with {"type": "__b"}': 'import __imports from "__a" with {type: "__b"}',
 });

package/lib/sort-imports-by-specifiers/index.js

@@ -1,18 +1,17 @@
-'use strict';
+import {parseImportSpecifiers} from 'parse-import-specifiers';
+import {operator} from 'putout';
 
-const {parseImportSpecifiers} = require('parse-import-specifiers');
-const {operator} = require('putout');
 const {insertBefore, remove} = operator;
 
-module.exports.report = () => `Sort imports by specifiers count`;
+export const report = () => `Sort imports by specifiers count`;
 
-module.exports.fix = ({path, nextPath}) => {
+export const fix = ({path, nextPath}) => {
     const {node} = nextPath;
     remove(nextPath);
     insertBefore(path, node);
 };
 
-module.exports.traverse = ({push}) => ({
+export const traverse = ({push}) => ({
     ImportDeclaration(path) {
         const {node} = path;
         const {source, specifiers} = node;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@putout/plugin-esm",
-  "version": "2.3.0",
-  "type": "commonjs",
+  "version": "4.0.0",
+  "type": "module",
   "author": "coderaiser <mnemonic.enemy@gmail.com> (https://github.com/coderaiser)",
   "description": "🐊Putout plugin improves ability to transform ESM code",
   "homepage": "https://github.com/coderaiser/putout/tree/master/packages/plugin-esm#readme",
@@ -37,7 +37,7 @@
     "esm"
   ],
   "devDependencies": {
-    "@putout/eslint-flat": "^2.0.0",
+    "@putout/eslint-flat": "^3.0.0",
     "@putout/plugin-declare": "*",
     "@putout/plugin-declare-before-reference": "*",
     "@putout/plugin-nodejs": "*",
@@ -45,22 +45,22 @@
     "@putout/plugin-reuse-duplicate-init": "*",
     "@putout/plugin-tape": "*",
     "@putout/plugin-typescript": "*",
-    "@putout/test": "^12.0.0",
+    "@putout/test": "^13.0.0",
     "c8": "^10.0.0",
     "eslint": "^9.0.0",
     "eslint-plugin-n": "^17.0.0",
-    "eslint-plugin-putout": "^25.0.1",
-    "madrun": "^10.0.0",
+    "eslint-plugin-putout": "^26.0.0",
+    "madrun": "^11.0.0",
     "montag": "^1.2.1",
     "nodemon": "^3.0.1",
-    "supertape": "^10.8.0"
+    "supertape": "^11.0.3"
   },
   "peerDependencies": {
-    "putout": ">=38"
+    "putout": ">=40"
   },
   "license": "MIT",
   "engines": {
-    "node": ">=18"
+    "node": ">=20"
   },
   "publishConfig": {
     "access": "public"