@putout/plugin-nodejs 4.3.0 → 4.6.0

package/README.md

@@ -25,6 +25,7 @@ npm i putout @putout/plugin-nodejs -D
         "nodejs/convert-dirname-to-url": "on",
         "nodejs/convert-url-to-dirname": "on",
         "nodejs/convert-top-level-return": "on",
+        "nodejs/declare-after-require": "on",
         "nodejs/remove-process-exit": "on"
     }
 }
@@ -129,16 +130,17 @@ process.exit();
 
 Add declarations to built-in node.js modules:
 
-- [child_process](https://nodejs.org/dist/latest-v16.x/docs/api/child_process.html);
-- [fs](https://nodejs.org/dist/latest-v16.x/docs/api/fs.html);
-- [path](https://nodejs.org/dist/latest-v16.x/docs/api/path.html);
-- [process](https://nodejs.org/dist/latest-v16.x/docs/api/process.html);
-- [module](https://nodejs.org/dist/latest-v16.x/docs/api/module.html);
-- [stream](https://nodejs.org/dist/latest-v16.x/docs/api/stream.html);
-- [os](https://nodejs.org/dist/latest-v16.x/docs/api/os.html);
-- [url](https://nodejs.org/dist/latest-v16.x/docs/api/url.html);
-- [util](https://nodejs.org/dist/latest-v16.x/docs/api/util.html);
-- [zlib](https://nodejs.org/dist/latest-v16.x/docs/api/zlib.html);
+- [child_process](https://nodejs.org/dist/latest-v18.x/docs/api/child_process.html);
+- [events](https://nodejs.org/dist/latest-v18.x/docs/api/events.html);
+- [fs](https://nodejs.org/dist/latest-v18.x/docs/api/fs.html);
+- [path](https://nodejs.org/dist/latest-v18.x/docs/api/path.html);
+- [process](https://nodejs.org/dist/latest-v18.x/docs/api/process.html);
+- [module](https://nodejs.org/dist/latest-v18.x/docs/api/module.html);
+- [stream](https://nodejs.org/dist/latest-v18.x/docs/api/stream.html);
+- [os](https://nodejs.org/dist/latest-v18.x/docs/api/os.html);
+- [url](https://nodejs.org/dist/latest-v18.x/docs/api/url.html);
+- [util](https://nodejs.org/dist/latest-v18.x/docs/api/util.html);
+- [zlib](https://nodejs.org/dist/latest-v18.x/docs/api/zlib.html);
 
 #### ❌ Example of incorrect code
 
@@ -153,6 +155,28 @@ import {readFile} from 'fs/promises';
 await readFile('hello.txt', 'utf8');
 ```
 
+### 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.
+>
+> (c) [Nodejs.org](https://nodejs.org/en/knowledge/getting-started/what-is-require/)
+
+Check out in 🐊[**Putout Editor**](https://putout.cloudcmd.io/#/gist/https://putout.cloudcmd.io/#/gist/ddf5731ae829beec4d3018d4d9ac2150/342738b63337bfa9b4fc08c5b301483ea2b5ba9c).
+
+#### ❌ Example of incorrect code
+
+```js
+const name = 'hello.txt';
+const {readFile} = require('fs/promises');
+```
+
+#### ✅ Example of correct code
+
+```js
+const {readFile} = require('fs/promises');
+const name = 'hello.txt';
+```
+
 ## License
 
 MIT

package/lib/declare/index.js

@@ -4,6 +4,7 @@ const {operator} = require('putout');
 const {declare} = operator;
 
 module.exports = declare({
+    ...require('./modules/events'),
     ...require('./modules/fs'),
     ...require('./modules/fs-promises'),
     ...require('./modules/path'),

package/lib/declare/modules/events.json

@@ -0,0 +1,12 @@
+{
+    "once": "import {once} from 'events'",
+    "on": "import {on} from 'events'",
+    "getEventListeners": "import {getEventListeners} from 'events'",
+    "EventEmitter": "import {EventEmitter} from 'events'",
+    "captureRejectionSymbol": "import {captureRejectionSymbol} from 'events'",
+    "captureRejections": "import {captureRejections} from 'events'",
+    "EventEmitterAsyncResource": "import {EventEmitterAsyncResource} from 'events'",
+    "defaultMaxListeners": "import {defaultMaxListeners} from 'events'",
+    "setMaxListeners": "import {setMaxListeners} from 'events'",
+    "listenerCount": "import {listenerCount} from 'events'"
+}

package/lib/declare-after-require/index.js

@@ -0,0 +1,122 @@
+'use strict';
+
+const {operator} = require('putout');
+
+const {
+    remove,
+    compareAny,
+} = operator;
+
+const REQUIRE_LIST = [
+    'const __a = require(__b)',
+    'const __a = require(__b)(__args)',
+    'const __a = require(__b).__c',
+];
+
+module.exports.report = ({path}) => {
+    const idPath = path.get('declarations.0.id');
+    const id = String(idPath).replace(/\s+/g, '');
+    
+    return `Declare '${id}' after last 'require()'`;
+};
+
+module.exports.fix = ({path, firstRequire, lastRequire}) => {
+    const {node} = path;
+    const {comments} = path.node;
+    
+    delete node.loc;
+    node.__putoutNodeDeclareAfterRequire = true;
+    
+    if (comments) {
+        firstRequire.node.comments = comments;
+        delete path.node.comments;
+    }
+    
+    remove(path);
+    lastRequire.insertAfter(node);
+};
+
+module.exports.traverse = ({push, listStore}) => ({
+    'const __a = __b': (path) => {
+        if (!path.parentPath.isProgram())
+            return;
+        
+        listStore(path);
+    },
+    'Program': {
+        exit() {
+            const requirePaths = [];
+            const constPaths = [];
+            
+            for (const path of listStore()) {
+                if (!path.node)
+                    continue;
+                
+                if (path.node.__putoutNodeDeclareAfterRequire)
+                    continue;
+                
+                if (path.node.declarations[0].id.name === 'require')
+                    continue;
+                
+                if (compareAny(path, REQUIRE_LIST)) {
+                    requirePaths.push(path);
+                    continue;
+                }
+                
+                constPaths.push(path);
+            }
+            
+            if (!requirePaths.length)
+                return;
+            
+            const firstRequire = requirePaths.at(0);
+            const lastRequire = requirePaths.at(-1);
+            
+            if (!lastRequire.node.loc)
+                return;
+            
+            const lastRequireLine = lastRequire.node.loc.start.line;
+            
+            for (const path of constPaths) {
+                const {loc} = path.node;
+                const line = !loc ? 0 : loc.start.line;
+                
+                if (line < lastRequireLine && lastRequireLine < getReferenceLine(path)) {
+                    push({
+                        path,
+                        firstRequire,
+                        lastRequire,
+                    });
+                }
+            }
+        },
+    },
+});
+
+function getName(path) {
+    const idPath = path.get('declarations.0.id');
+    
+    if (idPath.isIdentifier())
+        return idPath.node.name;
+    
+    if (idPath.isObjectPattern() && idPath.node.properties.length)
+        return idPath.node.properties[0].key.name;
+    
+    return null;
+}
+
+function getReferenceLine(path) {
+    const name = getName(path);
+    const binding = path.scope.bindings[name];
+    
+    if (!binding)
+        return -1;
+    
+    const {referencePaths} = binding;
+    
+    if (!referencePaths.length)
+        return Infinity;
+    
+    return referencePaths[0].node.loc.start.line;
+}
+

package/lib/index.js

@@ -11,6 +11,7 @@ module.exports.rules = {
     ...getRule('convert-url-to-dirname'),
     ...getRule('convert-top-level-return'),
     ...getRule('declare'),
+    ...getRule('declare-after-require'),
     ...getRule('remove-process-exit'),
 };
 

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "@putout/plugin-nodejs",
-  "version": "4.3.0",
+  "version": "4.6.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",
+  "description": "🐊Putout plugin adds ability to transform code to new API of Node.js",
   "homepage": "https://github.com/coderaiser/putout/tree/master/packages/plugin-nodejs#readme",
   "main": "lib/index.js",
   "release": false,
@@ -31,12 +31,14 @@
     "nodejs"
   ],
   "devDependencies": {
+    "@putout/plugin-convert-esm-to-commonjs": "*",
+    "@putout/plugin-putout": "*",
     "@putout/test": "^5.0.0",
     "c8": "^7.5.0",
     "eslint": "^8.0.1",
     "eslint-plugin-node": "^11.0.0",
-    "eslint-plugin-putout": "^14.0.0",
-    "lerna": "^4.0.0",
+    "eslint-plugin-putout": "^15.0.0",
+    "lerna": "^5.0.0",
     "madrun": "^9.0.0",
     "montag": "^1.2.1",
     "nodemon": "^2.0.1"