@putout/plugin-esm 8.3.0 → 8.5.0

package/README.md

@@ -34,7 +34,8 @@ npm i putout @putout/plugin-esm -D
 
 ## File rules
 
-- ✅ [apply-import-by-type-to-file](#apply-import-by-type-to-file]);
+- ✅ [apply-name-to-imported-file](#apply-name-to-imported-file]]);
+- ✅ [apply-namespace-to-imported-file](#apply-namespace-to-imported-file]]);
 - ✅ [apply-privately-imported-file](#apply-privately-imported-file);
 - ✅ [apply-js-imported-file](#apply-js-imported-file);
 - ✅ [resolve-imported-file](#resolve-imported-file);
@@ -61,7 +62,8 @@ npm i putout @putout/plugin-esm -D
         "esm/apply-js-imported-file": "off",
         "esm/resolve-imported-file": "off",
         "esm/shorten-imported-file": "off",
-        "esm/apply-import-by-type-to-file": "off",
+        "esm/apply-name-to-imported-file": "off",
+        "esm/apply-namespace-to-imported-file": "off",
         "esm/apply-privately-imported-file": "off",
         "esm/remove-useless-export-specifiers": "off"
     }
@@ -72,7 +74,12 @@ npm i putout @putout/plugin-esm -D
 
 ### add-index-to-import
 
+> `import` a directory URL is unsupported. Instead
+>
+> (c) [nodejs.org](https://nodejs.org/api/errors.html#err_unsupported_dir_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
@@ -81,6 +88,8 @@ Checkout in 🐊[**Putout Editor**](https://putout.cloudcmd.io/#/gist/b7c4897107
 import insertRust from './insert-rust';
 import addAction from './add-action';
 
+export * as read from './vfs/read';
+
 export const rules = {};
 ```
 
@@ -90,6 +99,8 @@ export const rules = {};
 import insertRust from './insert-rust/index.js';
 import addAction from './add-action/index.js';
 
+export * as read from './vfs/read/index.js';
+
 export const rules = {};
 ```
 
@@ -399,7 +410,7 @@ import('foo.json', {
 
 ## File Rules
 
-### apply-import-by-type-to-file
+### apply-namespace-to-imported-file
 
 The rule fixes:
 
@@ -407,38 +418,42 @@ The rule fixes:
 
 Check out in 🐊**Putout Editor**:
 
-- ✅ [`apply-namespace-import-to-file`](https://putout.cloudcmd.io/#/gist/1492d584559e5798325047de679222a0/c6a37a803b80823de1b64ab944f2427aecefb51b);
+- ✅ [`apply-namespace-to-imported-file`](https://putout.cloudcmd.io/#/gist/1492d584559e5798325047de679222a0/c6a37a803b80823de1b64ab944f2427aecefb51b);
 - ✅ [`get-imports`](https://putout.cloudcmd.io/#/gist/5d7687215e9fbdf705935c444503dded/75a98d2db9d3847c73017e41637924b1cfd5a598);
 - ✅ [`has-export-default`](https://putout.cloudcmd.io/#/gist/b50ccfe5cc8c0c97e2fc98b37903ade4/fbc026e6f1027581f7aa4879dcafcaa7754bf8f4);
 - ✅ [`apply-namespace-import`](https://putout.cloudcmd.io/#/gist/23a6dc6741b772c03fbed95feda2b451/1fbecac6fc40282bcda0593aa666a8c213ef85b7);
 - ✅ [`is-esm`](https://putout.cloudcmd.io/#/gist/fa080be2bf3a6560e289d84b5873c2bc/2601091f6bf97148843767968c3afcb36dde31de);
 
-#### named import
-
 Let's consider file structure:
 
 ```
 /
 |-- lib/
 |  `-- index.js "import a from './a.js';"
-|  `-- a.js "export const a = 2;"
+|  `-- a.js "export const x = 2;"
 ```
 
 In this case `index.js` can be fixed:
 
-##### ❌ Example of incorrect code
+#### ❌ Example of incorrect code
 
 ```js
 import a from './a.js';
 ```
 
-##### ✅ Example of correct code
+#### ✅ Example of correct code
 
 ```js
-import {a} from './a.js';
+import * as a from './a.js';
 ```
 
-#### namespace import
+### apply-name-to-imported-file
+
+Checkout in 🐊**Putout Editor**:
+
+- ✅ [`get-imports`](https://putout.cloudcmd.io/#/gist/5d7687215e9fbdf705935c444503dded/75a98d2db9d3847c73017e41637924b1cfd5a598);
+- ✅ [`has-export-default`](https://putout.cloudcmd.io/#/gist/b50ccfe5cc8c0c97e2fc98b37903ade4/fbc026e6f1027581f7aa4879dcafcaa7754bf8f4);
+- ✅ [`is-esm`](https://putout.cloudcmd.io/#/gist/fa080be2bf3a6560e289d84b5873c2bc/2601091f6bf97148843767968c3afcb36dde31de);
 
 Let's consider file structure:
 
@@ -446,7 +461,7 @@ Let's consider file structure:
 /
 |-- lib/
 |  `-- index.js "import a from './a.js';"
-|  `-- a.js "export const x = 2;"
+|  `-- a.js "export const a = 2;"
 ```
 
 In this case `index.js` can be fixed:
@@ -460,10 +475,10 @@ import a from './a.js';
 ##### ✅ Example of correct code
 
 ```js
-import * as a from './a.js';
+import {a} from './a.js';
 ```
 
-### apply-privately-imported-to-file
+### apply-privately-imported-file
 
 > Entries in the imports field must be strings starting with `#`.
 > Package imports permit mapping to external packages.
@@ -565,7 +580,7 @@ import {parseProcessorNames} from './parse-processor-names.js';
 
 ### apply-js-imported-file
 
-Check out in 🐊**Putout Editor**:
+Checkout in 🐊**Putout Editor**:
 
 - ✅ [`get-imports`](https://putout.cloudcmd.io/#/gist/ee10100fed86e4db926885dd54298668/7538bca7a9ae006d976f41261c0ed4c0e1902ace);
 - ✅ [`change-imports`](https://putout.cloudcmd.io/#/gist/23a6dc6741b772c03fbed95feda2b451/1fbecac6fc40282bcda0593aa666a8c213ef85b7);

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

@@ -16,8 +16,14 @@ export const fix = (path) => {
 };
 
 export const traverse = ({push}) => ({
-    ImportDeclaration: (path) => {
-        const {value} = path.node.source;
+    'ImportDeclaration|ExportNamedDeclaration': (path) => {
+        const {node} = path;
+        const {source} = node;
+        
+        if (!source)
+            return;
+        
+        const {value} = source;
         const ext = extname(value);
         
         if (ext)

package/lib/{apply-import-by-type-to-file → apply-name-to-imported-file}/determine-import-type.js

@@ -50,7 +50,7 @@ export const determineImportType = ({name, rootPath, importedFilename, privateIm
             return 'equal';
     }
     
-    return 'named';
+    return 'namespace';
 };
 
 function parseImportedFilename({importedFilename, privateImports}) {

package/lib/apply-name-to-imported-file/get-imports-tuples.js

@@ -0,0 +1,45 @@
+import {dirname, join} from 'node:path';
+import {transform, operator} from 'putout';
+import * as getImportsPlugin from '#get-default-imports';
+
+const {getFilename} = operator;
+const getMessage = (a) => a.message;
+
+export const getImportsTuples = (file, content, ast) => {
+    if (!content.includes('import'))
+        return [];
+    
+    const places = transform(ast, content, {
+        fix: false,
+        plugins: [
+            ['get-imports', getImportsPlugin],
+        ],
+    });
+    
+    const filename = getFilename(file);
+    const dir = dirname(filename);
+    
+    const imports = places.map(getMessage);
+    
+    return buildImports(dir, imports);
+};
+
+function parseFull(dir, source) {
+    if (source.startsWith('#'))
+        return source;
+    
+    return join(dir, source);
+}
+
+function buildImports(dir, imports) {
+    const list = [];
+    
+    for (const current of imports) {
+        const [name, source] = current.split(' <- ');
+        const full = parseFull(dir, source);
+        
+        list.push([name, source, full]);
+    }
+    
+    return list;
+}

package/lib/apply-name-to-imported-file/index.js

@@ -0,0 +1,77 @@
+import {tryCatch} from 'try-catch';
+import {
+    parse,
+    print,
+    operator,
+} from 'putout';
+import {createGetPrivateImports} from '#private-imports';
+import {determineImportType} from '#determine-import-type';
+import {transformNamedImport} from './transform-named-import.js';
+import {getImportsTuples} from './get-imports-tuples.js';
+
+const {
+    getFilename,
+    readFileContent,
+    writeFileContent,
+    crawlDirectory,
+} = operator;
+
+export const report = (file, {name, source}) => {
+    const filename = getFilename(file);
+    return `Use \`import {${name}} from '${source}'\` in '${filename}'`;
+};
+
+export const fix = (file, {name, source, content, ast}) => {
+    transformNamedImport(ast, {
+        name,
+        source,
+        content,
+    });
+    
+    const newContent = print(ast);
+    
+    writeFileContent(file, newContent);
+};
+
+export const scan = (rootPath, {push, trackFile}) => {
+    const mask = [
+        '*.js',
+        '*.mjs',
+    ];
+    
+    const getPrivateImports = createGetPrivateImports();
+    const crawled = crawlDirectory(rootPath);
+    
+    for (const file of trackFile(rootPath, mask)) {
+        const content = readFileContent(file);
+        const [error, ast] = tryCatch(parse, content);
+        
+        if (error)
+            continue;
+        
+        const importsTuples = getImportsTuples(file, content, ast);
+        
+        const privateImports = getPrivateImports(file, {
+            aliasBased: true,
+        });
+        
+        for (const [name, source, importedFilename] of importsTuples) {
+            const importType = determineImportType({
+                name,
+                rootPath,
+                importedFilename,
+                privateImports,
+                crawled,
+            });
+            
+            if (importType === 'equal')
+                push(file, {
+                    importType,
+                    name,
+                    source,
+                    ast,
+                    content,
+                });
+        }
+    }
+};

package/lib/apply-namespace-to-imported-file/index.js

@@ -0,0 +1,77 @@
+import {tryCatch} from 'try-catch';
+import {
+    parse,
+    print,
+    operator,
+} from 'putout';
+import {createGetPrivateImports} from '#private-imports';
+import {determineImportType} from '#determine-import-type';
+import {transformNamespaceImport} from './transform-namespace-import.js';
+import {getImportsTuples} from '../apply-name-to-imported-file/get-imports-tuples.js';
+
+const {
+    getFilename,
+    readFileContent,
+    writeFileContent,
+    crawlDirectory,
+} = operator;
+
+export const report = (file, {name, source}) => {
+    const filename = getFilename(file);
+    return `Use \`import * as ${name} from '${source}'\` in '${filename}'`;
+};
+
+export const fix = (file, {name, source, content, ast}) => {
+    transformNamespaceImport(ast, {
+        name,
+        source,
+        content,
+    });
+    
+    const newContent = print(ast);
+    
+    writeFileContent(file, newContent);
+};
+
+export const scan = (rootPath, {push, trackFile}) => {
+    const mask = [
+        '*.js',
+        '*.mjs',
+    ];
+    
+    const getPrivateImports = createGetPrivateImports();
+    const crawled = crawlDirectory(rootPath);
+    
+    for (const file of trackFile(rootPath, mask)) {
+        const content = readFileContent(file);
+        const [error, ast] = tryCatch(parse, content);
+        
+        if (error)
+            continue;
+        
+        const importsTuples = getImportsTuples(file, content, ast);
+        
+        const privateImports = getPrivateImports(file, {
+            aliasBased: true,
+        });
+        
+        for (const [name, source, importedFilename] of importsTuples) {
+            const importType = determineImportType({
+                name,
+                rootPath,
+                importedFilename,
+                privateImports,
+                crawled,
+            });
+            
+            if (importType === 'namespace')
+                push(file, {
+                    importType,
+                    name,
+                    source,
+                    ast,
+                    content,
+                });
+        }
+    }
+};

package/lib/index.js

@@ -1,6 +1,7 @@
 import * as applyExportFrom from './apply-export-from/index.js';
 import * as applyJsImportedFile from './apply-js-imported-file/index.js';
-import * as applyImportByTypeToFile from './apply-import-by-type-to-file/index.js';
+import * as applyNameToImportedFile from './apply-name-to-imported-file/index.js';
+import * as applyNamespaceToImportedFile from './apply-namespace-to-imported-file/index.js';
 import * as mergeExportDeclarations from './merge-export-declarations/index.js';
 import * as removeUselessExportSpecifiers from './remove-useless-export-specifiers/index.js';
 import * as mergeDeclarationWithExport from './merge-declaration-with-export/index.js';
@@ -34,7 +35,8 @@ export const rules = {
     
     'resolve-imported-file': ['off', resolveImportedFile],
     'shorten-imported-file': ['off', shortenImportedFile],
-    'apply-import-by-type-to-file': ['off', applyImportByTypeToFile],
+    'apply-name-to-imported-file': ['off', applyNameToImportedFile],
+    'apply-namespace-to-imported-file': ['off', applyNamespaceToImportedFile],
     'apply-privately-imported-file': ['off', applyPrivatelyImportedFile],
     'apply-js-imported-file': ['off', applyJsImportedFile],
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@putout/plugin-esm",
-  "version": "8.3.0",
+  "version": "8.5.0",
   "type": "module",
   "author": "coderaiser <mnemonic.enemy@gmail.com> (https://github.com/coderaiser)",
   "description": "🐊Putout plugin improves ability to transform ESM code",
@@ -12,12 +12,13 @@
   },
   "imports": {
     "#get-imports": "./lib/shorten-imported-file/get-imports/index.js",
-    "#get-default-imports": "./lib/apply-import-by-type-to-file/get-imports/index.js",
+    "#get-imports-tuples": "./lib/shorten-imported-file/get-imports-tuples.js",
+    "#get-default-imports": "./lib/apply-name-to-imported-file/get-imports/index.js",
     "#change-imports": "./lib/resolve-imported-file/change-imports/index.js",
     "#private-imports": "./lib/apply-privately-imported-file/private-imports.js",
-    "#is-esm": "./lib/apply-import-by-type-to-file/is-esm/index.js",
-    "#has-export-default": "./lib/apply-import-by-type-to-file/has-export-default/index.js",
-    "#determine-import-type": "./lib/apply-import-by-type-to-file/determine-import-type.js"
+    "#is-esm": "./lib/apply-name-to-imported-file/is-esm/index.js",
+    "#has-export-default": "./lib/apply-name-to-imported-file/has-export-default/index.js",
+    "#determine-import-type": "./lib/apply-name-to-imported-file/determine-import-type.js"
   },
   "release": false,
   "tag": false,

package/lib/apply-import-by-type-to-file/index.js

@@ -1,135 +0,0 @@
-import {join, dirname} from 'node:path';
-import {tryCatch} from 'try-catch';
-import {
-    parse,
-    print,
-    transform,
-    operator,
-} from 'putout';
-import {createGetPrivateImports} from '#private-imports';
-import * as getImportsPlugin from '#get-default-imports';
-import {determineImportType} from '#determine-import-type';
-import {transformNamedImport} from './transform-named-import.js';
-import {transformNamespaceImport} from './transform-namespace-import.js';
-
-const {
-    getFilename,
-    readFileContent,
-    writeFileContent,
-    crawlDirectory,
-} = operator;
-
-const getMessage = (a) => a.message;
-
-export const report = (file, {importType, name, source}) => {
-    const filename = getFilename(file);
-    
-    if (importType === 'equal')
-        return `Use \`import {${name}} from '${source}'\` in '${filename}'`;
-    
-    return `Use \`import * as ${name} from '${source}'\` in '${filename}'`;
-};
-
-export const fix = (file, {name, source, content, ast, importType}) => {
-    if (importType === 'equal')
-        transformNamedImport(ast, {
-            name,
-            source,
-            content,
-        });
-    
-    if (importType === 'named')
-        transformNamespaceImport(ast, {
-            name,
-            source,
-            content,
-        });
-    
-    const newContent = print(ast);
-    
-    writeFileContent(file, newContent);
-};
-
-export const scan = (rootPath, {push, trackFile}) => {
-    const mask = [
-        '*.js',
-        '*.mjs',
-    ];
-    
-    const getPrivateImports = createGetPrivateImports();
-    const crawled = crawlDirectory(rootPath);
-    
-    for (const file of trackFile(rootPath, mask)) {
-        const content = readFileContent(file);
-        const [error, ast] = tryCatch(parse, content);
-        
-        if (error)
-            continue;
-        
-        const importsTuples = getImports(file, content, ast);
-        
-        const privateImports = getPrivateImports(file, {
-            aliasBased: true,
-        });
-        
-        for (const [name, source, importedFilename] of importsTuples) {
-            const importType = determineImportType({
-                name,
-                rootPath,
-                importedFilename,
-                privateImports,
-                crawled,
-            });
-            
-            if (!importType)
-                continue;
-            
-            push(file, {
-                importType,
-                name,
-                source,
-                ast,
-                content,
-            });
-        }
-    }
-};
-
-function getImports(file, content, ast) {
-    if (!content.includes('import'))
-        return [];
-    
-    const places = transform(ast, content, {
-        fix: false,
-        plugins: [
-            ['get-imports', getImportsPlugin],
-        ],
-    });
-    
-    const filename = getFilename(file);
-    const dir = dirname(filename);
-    
-    const imports = places.map(getMessage);
-    
-    return buildImports(dir, imports);
-}
-
-function parseFull(dir, source) {
-    if (source.startsWith('#'))
-        return source;
-    
-    return join(dir, source);
-}
-
-function buildImports(dir, imports) {
-    const list = [];
-    
-    for (const current of imports) {
-        const [name, source] = current.split(' <- ');
-        const full = parseFull(dir, source);
-        
-        list.push([name, source, full]);
-    }
-    
-    return list;
-}