@putout/plugin-esm 4.1.2 → 4.2.0

package/README.md

@@ -27,6 +27,10 @@ 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);
+
+## File rules
+
+- ✅ [apply-namespace-import-file](#resolve-imported-file);
 - ✅ [resolve-imported-file](#resolve-imported-file);
 
 ## Config
@@ -306,6 +310,44 @@ import('foo.json', {
 });
 ```
 
+## File Rules
+
+### apply-namespace-import-to-file
+
+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);
+
+Let's consider file structure:
+
+```
+/
+|-- lib/
+|  `-- index.js "import a from './a.js';"
+|  `-- a.js "export const x = 2;"
+```
+
+In this case `index.js` can be fixed:
+
+#### ❌ Example of incorrect code
+
+```js
+import a from './a.js';
+```
+
+#### ✅ Example of correct code
+
+```js
+import * as a from './a.js';
+```
+
+## License
+
+MIT
+
 ### resolve-imported-file
 
 Check out in 🐊**Putout Editor**:

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

@@ -0,0 +1,16 @@
+export const report = (path) => {
+    const source = path.node.source.value;
+    const {specifiers} = path.node;
+    const [{local}] = specifiers;
+    const {name} = local;
+    
+    return `'import ${name} from "${source}"' -> 'import * as ${name} from "${source}"'`;
+};
+
+export const replace = ({options}) => {
+    const {name, source} = options;
+    
+    return {
+        [`import ${name} from "${source}"`]: `import * as ${name} from "${source}"`,
+    };
+};

package/lib/apply-namespace-import-to-file/get-imports/index.js

@@ -0,0 +1,29 @@
+export const include = () => [
+    'import __a from "__b"',
+];
+
+export const report = (path) => {
+    const [name, source] = getImport(path);
+    return `${name} <- ${source}`;
+};
+
+export const fix = (path) => {
+    const [name, source] = getImport(path);
+    
+    path.node.leadingComments = [
+        CommentLine(`${name} <- ${source}'`),
+    ];
+};
+
+const CommentLine = (value) => ({
+    type: 'CommentLine',
+    value: ` ${value}`,
+});
+
+const getImport = (path) => {
+    const source = path.node.source.value;
+    const [first] = path.node.specifiers;
+    const {name} = first.local;
+    
+    return [name, source];
+};

package/lib/apply-namespace-import-to-file/has-export-default/index.js

@@ -0,0 +1,6 @@
+export const report = (path) => path.node.type;
+
+export const fix = () => {};
+export const include = () => [
+    'ExportDefaultDeclaration',
+];

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

@@ -0,0 +1,123 @@
+import {join, dirname} from 'node:path';
+import putout, {
+    parse,
+    print,
+    transform,
+    operator,
+} from 'putout';
+import * as isESMPlugin from './is-esm/index.js';
+import * as hasExportDefaultPlugin from './has-export-default/index.js';
+import * as applyNamespaceImportPlugin from './apply-namespace-import/index.js';
+import * as getImportsPlugin from './get-imports/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}) => `Use 'import * as ${name} from '${source}'`;
+export const fix = (file, {name, source, content, ast}) => {
+    transform(ast, content, {
+        rules: {
+            'apply-namespace-import': ['on', {
+                name,
+                source,
+            }],
+        },
+        plugins: [
+            ['apply-namespace-import', applyNamespaceImportPlugin],
+        ],
+    });
+    
+    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);
+        const ast = parse(content);
+        const importsTuples = getImports(file, content, ast);
+        
+        for (const [name, source, importedFilename] of importsTuples) {
+            if (hasImportDefault(rootPath, importedFilename))
+                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 hasImportDefault(rootPath, importedFilename) {
+    const [importedFile] = findFile(rootPath, importedFilename);
+    
+    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;
+    
+    return !esm.length;
+}
+
+function buildImports(dir, imports) {
+    const list = [];
+    
+    for (const current of imports) {
+        const [name, source] = current.split(' <- ');
+        const full = join(dir, source);
+        
+        list.push([name, source, full]);
+    }
+    
+    return list;
+}

package/lib/apply-namespace-import-to-file/is-esm/index.js

@@ -0,0 +1,18 @@
+export const report = (path) => path.type;
+
+export const fix = (path) => {
+    path.node.leadingComments = [
+        CommentLine('esm'),
+    ];
+};
+
+export const include = () => [
+    'ExportDefaultDeclaration',
+    'ExportNamedDeclaration',
+    'ImportDeclaration',
+];
+
+const CommentLine = (value) => ({
+    type: 'CommentLine',
+    value: ` ${value}`,
+});

package/lib/index.js

@@ -1,3 +1,4 @@
+import * as applyNamespaceImportToFile from './apply-namespace-import-to-file/index.js';
 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';
@@ -22,4 +23,5 @@ export const rules = {
     'remove-empty-export': removeEmptyExport,
     'sort-imports-by-specifiers': sortImportsBySpecifiers,
     'resolve-imported-file': ['off', resolveImportedFile],
+    'apply-namespace-import-to-file': ['off', applyNamespaceImportToFile],
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@putout/plugin-esm",
-  "version": "4.1.2",
+  "version": "4.2.0",
   "type": "module",
   "author": "coderaiser <mnemonic.enemy@gmail.com> (https://github.com/coderaiser)",
   "description": "🐊Putout plugin improves ability to transform ESM code",