@putout/plugin-esm 6.5.1 → 6.6.0

package/README.md

@@ -35,6 +35,7 @@ npm i putout @putout/plugin-esm -D
 ## File rules
 
 - ✅ [apply-namespace-import-file](#resolve-imported-file);
+- ✅ [apply-privately-imported-file](#apply-privately-imported-file);
 - ✅ [resolve-imported-file](#resolve-imported-file);
 - ✅ [shorten-imported-file](#shorten-imported-file);
 
@@ -59,6 +60,7 @@ npm i putout @putout/plugin-esm -D
         "esm/resolve-imported-file": "off",
         "esm/shorten-imported-file": "off",
         "esm/apply-namespace-of-file": "off",
+        "esm/apply-privately-imported-file": "off",
         "esm/remove-useless-export-specifiers": "off"
     }
 }
@@ -444,6 +446,45 @@ import a from './a.js';
 import * as a from './a.js';
 ```
 
+### apply-privately-imported-to-file
+
+> Entries in the imports field must be strings starting with `#`.
+> Package imports permit mapping to external packages.
+> This field defines subpath imports for the current package.
+>
+> (c) [nodejs.org](https://nodejs.org/api/packages.html#imports)
+
+Check out in 🐊**Putout Editor**:
+
+- ✅ [`get-imports`](https://putout.cloudcmd.io/#/gist/5d7687215e9fbdf705935c444503dded/75a98d2db9d3847c73017e41637924b1cfd5a598);
+- ✅ [`change-imports`](https://putout.cloudcmd.io/#/gist/23a6dc6741b772c03fbed95feda2b451/1fbecac6fc40282bcda0593aa666a8c213ef85b7);
+
+Let's consider file structure:
+
+```
+/
+|-- package.json {"imports": {"#is: {"default": "./lib/tokenize/is.js"}}}
+|-- lib/
+|  `-- tokenize/
+|     `-- is.js "export const isPrev = () => {}"
+|     `-- expressions/
+        `-- spread-element.js "import {isPrev} from '../is.js"
+```
+
+In this case `spread-element.js` can be fixed:
+
+#### ❌ Example of incorrect code
+
+```js
+import {isPrev} from '../is.js';
+```
+
+#### ✅ Example of correct code
+
+```js
+import {isPrev} from '#is';
+```
+
 ### resolve-imported-file
 
 Check out in 🐊**Putout Editor**:

package/lib/apply-privately-imported-file/index.js

@@ -0,0 +1,151 @@
+import {
+    join,
+    dirname,
+    resolve,
+} from 'node:path';
+import {tryCatch} from 'try-catch';
+import {
+    parse,
+    print,
+    transform,
+    operator,
+} from 'putout';
+import * as getImports from '../shorten-imported-file/get-imports/index.js';
+import * as changeImports from '../resolve-imported-file/change-imports/index.js';
+
+const {
+    getFilename,
+    getFileType,
+    getParentDirectory,
+    readFileContent,
+    writeFileContent,
+    readDirectory,
+} = operator;
+
+const {entries} = Object;
+const {parse: parseJson} = JSON;
+
+const getMessage = (a) => a.message;
+
+export const report = (file, {from, to}) => `Apply privately imported 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',
+    ];
+    
+    const getPrivateImports = createGetPrivateImports();
+    
+    for (const file of trackFile(rootPath, mask)) {
+        const content = readFileContent(file);
+        
+        if (!content.includes('import'))
+            continue;
+        
+        const [, privateImports] = getPrivateImports(file);
+        
+        if (!privateImports.size)
+            continue;
+        
+        const ast = parse(content);
+        
+        const places = transform(ast, content, {
+            plugins: [
+                ['get-imports', getImports],
+            ],
+        });
+        
+        const imports = places.map(getMessage);
+        
+        const filename = getFilename(file);
+        const dir = dirname(filename);
+        
+        for (const from of imports) {
+            const to = join(dir, from).replace(dir, '.');
+            
+            if (privateImports.has(to))
+                push(file, {
+                    from,
+                    to: privateImports.get(to),
+                    content,
+                    ast,
+                });
+        }
+    }
+};
+
+const createGetPrivateImports = (importsCache = new Map(), emptyMap = new Map()) => (file) => {
+    const filename = getFilename(file);
+    const dir = dirname(filename);
+    
+    if (importsCache.has(dir))
+        return importsCache.get(dir);
+    
+    const [packageDirectory, packagePath] = findPackage(file);
+    
+    if (!packagePath) {
+        importsCache.set(dir, {});
+        return ['', emptyMap];
+    }
+    
+    const packageContent = readFileContent(packagePath);
+    const [error, packageJson] = tryCatch(parseJson, packageContent);
+    
+    if (error) {
+        importsCache.set(dir, emptyMap);
+        
+        return ['', emptyMap];
+    }
+    
+    const {imports = {}} = packageJson;
+    const importsEntries = new Map();
+    
+    for (const [alias, {default: filePath}] of entries(imports)) {
+        const resolvedPath = resolve(packageDirectory, filePath);
+        importsEntries.set(resolvedPath, alias);
+    }
+    
+    importsCache.set(dir, [packageDirectory, importsEntries]);
+    
+    return [packageDirectory, importsEntries];
+};
+
+function findPackage(file) {
+    const parentDirectory = getParentDirectory(file);
+    const directoryName = getFilename(parentDirectory);
+    
+    for (const currentFile of readDirectory(parentDirectory)) {
+        const type = getFileType(currentFile);
+        
+        if (type === 'directory')
+            continue;
+        
+        const currentName = getFilename(currentFile);
+        
+        if (currentName.endsWith('package.json'))
+            return [directoryName, currentFile];
+    }
+    
+    if (directoryName === '/')
+        return [];
+    
+    return findPackage(parentDirectory);
+}

package/lib/index.js

@@ -2,9 +2,6 @@ import * as applyExportFrom from './apply-export-from/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';
-import * as applyNamespaceImportToFile from './apply-namespace-import-to-file/index.js';
-import * as resolveImportedFile from './resolve-imported-file/index.js';
-import * as shortenImportedFile from './shorten-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';
@@ -14,6 +11,10 @@ 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 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';
 
 export const rules = {
     'add-index-to-import': ['off', addIndexToImport],
@@ -26,10 +27,12 @@ export const rules = {
     'remove-empty-import': removeEmptyImport,
     'remove-empty-export': removeEmptyExport,
     'sort-imports-by-specifiers': sortImportsBySpecifiers,
-    'resolve-imported-file': ['off', resolveImportedFile],
-    'shorten-imported-file': ['off', shortenImportedFile],
-    'apply-namespace-import-to-file': ['off', applyNamespaceImportToFile],
     'merge-declaration-with-export': mergeDeclarationWithExport,
     'remove-useless-export-specifiers': removeUselessExportSpecifiers,
     'merge-export-declarations': mergeExportDeclarations,
+    
+    'resolve-imported-file': ['off', resolveImportedFile],
+    'shorten-imported-file': ['off', shortenImportedFile],
+    'apply-namespace-import-to-file': ['off', applyNamespaceImportToFile],
+    'apply-privately-imported-file': ['off', applyPrivatelyImportedFile],
 };

package/package.json

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