@putout/plugin-esm 8.1.0 → 8.3.0

package/README.md

@@ -34,8 +34,7 @@ npm i putout @putout/plugin-esm -D
 
 ## File rules
 
-- ✅ [apply-namespace-import-to-file](#apply-namespace-import-file]);
-- ✅ [apply-named-import-to-file](#apply-named-import-to-file);
+- ✅ [apply-import-by-type-to-file](#apply-import-by-type-to-file]);
 - ✅ [apply-privately-imported-file](#apply-privately-imported-file);
 - ✅ [apply-js-imported-file](#apply-js-imported-file);
 - ✅ [resolve-imported-file](#resolve-imported-file);
@@ -62,8 +61,7 @@ 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-namespace-import-to-file": "off",
-        "esm/apply-named-import-to-file": "off",
+        "esm/apply-import-by-type-to-file": "off",
         "esm/apply-privately-imported-file": "off",
         "esm/remove-useless-export-specifiers": "off"
     }
@@ -401,7 +399,7 @@ import('foo.json', {
 
 ## File Rules
 
-### apply-named-import-to-file
+### apply-import-by-type-to-file
 
 The rule fixes:
 
@@ -409,10 +407,14 @@ The rule fixes:
 
 Check out in 🐊**Putout Editor**:
 
+- ✅ [`apply-namespace-import-to-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:
 
 ```
@@ -424,31 +426,19 @@ Let's consider file structure:
 
 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';
 ```
 
-### apply-namespace-import-to-file
-
-The rule fixes:
-
-> `SyntaxError: The requested module './a.js' does not provide an export named 'default'`
-
-Check out in 🐊**Putout Editor**:
-
-- ✅ [`apply-namespace-import-to-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);
+#### namespace import
 
 Let's consider file structure:
 
@@ -461,13 +451,13 @@ Let's consider file structure:
 
 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 * as a from './a.js';

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

@@ -0,0 +1,61 @@
+import {putout, operator} from 'putout';
+import * as hasExportDefaultPlugin from '#has-export-default';
+import * as isESMPlugin from '#is-esm';
+
+const isESM = (a) => a.rule === 'is-esm';
+const hasExportDefault = (a) => a.rule === 'has-export-default';
+
+const {
+    findFile,
+    readFileContent,
+} = operator;
+
+export const determineImportType = ({name, rootPath, importedFilename, privateImports, crawled}) => {
+    const parsedName = parseImportedFilename({
+        importedFilename,
+        privateImports,
+    });
+    
+    const [importedFile] = findFile(rootPath, parsedName, {
+        crawled,
+    });
+    
+    if (!importedFile)
+        return '';
+    
+    const importedContent = readFileContent(importedFile);
+    
+    const {places} = putout(importedContent, {
+        fix: false,
+        plugins: [
+            ['has-export-default', hasExportDefaultPlugin],
+            ['is-esm', isESMPlugin],
+        ],
+    });
+    
+    const esm = places.filter(isESM);
+    
+    if (!esm.length)
+        return '';
+    
+    const defaultExport = places.filter(hasExportDefault);
+    
+    if (defaultExport.length)
+        return '';
+    
+    for (const {message} of esm) {
+        const [, exportName] = message.split(':');
+        
+        if (name === exportName)
+            return 'equal';
+    }
+    
+    return 'named';
+};
+
+function parseImportedFilename({importedFilename, privateImports}) {
+    if (privateImports.has(importedFilename))
+        return privateImports.get(importedFilename);
+    
+    return importedFilename;
+}

package/lib/{apply-namespace-import-to-file → apply-import-by-type-to-file}/index.js

@@ -1,45 +1,49 @@
 import {join, dirname} from 'node:path';
 import {tryCatch} from 'try-catch';
-import putout, {
+import {
     parse,
     print,
     transform,
     operator,
 } from 'putout';
 import {createGetPrivateImports} from '#private-imports';
-import * as isESMPlugin from '#is-esm';
-import * as hasExportDefaultPlugin from '#has-export-default';
 import * as getImportsPlugin from '#get-default-imports';
-import * as applyNamespaceImportPlugin from './apply-namespace-import/index.js';
+import {determineImportType} from '#determine-import-type';
+import {transformNamedImport} from './transform-named-import.js';
+import {transformNamespaceImport} from './transform-namespace-import.js';
 
 const {
-    findFile,
     getFilename,
     readFileContent,
     writeFileContent,
+    crawlDirectory,
 } = operator;
 
 const getMessage = (a) => a.message;
-const isESM = (a) => a.rule === 'is-esm';
-const hasExportDefault = (a) => a.rule === 'has-export-default';
 
-export const report = (file, {name, source}) => {
+export const report = (file, {importType, name, source}) => {
     const filename = getFilename(file);
-    return `Use 'import * as ${name} from '${source}' in '${filename}'`;
+    
+    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}) => {
-    transform(ast, content, {
-        rules: {
-            'apply-namespace-import': ['on', {
-                name,
-                source,
-            }],
-        },
-        plugins: [
-            ['apply-namespace-import', applyNamespaceImportPlugin],
-        ],
-    });
+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);
     
@@ -53,6 +57,7 @@ export const scan = (rootPath, {push, trackFile}) => {
     ];
     
     const getPrivateImports = createGetPrivateImports();
+    const crawled = crawlDirectory(rootPath);
     
     for (const file of trackFile(rootPath, mask)) {
         const content = readFileContent(file);
@@ -68,17 +73,19 @@ export const scan = (rootPath, {push, trackFile}) => {
         });
         
         for (const [name, source, importedFilename] of importsTuples) {
-            const is = hasImportDefault({
+            const importType = determineImportType({
                 name,
                 rootPath,
                 importedFilename,
                 privateImports,
+                crawled,
             });
             
-            if (is)
+            if (!importType)
                 continue;
             
             push(file, {
+                importType,
                 name,
                 source,
                 ast,
@@ -107,50 +114,6 @@ function getImports(file, content, ast) {
     return buildImports(dir, imports);
 }
 
-function parseImportedFilename({importedFilename, privateImports}) {
-    if (privateImports.has(importedFilename))
-        return privateImports.get(importedFilename);
-    
-    return importedFilename;
-}
-
-function hasImportDefault({name, rootPath, importedFilename, privateImports}) {
-    const parsedName = parseImportedFilename({
-        importedFilename,
-        privateImports,
-    });
-    
-    const [importedFile] = findFile(rootPath, parsedName);
-    
-    if (!importedFile)
-        return true;
-    
-    const importedContent = readFileContent(importedFile);
-    
-    const {places} = putout(importedContent, {
-        fix: false,
-        plugins: [
-            ['has-export-default', hasExportDefaultPlugin],
-            ['is-esm', isESMPlugin],
-        ],
-    });
-    
-    const esm = places.filter(isESM);
-    const defaultExport = places.filter(hasExportDefault);
-    
-    if (defaultExport.length)
-        return true;
-    
-    for (const {message} of esm) {
-        const [, exportName] = message.split(':');
-        
-        if (name === exportName)
-            return true;
-    }
-    
-    return !esm.length;
-}
-
 function parseFull(dir, source) {
     if (source.startsWith('#'))
         return source;

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

@@ -0,0 +1,16 @@
+import {transform} from 'putout';
+import * as applyNamedImportPlugin from './apply-named-import/index.js';
+
+export const transformNamedImport = (ast, {name, source, content}) => {
+    transform(ast, content, {
+        rules: {
+            'apply-named-import': ['on', {
+                name,
+                source,
+            }],
+        },
+        plugins: [
+            ['apply-named-import', applyNamedImportPlugin],
+        ],
+    });
+};

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

@@ -0,0 +1,16 @@
+import {transform} from 'putout';
+import * as applyNamespaceImportPlugin from './apply-namespace-import/index.js';
+
+export const transformNamespaceImport = (ast, {source, content, name}) => {
+    transform(ast, content, {
+        rules: {
+            'apply-namespace-import': ['on', {
+                name,
+                source,
+            }],
+        },
+        plugins: [
+            ['apply-namespace-import', applyNamespaceImportPlugin],
+        ],
+    });
+};

package/lib/index.js

@@ -1,5 +1,6 @@
 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 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';
@@ -12,8 +13,6 @@ 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 applyNamespaceImportToFile from './apply-namespace-import-to-file/index.js';
-import * as applyNamedImportToFile from './apply-named-import-to-file/index.js';
 import * as applyPrivatelyImportedFile from './apply-privately-imported-file/index.js';
 import * as resolveImportedFile from './resolve-imported-file/index.js';
 import * as shortenImportedFile from './shorten-imported-file/index.js';
@@ -35,8 +34,7 @@ export const rules = {
     
     'resolve-imported-file': ['off', resolveImportedFile],
     'shorten-imported-file': ['off', shortenImportedFile],
-    'apply-named-import-to-file': ['off', applyNamedImportToFile],
-    'apply-namespace-import-to-file': ['off', applyNamespaceImportToFile],
+    'apply-import-by-type-to-file': ['off', applyImportByTypeToFile],
     '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.1.0",
+  "version": "8.3.0",
   "type": "module",
   "author": "coderaiser <mnemonic.enemy@gmail.com> (https://github.com/coderaiser)",
   "description": "🐊Putout plugin improves ability to transform ESM code",
@@ -12,11 +12,12 @@
   },
   "imports": {
     "#get-imports": "./lib/shorten-imported-file/get-imports/index.js",
-    "#get-default-imports": "./lib/apply-namespace-import-to-file/get-imports/index.js",
+    "#get-default-imports": "./lib/apply-import-by-type-to-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-namespace-import-to-file/is-esm/index.js",
-    "#has-export-default": "./lib/apply-namespace-import-to-file/has-export-default/index.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"
   },
   "release": false,
   "tag": false,

package/lib/apply-named-import-to-file/index.js

@@ -1,176 +0,0 @@
-import {join, dirname} from 'node:path';
-import {tryCatch} from 'try-catch';
-import putout, {
-    parse,
-    print,
-    transform,
-    operator,
-} from 'putout';
-import {createGetPrivateImports} from '#private-imports';
-import * as isESMPlugin from '#is-esm';
-import * as hasExportDefaultPlugin from '#has-export-default';
-import * as getImportsPlugin from '#get-default-imports';
-import * as applyNamedImportPlugin from './apply-named-import/index.js';
-
-const {
-    findFile,
-    getFilename,
-    readFileContent,
-    writeFileContent,
-} = operator;
-
-const getMessage = (a) => a.message;
-const isESM = (a) => a.rule === 'is-esm';
-const hasExportDefault = (a) => a.rule === 'has-export-default';
-
-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}) => {
-    transform(ast, content, {
-        rules: {
-            'apply-named-import': ['on', {
-                name,
-                source,
-            }],
-        },
-        plugins: [
-            ['apply-named-import', applyNamedImportPlugin],
-        ],
-    });
-    
-    const newContent = print(ast);
-    
-    writeFileContent(file, newContent);
-};
-
-export const scan = (rootPath, {push, trackFile}) => {
-    const mask = [
-        '*.js',
-        '*.mjs',
-    ];
-    
-    const getPrivateImports = createGetPrivateImports();
-    
-    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 is = hasNamedImport({
-                name,
-                rootPath,
-                importedFilename,
-                privateImports,
-            });
-            
-            if (!is)
-                continue;
-            
-            push(file, {
-                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 parseImportedFilename({importedFilename, privateImports}) {
-    if (privateImports.has(importedFilename))
-        return privateImports.get(importedFilename);
-    
-    return importedFilename;
-}
-
-function hasNamedImport({name, rootPath, importedFilename, privateImports}) {
-    const parsedName = parseImportedFilename({
-        importedFilename,
-        privateImports,
-    });
-    
-    const [importedFile] = findFile(rootPath, parsedName);
-    
-    if (!importedFile)
-        return false;
-    
-    const importedContent = readFileContent(importedFile);
-    
-    const {places} = putout(importedContent, {
-        fix: false,
-        plugins: [
-            ['has-export-default', hasExportDefaultPlugin],
-            ['is-esm', isESMPlugin],
-        ],
-    });
-    
-    const esm = places.filter(isESM);
-    
-    if (!esm.length)
-        return false;
-    
-    const defaultExport = places.filter(hasExportDefault);
-    
-    if (defaultExport.length)
-        return false;
-    
-    for (const {message} of esm) {
-        const [, exportName] = message.split(':');
-        
-        if (name === exportName)
-            return true;
-    }
-    
-    return false;
-}
-
-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;
-}