@putout/plugin-nodejs 2.0.1 → 3.2.0

package/README.md

@@ -1,7 +1,7 @@
 # @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"
+[NPMURL]: https://npmjs.org/package/@putout/plugin-nodejs "npm"
 
 🐊[`Putout`](https://github.com/coderaiser/putout) plugin adds ability to transform to new [nodejs.org](https://nodejs.io) API and best practices.
 
@@ -11,19 +11,24 @@
 npm i putout @putout/plugin-nodejs -D
 ```
 
-## Rules
+## Options
 
 ```json
 {
     "rules": {
         "nodejs/convert-fs-promises": "on",
         "nodejs/convert-promisify-to-fs-promises": "on",
-        "nodejs/convert-dirname-to-url": "on"
+        "nodejs/convert-dirname-to-url": "on",
+        "nodejs/convert-url-to-dirname": "on",
+        "nodejs/convert-top-level-return": "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:
 
@@ -31,38 +36,38 @@ Convert [fs.promises](https://nodejs.org/dist/latest-v15.x/docs/api/fs.html#fs_f
 import {readFile} from 'fs/promises';
 ```
 
-## ❌ Incorrect code example
+#### ❌ Example of incorrect code
 
 ```js
 const {readFile} = require('fs').promises;
 ```
 
-## ✅ Correct code Example
+#### ✅ Example of correct code
 
 ```js
 const {readFile} = require('fs/promises');
 ```
 
-# convert-promisify-to-fs-promises
+### convert-promisify-to-fs-promises
 
-## ❌ Incorrect code example
+#### ❌ Example of incorrect code
 
 ```js
 const fs = require('fs');
 const readFile = promisify(fs.readFile);
 ```
 
-## ✅ Correct code Example
+#### ✅ Example of correct code
 
 ```js
 const {readFile} = require('fs/promises');
 ```
 
-# convert-dirname-to-url
+### convert-dirname-to-url
 
 Only for `EcmaScript Modules`.
 
-## ❌ Incorrect code example
+#### ❌ Example of incorrect code
 
 ```js
 import {readFile} from 'fs/promises';
@@ -71,7 +76,7 @@ const file1 = join(__dirname, '../../package.json');
 const file2 = path.join(__dirname, '../../package.json');
 ```
 
-## ✅ Correct code Example
+#### ✅ Example of correct code
 
 ```js
 import {readFile} from 'fs/promises';
@@ -80,6 +85,46 @@ const file1 = new URL('../../package.json', import.meta.url);
 const file2 = new URL('../../package.json', import.meta.url);
 ```
 
+### convert-dirname-to-url
+
+Only for `CommonJS`.
+
+#### ❌ Example of incorrect code
+
+```js
+const {readFile} = require('fs/promises');
+const file = new URL('../../package.json', import.meta.url);
+```
+
+#### ✅ Example of correct code
+
+```js
+const {readFile} = require('fs/promises');
+const file = join(__dirname, '../../package.json');
+```
+
+### remove-process-exit
+
+In most cases `process.exit()` is called from `bin` directory, if not - disable this rule using `match`.
+
+```diff
+-process.exit();
+```
+
+### convert-top-level-return
+
+#### ❌ Example of incorrect code
+
+```js
+return;
+```
+
+#### ✅ Example of correct code
+
+```js
+process.exit();
+```
+
 ## License
 
 MIT

package/lib/convert-top-level-return/index.js

@@ -0,0 +1,15 @@
+'use strict';
+
+const {types} = require('putout');
+const {isFunction} = types;
+
+module.exports.report = () => `"process.exit" should be used instead of top-level return`;
+
+module.exports.filter = (path) => !path.findParent(isFunction);
+
+module.exports.replace = () => ({
+    'return __a()': '{__a(); process.exit()}',
+    'return __a': 'process.exit()',
+    'return': 'process.exit()',
+});
+

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

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

package/lib/index.js

@@ -8,5 +8,8 @@ module.exports.rules = {
     ...getRule('convert-fs-promises'),
     ...getRule('convert-promisify-to-fs-promises'),
     ...getRule('convert-dirname-to-url'),
+    ...getRule('convert-url-to-dirname'),
+    ...getRule('convert-top-level-return'),
+    ...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,6 +1,6 @@
 {
   "name": "@putout/plugin-nodejs",
-  "version": "2.0.1",
+  "version": "3.2.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",
@@ -31,17 +31,17 @@
     "nodejs"
   ],
   "devDependencies": {
-    "@putout/test": "^4.0.0",
+    "@putout/test": "^5.0.0",
     "c8": "^7.5.0",
     "eslint": "^8.0.1",
     "eslint-plugin-node": "^11.0.0",
-    "eslint-plugin-putout": "^12.0.0",
+    "eslint-plugin-putout": "^13.0.0",
     "lerna": "^4.0.0",
-    "madrun": "^8.0.1",
+    "madrun": "^9.0.0",
     "nodemon": "^2.0.1"
   },
   "peerDependencies": {
-    "putout": ">=23"
+    "putout": ">=24"
   },
   "license": "MIT",
   "engines": {