@putout/plugin-nodejs 1.0.0 → 3.0.0

package/README.md

@@ -1,12 +1,9 @@
-# @putout/plugin-nodejs [![NPM version][NPMIMGURL]][NPMURL] [![Dependency Status][DependencyStatusIMGURL]][DependencyStatusURL]
+# @putout/plugin-nodejs [![NPM version][NPMIMGURL]][NPMURL]
 
-[NPMIMGURL]:                https://img.shields.io/npm/v/@putout/plugin-nodejs.svg?style=flat&longCache=true
-[NPMURL]:                   https://npmjs.org/package/@putout/plugin-nodejs"npm"
+[NPMIMGURL]: https://img.shields.io/npm/v/@putout/plugin-nodejs.svg?style=flat&longCache=true
+[NPMURL]: https://npmjs.org/package/@putout/plugin-nodejs"npm"
 
-[DependencyStatusURL]:      https://david-dm.org/coderaiser/putout?path=packages/plugin-nodejs
-[DependencyStatusIMGURL]:   https://david-dm.org/coderaiser/putout.svg?path=packages/plugin-nodejs
-
-`putout` plugin adds ability to transform to new [nodejs.org](https://nodejs.io) API and best practices.
+🐊[`Putout`](https://github.com/coderaiser/putout) plugin adds ability to transform to new [nodejs.org](https://nodejs.io) API and best practices.
 
 ## Install
 
@@ -14,17 +11,22 @@
 npm i putout @putout/plugin-nodejs -D
 ```
 
-## Rules
+## Options
 
 ```json
 {
     "rules": {
-        "nodejs/convert-fs-promises": "on"
+        "nodejs/convert-fs-promises": "on",
+        "nodejs/convert-promisify-to-fs-promises": "on",
+        "nodejs/convert-dirname-to-url": "on",
+        "nodejs/remove-process-exit": "on"
     }
 }
 ```
 
-# convert-fs-promises
+## Rules
+
+### 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 from in `ESM` to:
 
@@ -32,19 +34,72 @@ Convert [fs.promises](https://nodejs.org/dist/latest-v15.x/docs/api/fs.html#fs_f
 import {readFile} from 'fs/promises';
 ```
 
-## ❌ Incorrect code example
+#### ❌ Incorrect code example
 
 ```js
 const {readFile} = require('fs').promises;
 ```
 
-## ✅ Correct code Example
+#### ✅ Correct code Example
 
 ```js
 const {readFile} = require('fs/promises');
 ```
 
+### convert-promisify-to-fs-promises
+
+#### ❌ Incorrect code example
+
+```js
+const fs = require('fs');
+const readFile = promisify(fs.readFile);
+```
+
+#### ✅ Correct code Example
+
+```js
+const {readFile} = require('fs/promises');
+```
+
+### convert-dirname-to-url
+
+Only for `EcmaScript Modules`.
+
+#### ❌ Incorrect code example
+
+```js
+import {readFile} from 'fs/promises';
+
+const file1 = join(__dirname, '../../package.json');
+const file2 = path.join(__dirname, '../../package.json');
+```
+
+#### ✅ Correct code Example
+
+```js
+import {readFile} from 'fs/promises';
+
+const file1 = new URL('../../package.json', import.meta.url);
+const file2 = new URL('../../package.json', import.meta.url);
+```
+
+### convert-promisify-to-fs-promises
+
+#### ❌ Incorrect code example
+
+```js
+const fs = require('fs');
+const readFile = promisify(fs.readFile);
+```
+
+### remove-process-exit
+
+In most cases `process.exit()` is called from `bin` directory, if not - disable this rule using `match`.
+
+```diff
+-process.exit();
+```
+
 ## License
 
 MIT
-

package/lib/convert-dirname-to-url/index.js

@@ -0,0 +1,13 @@
+'use strict';
+
+const {operator} = require('putout');
+const {isESM} = operator;
+
+module.exports.report = () => `Use 'import.meta.url' instead of '__dirname'`;
+
+module.exports.filter = isESM;
+
+module.exports.replace = () => ({
+    'join(__dirname, __a)': 'new URL(__a, import.meta.url).pathname',
+    'path.join(__dirname, __a)': 'new URL(__a, import.meta.url).pathname',
+});

package/lib/convert-fs-promises/index.js

@@ -1,4 +1,4 @@
-const {StringLiteral, RegExpLiteral} = require('putout').types;
+'use strict';
 
 module.exports.report = () => '"fs/promises" should be used instead of "fs.promises"';
 

package/lib/convert-promisify-to-fs-promises/index.js

@@ -0,0 +1,58 @@
+'use strict';
+
+const {
+    types: t,
+    operator,
+} = require('putout');
+
+const {replaceWith} = operator;
+
+const NOT_COMPUTED = false;
+const SHORTHAND = true;
+
+module.exports.report = () => `fs.promises should be used instead of fs`;
+
+module.exports.fix = ({path, promisified}) => {
+    const props = [];
+    
+    for (const path of promisified) {
+        const [declarator] = path.node.declarations;
+        const {name} = declarator.id;
+        
+        props.push(t.ObjectProperty(t.Identifier(name), t.Identifier(name), NOT_COMPUTED, SHORTHAND));
+        path.remove();
+    }
+    
+    const {init} = path.node;
+    init.arguments[0].value = 'fs/promises';
+    
+    replaceWith(path.get('id'), t.ObjectPattern(props));
+};
+
+module.exports.find = (ast, {push, traverse}) => {
+    const fs = [];
+    const promisified = [];
+    
+    traverse(ast, {
+        'const fs = require("fs")'(path) {
+            fs.push(path);
+        },
+        'const __ = promisify(fs.__)'(path) {
+            promisified.push(path);
+        },
+    });
+    
+    const [fsPath] = fs;
+    
+    if (!fsPath)
+        return;
+    
+    if (!promisified.length)
+        return;
+    
+    push({
+        path: fsPath.get('declarations.0'),
+        promisified,
+    });
+};
+

package/lib/index.js

@@ -6,5 +6,8 @@ const getRule = (a) => ({
 
 module.exports.rules = {
     ...getRule('convert-fs-promises'),
+    ...getRule('convert-promisify-to-fs-promises'),
+    ...getRule('convert-dirname-to-url'),
+    ...getRule('remove-process-exit'),
 };
 

package/lib/remove-process-exit/index.js

@@ -0,0 +1,9 @@
+'use strict';
+
+module.exports.report = () => '"process.exit" should not be used';
+
+module.exports.replace = () => ({
+    'process.exit()': '',
+    'process["exit"]()': '',
+});
+

package/package.json

@@ -1,9 +1,10 @@
 {
   "name": "@putout/plugin-nodejs",
-  "version": "1.0.0",
+  "version": "3.0.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",
-  "homepage": "http://github.com/coderaiser/putout",
+  "homepage": "https://github.com/coderaiser/putout/tree/master/packages/plugin-nodejs#readme",
   "main": "lib/index.js",
   "release": false,
   "tag": false,
@@ -30,20 +31,17 @@
     "nodejs"
   ],
   "devDependencies": {
-    "@putout/plugin-remove-unused-expressions": "^1.2.1",
-    "@putout/plugin-strict-mode": "^1.2.1",
-    "@putout/test": "^3.0.0",
-    "coveralls": "^3.0.0",
-    "eslint": "^7.6.0",
+    "@putout/test": "^4.0.0",
+    "c8": "^7.5.0",
+    "eslint": "^8.0.1",
     "eslint-plugin-node": "^11.0.0",
-    "eslint-plugin-putout": "^6.0.0",
-    "lerna": "^3.8.5",
+    "eslint-plugin-putout": "^12.0.0",
+    "lerna": "^4.0.0",
     "madrun": "^8.0.1",
-    "nodemon": "^2.0.1",
-    "nyc": "^15.0.1"
+    "nodemon": "^2.0.1"
   },
   "peerDependencies": {
-    "putout": ">=13"
+    "putout": ">=24"
   },
   "license": "MIT",
   "engines": {