@putout/plugin-nodejs 9.1.3 → 9.3.0

package/README.md

@@ -22,6 +22,9 @@ npm i putout @putout/plugin-nodejs -D
     "rules": {
         "nodejs/convert-commonjs-to-esm": "off",
         "nodejs/convert-esm-to-commonjs": "off",
+        "nodejs/cjs-file": "off",
+        "nodejs/mjs-file": "off",
+        "nodejs/rename-file-cjs-to-js": "off",
         "nodejs/add-node-prefix": "on",
         "nodejs/convert-buffer-to-buffer-alloc": "on",
         "nodejs/convert-fs-promises": "on",
@@ -37,9 +40,7 @@ npm i putout @putout/plugin-nodejs -D
 }
 ```
 
-## Rules
-
-### add-node-prefix
+## add-node-prefix
 
 > `Deno` supports using Node.js built-in modules such as `fs`, `path`, `process`, and many more via `node`: specifiers.
 >
@@ -47,19 +48,19 @@ npm i putout @putout/plugin-nodejs -D
 
 Check out in 🐊[Putout Editor](https://putout.cloudcmd.io/#/gist/534093e0bf0a4407796c08d62bcbcb92/766a1d608f155920b21aa1f53a8e33280a664309).
 
-#### ❌ Example of incorrect code
+### ❌ Example of incorrect code
 
 ```js
 import fs from 'fs';
 ```
 
-#### ✅ Example of correct code
+### ✅ Example of correct code
 
 ```js
 import fs from 'node:fs';
 ```
 
-### convert-buffer-to-buffer-alloc
+## convert-buffer-to-buffer-alloc
 
 > The `Buffer()` function and `new Buffer()` constructor are **deprecated** due to API usability issues that can lead to accidental security issues.
 >
@@ -67,7 +68,7 @@ import fs from 'node:fs';
 
 Check out in 🐊[Putout Editor](https://putout.cloudcmd.io/#/gist/5379bcdfa3d76f7b7121c9671ae48375/2fc2c7f96fc8284788c00914a9b29bfeea8b13d4).
 
-#### ❌ Example of incorrect code
+### ❌ Example of incorrect code
 
 ```js
 const n = 100;
@@ -81,7 +82,7 @@ new Buffer([]);
 new Buffer(buf);
 ```
 
-#### ✅ Example of correct code
+### ✅ Example of correct code
 
 ```js
 const n = 100;
@@ -95,42 +96,42 @@ Buffer.from([]);
 Buffer.from(buf);
 ```
 
-### convert-fs-promises
+## convert-fs-promises
 
 Convert [fs.promises](https://nodejs.org/dist/latest-v15.x/docs/api/fs.html#fs_fs_promises_api) into form that will be simpler to use and convert to and from **ESM**.
 
-#### ❌ Example of incorrect code
+### ❌ Example of incorrect code
 
 ```js
 const {readFile} = require('fs').promises;
 ```
 
-#### ✅ Example of correct code
+### ✅ Example of correct code
 
 ```js
 const {readFile} = require('fs/promises');
 ```
 
-### convert-promisify-to-fs-promises
+## convert-promisify-to-fs-promises
 
-#### ❌ Example of incorrect code
+### ❌ Example of incorrect code
 
 ```js
 const fs = require('fs');
 const readFile = promisify(fs.readFile);
 ```
 
-#### ✅ Example of correct code
+### ✅ Example of correct code
 
 ```js
 const {readFile} = require('fs/promises');
 ```
 
-### convert-dirname-to-url
+## convert-dirname-to-url
 
 Only for **ESM**.
 
-#### ❌ Example of incorrect code
+### ❌ Example of incorrect code
 
 ```js
 const {join} = require('path');
@@ -140,25 +141,25 @@ const file1 = join(__dirname, '../../package.json');
 const file2 = path.join(__dirname, '../../package.json');
 ```
 
-#### ✅ Example of correct code
+### ✅ Example of correct code
 
 ```js
 const file1 = new URL('../../package.json', import.meta.url);
 const file2 = new URL('../../package.json', import.meta.url);
 ```
 
-### convert-url-to-dirname
+## convert-url-to-dirname
 
 Only for **CommonJS**.
 
-#### ❌ Example of incorrect code
+### ❌ Example of incorrect code
 
 ```js
 const {readFile} = require('fs/promises');
 const file = new URL('../../package.json', import.meta.url);
 ```
 
-#### ✅ Example of correct code
+### ✅ Example of correct code
 
 ```js
 const {readFile} = require('fs/promises');
@@ -166,7 +167,7 @@ const {join} = require('path');
 const file = join(__dirname, '../../package.json');
 ```
 
-### remove-process-exit
+## remove-process-exit
 
 In most cases `process.exit()` is called from `bin` directory, if not - disable this rule using `match`.
 
@@ -174,38 +175,38 @@ In most cases `process.exit()` is called from `bin` directory, if not - disable
 -process.exit();
 ```
 
-### convert-exports-to-module-exports
+## convert-exports-to-module-exports
 
 Since `exports = 5` wan't make any export, just change value of variable.
 Checkout in 🐊[**Putout Editor**](https://putout.cloudcmd.io/#/gist/8b2af2c4ad005ed1c77cde41377caaad/dfdccc794037d7f67bde1e7d7244bf5f14abebce).
 
-#### ❌ Example of incorrect code
+### ❌ Example of incorrect code
 
 ```js
 exports.x = 5;
 ```
 
-#### ✅ Example of correct code
+### ✅ Example of correct code
 
 ```js
 module.exports.x = 5;
 ```
 
-### convert-top-level-return
+## convert-top-level-return
 
-#### ❌ Example of incorrect code
+### ❌ Example of incorrect code
 
 ```js
 return;
 ```
 
-#### ✅ Example of correct code
+### ✅ Example of correct code
 
 ```js
 process.exit();
 ```
 
-### declare
+## declare
 
 Add declarations to built-in node.js modules:
 
@@ -223,13 +224,13 @@ Add declarations to built-in node.js modules:
 
 Based on [`@putout/operator-declare`](https://github.com/coderaiser/putout/tree/master/packages/operator-declare#putoutoperator-declare-).
 
-#### ❌ Example of incorrect code
+### ❌ Example of incorrect code
 
 ```js
 await readFile('hello.txt', 'utf8');
 ```
 
-#### ✅ Example of correct code
+### ✅ Example of correct code
 
 ```js
 import {readFile} from 'fs/promises';
@@ -249,7 +250,7 @@ When you want to skip some declaration use `dismiss`:
 }
 ```
 
-### declare-after-require
+## declare-after-require
 
 > **Node.js** follows the **CommonJS** module system, and the builtin `require` function is the easiest way to include modules that exist in separate files. The basic functionality of `require` is that it reads a JavaScript file, executes the file, and then proceeds to return the `exports` object.
 >
@@ -257,33 +258,31 @@ When you want to skip some declaration use `dismiss`:
 
 Check out in 🐊[**Putout Editor**](https://putout.cloudcmd.io/#/gist/https://putout.cloudcmd.io/#/gist/ddf5731ae829beec4d3018d4d9ac2150/342738b63337bfa9b4fc08c5b301483ea2b5ba9c).
 
-#### ❌ Example of incorrect code
+### ❌ Example of incorrect code
 
 ```js
 const name = 'hello.txt';
 const {readFile} = require('fs/promises');
 ```
 
-#### ✅ Example of correct code
+### ✅ Example of correct code
 
 ```js
 const {readFile} = require('fs/promises');
 const name = 'hello.txt';
 ```
 
-### convert-commonjs-to-esm
+## convert-commonjs-to-esm
 
 Convert **CommonJS** **EcmaScript Modules**.
 
-> **CommonJS** is a module system supported in Node, it provides a `require` function, which can be used to access the `exports` object exposed by another file.
->
 > **EcmaScript module** syntax is the standard way to import and export values between files in **JavaScript**. The `import` statement can be used to reference a value exposed by the `export` statement in another file.
 >
 > (c) [parceljs](https://parceljs.org/languages/javascript/)
 
-#### require
+### require
 
-##### ❌ Example of incorrect code
+### ❌ Example of incorrect code
 
 ```js
 const {join} = require('path');
@@ -293,7 +292,7 @@ const args = require('minimist')({
 });
 ```
 
-##### ✅ Example of correct code
+### ✅ Example of correct code
 
 ```js
 import {join} from 'path';
@@ -304,23 +303,23 @@ const args = minimist({
 });
 ```
 
-#### exports
+### exports
 
-##### ❌ Example of incorrect code
+### ❌ Example of incorrect code
 
 ```js
 module.exports = () => {};
 ```
 
-##### ✅ Example of correct code
+### ✅ Example of correct code
 
 ```js
 export default () => {};
 ```
 
-#### Commons
+### Commons
 
-##### ❌ Example of incorrect code
+### ❌ Example of incorrect code
 
 ```js
 const {readFile} = require('fs/promises');
@@ -328,7 +327,7 @@ const {readFile} = require('fs/promises');
 await readFile(__filename);
 ```
 
-##### ✅ Example of correct code
+### ✅ Example of correct code
 
 ```js
 import {readFile} from 'fs/promises';
@@ -338,31 +337,65 @@ const __filename = fileURLToPath(import.meta.url);
 await readFile(__filename);
 ```
 
-### convert-esm-to-commonjs
+## convert-esm-to-commonjs
 
-> **EcmaScript module** syntax is the standard way to import and export values between files in **JavaScript**. The `import` statement can be used to reference a value exposed by the `export` statement in another file.
->
 > **CommonJS** is a module system supported in Node, it provides a `require` function, which can be used to access the `exports` object exposed by another file.
 >
 > (c) [parceljs](https://parceljs.org/languages/javascript/)
 
 Convert **EcmaScript Modules** to **CommonJS**.
 
-## ❌ Example of incorrect code
+### ❌ Example of incorrect code
 
 ```js
 import hello from 'world';
 ```
 
-## ✅ Example of correct code
+### ✅ Example of correct code
 
 ```js
 const hello = require('world');
 ```
 
-## License
+## cjs-file
 
-MIT
+Run [convert-esm-to-commonjs](#convert-esm-to-commonjs) for all `*.cjs` files with help of [redlint](https://github.com/putoutjs/redlint).
+
+Check out in 🐊[Putout Editor](https://putout.cloudcmd.io/#/gist/779e7fb720af59afc2d3da082088fd4c/d0b85b07c6aaf2b902a1c7eb7ae121dbcd181033).
+
+## mjs-file
+
+Run [convert-commonjs-to-esm](#convert-commonjs-to-esm) for all `*.cjs` files with help of [redlint](https://github.com/putoutjs/redlint).
+
+Check out in 🐊[Putout Editor](https://putout.cloudcmd.io/#/gist/779e7fb720af59afc2d3da082088fd4c/d0b85b07c6aaf2b902a1c7eb7ae121dbcd181033).
+
+## rename-file-cjs-to-js
+
+Rename `*.cjs` files when `module !== "module"`:
+
+```diff
+ /
+ |-- package.json
+ `-- lib/
+-     `-- hello.cjs
++     `-- hello.js
+```
+
+Check out in 🐊[Putout Editor](https://putout.cloudcmd.io/#/gist/8d8f3cd6662b70abbd5e4a2e4835077f/e43319fd63291ec3a5028b30a83f3c91fe90325e).
+
+## rename-file-mjs-to-js
+
+Rename `*.mjs` files when `module === "module"`:
+
+```diff
+ /
+ |-- package.json
+ `-- lib/
+-     `-- hello.mjs
++     `-- hello.js
+```
+
+Check out in 🐊[Putout Editor](https://putout.cloudcmd.io/#/gist/94fb3298b210e703b01db9a6826942bc/dfe2462451c6b3d4d47da7fd8d39dc8e53bb16eb).
 
 ## License
 

package/lib/cjs-file/index.js

@@ -0,0 +1,10 @@
+'use strict';
+
+const {operator} = require('putout');
+const plugin = require('../convert-esm-to-commonjs');
+
+const {matchFiles} = operator;
+
+module.exports = matchFiles({
+    '*.cjs': plugin,
+});

package/lib/index.js

@@ -18,6 +18,12 @@ const convertCommonjsToEsmExports = require('./convert-commonjs-to-esm-exports')
 const convertCommonjsToEsmCommons = require('./convert-commonjs-to-esm-commons');
 const convertCommonjsToEsmRequire = require('./convert-commonjs-to-esm-require');
 
+const cjsFile = require('./cjs-file');
+const mjsFile = require('./mjs-file');
+
+const renameFileCjsToJs = require('./rename-file-cjs-to-js');
+const renameFileMjsToJs = require('./rename-file-mjs-to-js');
+
 module.exports.rules = {
     'convert-buffer-to-buffer-alloc': convertBufferToBufferAlloc,
     'convert-fs-promises': convertFsPromises,
@@ -35,4 +41,8 @@ module.exports.rules = {
     'convert-commonjs-to-esm-exports': ['off', convertCommonjsToEsmExports],
     'convert-commonjs-to-esm-common': ['off', convertCommonjsToEsmCommons],
     'convert-commonjs-to-esm-require': ['off', convertCommonjsToEsmRequire],
+    'cjs-file': ['off', cjsFile],
+    'mjs-file': ['off', mjsFile],
+    'rename-file-cjs-to-js': ['off', renameFileCjsToJs],
+    'rename-file-mjs-to-js': renameFileMjsToJs,
 };

package/lib/mjs-file/index.js

@@ -0,0 +1,10 @@
+'use strict';
+
+const {operator} = require('putout');
+const plugin = require('../convert-commonjs-to-esm');
+
+const {matchFiles} = operator;
+
+module.exports = matchFiles({
+    '*.mjs': plugin,
+});

package/lib/rename-file-cjs-to-js/index.js

@@ -0,0 +1,68 @@
+'use strict';
+
+const {operator} = require('putout');
+const {join} = require('path');
+const {parse} = JSON;
+
+const {
+    getParentDirectory,
+    getFilename,
+    readFileContent,
+    findFile,
+    __filesystem,
+    renameFile,
+} = operator;
+
+module.exports.report = ({cjs, js}) => `Rename '${cjs}' to '${js}'`;
+
+module.exports.fix = ({path, js}) => {
+    renameFile(path, js);
+};
+
+module.exports.traverse = ({push}) => ({
+    [__filesystem]: (path) => {
+        for (const file of findFile(path, '*.cjs')) {
+            const packagePath = findUpPackage(file);
+            
+            const cjs = getFilename(file);
+            const js = cjs.replace(/cjs$/, 'js');
+            
+            if (!packagePath) {
+                push({
+                    path: file,
+                    cjs,
+                    js,
+                });
+                continue;
+            }
+            
+            const packageContent = readFileContent(packagePath);
+            
+            if (!packageContent)
+                continue;
+            
+            const {type} = parse(packageContent);
+            
+            if (type === 'module')
+                continue;
+            
+            push({
+                path: file,
+                cjs,
+                js,
+            });
+        }
+    },
+});
+
+function findUpPackage(file) {
+    let packageJSON;
+    let dirPath = getParentDirectory(file);
+    
+    do {
+        const dir = getFilename(dirPath);
+        [packageJSON] = findFile(dirPath, join(dir, 'package.json'));
+    } while (!packageJSON && (dirPath = getParentDirectory(dirPath)));
+    
+    return packageJSON;
+}

package/lib/rename-file-mjs-to-js/index.js

@@ -0,0 +1,62 @@
+'use strict';
+
+const {operator} = require('putout');
+const {join} = require('path');
+
+const {parse} = JSON;
+const {
+    getParentDirectory,
+    getFilename,
+    readFileContent,
+    findFile,
+    __filesystem,
+    renameFile,
+} = operator;
+
+module.exports.report = ({mjs, js}) => `Rename '${mjs}' to '${js}'`;
+
+module.exports.fix = ({path, js}) => {
+    renameFile(path, js);
+};
+
+module.exports.traverse = ({push}) => ({
+    [__filesystem]: (path) => {
+        for (const file of findFile(path, '*.mjs')) {
+            const packagePath = findUpPackage(file);
+            
+            if (!packagePath)
+                continue;
+            
+            const packageContent = readFileContent(packagePath);
+            
+            if (!packageContent)
+                continue;
+            
+            const {type} = parse(packageContent);
+            
+            if (type !== 'module')
+                continue;
+            
+            const mjs = getFilename(file);
+            const js = mjs.replace(/mjs$/, 'js');
+            
+            push({
+                path: file,
+                mjs,
+                js,
+            });
+        }
+    },
+});
+
+function findUpPackage(file) {
+    let packageJSON;
+    let dirPath = getParentDirectory(file);
+    
+    do {
+        const dir = getFilename(dirPath);
+        [packageJSON] = findFile(dirPath, join(dir, 'package.json'));
+    } while (!packageJSON && (dirPath = getParentDirectory(dirPath)));
+    
+    return packageJSON;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@putout/plugin-nodejs",
-  "version": "9.1.3",
+  "version": "9.3.0",
   "type": "commonjs",
   "author": "coderaiser <mnemonic.enemy@gmail.com> (https://github.com/coderaiser)",
   "description": "🐊Putout plugin adds ability to transform code to new API of Node.js",