@putout/plugin-nodejs 19.1.0 → 19.2.1

package/README.md

@@ -33,12 +33,16 @@ npm i putout @putout/plugin-nodejs -D
 - ✅ [group-require-by-id](#group-require-by-id);
 - ✅ [remove-process-exit](#remove-process-exit);
 - ✅ [remove-useless-promisify](#remove-useless-promisify);
-- ✅ [rename-file-cjs-to-js](#rename-file-cjs-to-js);
-- ✅ [rename-file-mjs-to-js](#rename-file-mjs-to-js);
 - ✅ [remove-useless-strict-mode](#remove-useless-strict-mode);
 - ✅ [remove-illegal-strict-mode](#remove-useless-strict-mode);
+
+## File rules
+
+- ✅ [apply-privately-imported-file](#apply-privately-imported-file);
 - ✅ [cjs-file](#cjs-file);
 - ✅ [mjs-file](#mjs-file);
+- ✅ [rename-file-cjs-to-js](#rename-file-cjs-to-js);
+- ✅ [rename-file-mjs-to-js](#rename-file-mjs-to-js);
 
 ## Config
 
@@ -587,6 +591,40 @@ export const readSize = promisify(async (dir, options, callback) => {});
 export const readSize = async (dir, options, callback) => {};
 ```
 
+#### apply-privately-required-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)
+
+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 "const {isPrev} = require('../is.js')"
+```
+
+In this case `spread-element.js` can be fixed:
+
+#### ❌ Example of incorrect code
+
+```js
+const {isPrev} = require('../is.js');
+```
+
+#### ✅ Example of correct code
+
+```js
+const {isPrev} = require('#is');
+```
+
 ## License
 
 MIT

package/lib/apply-privately-required-file/change-require/index.js

@@ -0,0 +1,11 @@
+export const report = () => '';
+export const replace = ({options}) => {
+    const {from = '', to = ''} = options;
+    
+    if (!from || !to)
+        return {};
+    
+    return {
+        [`require('${from}')`]: `require('${to}')`,
+    };
+};

package/lib/apply-privately-required-file/get-require/index.js

@@ -0,0 +1,28 @@
+import {types} from 'putout';
+
+const {isStringLiteral} = types;
+
+export const report = (path) => {
+    const [arg] = path.node.arguments;
+    return arg.value;
+};
+
+export const fix = () => {};
+
+export const include = () => [
+    'require(__a)',
+];
+
+export const filter = (path) => {
+    const [arg] = path.node.arguments;
+    
+    if (!isStringLiteral(arg))
+        return false;
+    
+    const {value} = arg;
+    
+    if (!value.startsWith('.'))
+        return false;
+    
+    return /\.[mc]?js/.test(value);
+};

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

@@ -0,0 +1,83 @@
+import {join, dirname} from 'node:path';
+import {
+    parse,
+    print,
+    transform,
+    operator,
+} from 'putout';
+import * as getImports from './get-require/index.js';
+import * as changeImports from './change-require/index.js';
+import {createGetPrivateImports} from './private-imports.js';
+
+const {
+    getFilename,
+    readFileContent,
+    writeFileContent,
+} = operator;
+
+const getMessage = (a) => a.message;
+
+export const report = (file, {from, to}) => `Apply privately required source: '${from}' -> '${to}'`;
+export const fix = (file, {content, ast, from, to}) => {
+    transform(ast, content, {
+        rules: {
+            'change-require': ['on', {
+                from,
+                to,
+            }],
+        },
+        plugins: [
+            ['change-require', changeImports],
+        ],
+    });
+    
+    const newContent = print(ast);
+    
+    writeFileContent(file, newContent);
+};
+
+export const scan = (rootPath, {push, trackFile}) => {
+    const mask = [
+        '*.js',
+        '*.cjs',
+    ];
+    
+    const getPrivateImports = createGetPrivateImports();
+    
+    for (const file of trackFile(rootPath, mask)) {
+        const content = readFileContent(file);
+        
+        if (!content.includes('require'))
+            continue;
+        
+        const privateImports = getPrivateImports(file);
+        
+        if (!privateImports.size)
+            continue;
+        
+        const ast = parse(content);
+        
+        const places = transform(ast, content, {
+            plugins: [
+                ['get-require', getImports],
+            ],
+        });
+        
+        const imports = places.map(getMessage);
+        
+        const filename = getFilename(file);
+        const dir = dirname(filename);
+        
+        for (const from of imports) {
+            const to = join(dir, from);
+            
+            if (privateImports.has(to))
+                push(file, {
+                    from,
+                    to: privateImports.get(to),
+                    content,
+                    ast,
+                });
+        }
+    }
+};

package/lib/apply-privately-required-file/private-imports.js

@@ -0,0 +1,81 @@
+import {dirname, resolve} from 'node:path';
+import {tryCatch} from 'try-catch';
+import {operator} from 'putout';
+
+const {
+    getFilename,
+    readFileContent,
+    findFileUp,
+} = operator;
+
+const {entries} = Object;
+const {parse: parseJson} = JSON;
+const isString = (a) => typeof a === 'string';
+
+function insert(a, b, {importsEntries, aliasBased}) {
+    if (aliasBased) {
+        importsEntries.set(b, a);
+        return;
+    }
+    
+    importsEntries.set(a, b);
+}
+
+export const createGetPrivateImports = (importsCache = new Map(), emptyMap = new Map()) => (file, options = {}) => {
+    const filename = getFilename(file);
+    const dir = dirname(filename);
+    const {aliasBased = false} = options;
+    
+    if (importsCache.has(dir))
+        return importsCache.get(dir);
+    
+    const [packageDirectory, packagePath] = findFileUp(file, 'package.json');
+    
+    if (!packagePath) {
+        importsCache.set(dir, emptyMap);
+        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, property] of entries(imports)) {
+        const filePath = parseProperty(property);
+        
+        if (!filePath)
+            continue;
+        
+        const resolvedPath = resolve(packageDirectory, filePath);
+        
+        insert(resolvedPath, alias, {
+            importsEntries,
+            aliasBased,
+        });
+    }
+    
+    importsCache.set(dir, importsEntries);
+    
+    return importsEntries;
+};
+
+function parseProperty(property) {
+    if (isString(property))
+        return property;
+    
+    const {
+        default: filePath,
+        node,
+        browser,
+    } = property;
+    
+    return filePath || node || browser;
+}

package/lib/index.js

@@ -1,3 +1,4 @@
+import * as applyPrivatelyRequiredFiles from './apply-privately-required-file/index.js';
 import * as convertBufferToBufferAlloc from './convert-buffer-to-buffer-alloc/index.js';
 import * as convertFsPromises from './convert-fs-promises/index.js';
 import * as convertPromisifyToFsPromises from './convert-promisify-to-fs-promises/index.js';
@@ -32,6 +33,7 @@ export const rules = {
     'add-node-prefix': addNodePrefix,
     'convert-exports-to-module-exports': convertExportsToModuleExports,
     
+    'apply-privately-required-files': ['off', applyPrivatelyRequiredFiles],
     'convert-esm-to-commonjs': ['off', convertEsmToCommonjs],
     'convert-commonjs-to-esm/exports': ['off', convertCommonjsToEsm.rules.exports],
     'convert-commonjs-to-esm/common': ['off', convertCommonjsToEsm.rules.commons],

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@putout/plugin-nodejs",
-  "version": "19.1.0",
+  "version": "19.2.1",
   "type": "module",
   "author": "coderaiser <mnemonic.enemy@gmail.com> (https://github.com/coderaiser)",
   "description": "🐊Putout plugin adds ability to transform code to new API of Node.js",
@@ -30,7 +30,8 @@
     "report": "madrun report"
   },
   "dependencies": {
-    "just-camel-case": "^6.2.0"
+    "just-camel-case": "^6.2.0",
+    "try-catch": "^4.0.7"
   },
   "keywords": [
     "putout",
@@ -39,7 +40,7 @@
     "nodejs"
   ],
   "devDependencies": {
-    "@putout/eslint-flat": "^3.0.0",
+    "@putout/eslint-flat": "^4.0.0",
     "@putout/plugin-declare": "*",
     "@putout/plugin-declare-before-reference": "*",
     "@putout/plugin-esm": "*",
@@ -50,7 +51,7 @@
     "c8": "^10.0.0",
     "eslint": "^10.0.0-alpha.0",
     "eslint-plugin-n": "^17.0.0",
-    "eslint-plugin-putout": "^29.0.0",
+    "eslint-plugin-putout": "^30.0.0",
     "madrun": "^12.0.0",
     "montag": "^1.2.1",
     "nodemon": "^3.0.1"