@putout/plugin-nodejs 3.2.0 → 4.1.0

package/README.md

@@ -3,7 +3,7 @@
 [NPMIMGURL]: https://img.shields.io/npm/v/@putout/plugin-nodejs.svg?style=flat&longCache=true
 [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.
+🐊[**Putout**](https://github.com/coderaiser/putout) plugin adds ability to transform to new [nodejs](https://nodejs.org/en/) API and apply best practices.
 
 ## Install
 
@@ -32,10 +32,6 @@ npm i putout @putout/plugin-nodejs -D
 
 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:
 
-```
-import {readFile} from 'fs/promises';
-```
-
 #### ❌ Example of incorrect code
 
 ```js
@@ -125,6 +121,34 @@ return;
 process.exit();
 ```
 
+### declare
+
+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);
+
+#### ❌ Example of incorrect code
+
+```js
+await readFile('hello.txt', 'utf8');
+```
+
+#### ✅ Example of correct code
+
+```js
+import {readFile} from 'fs/promises';
+await readFile('hello.txt', 'utf8');
+```
+
 ## License
 
 MIT

package/lib/declare/index.js

@@ -0,0 +1,19 @@
+'use strict';
+
+const {operator} = require('putout');
+const {declare} = operator;
+
+module.exports = declare({
+    ...require('./modules/fs'),
+    ...require('./modules/fs-promises'),
+    ...require('./modules/path'),
+    ...require('./modules/process'),
+    ...require('./modules/module'),
+    ...require('./modules/stream'),
+    ...require('./modules/os'),
+    ...require('./modules/zlib'),
+    ...require('./modules/url'),
+    ...require('./modules/util'),
+    ...require('./modules/child_process'),
+});
+

package/lib/declare/modules/child_process.json

@@ -0,0 +1,9 @@
+{
+    "exec": "import {exec} from 'child_process'",
+    "execFile": "import {execFile} from 'child_process'",
+    "execFileSync": "import {execFileSync} from 'child_process'",
+    "execSync": "import {execSync} from 'child_process'",
+    "fork": "import {fork} from 'child_process'",
+    "spawn": "import {spawn} from 'child_process'",
+    "spawnSync": "import {spawnSync} from 'child_process'"
+}

package/lib/declare/modules/fs-promises.json

@@ -0,0 +1,31 @@
+{
+    "access": "import {access} from 'fs/promises'",
+    "copyFile": "import {copyFile} from 'fs/promises'",
+    "cp": "import {cp} from 'fs/promises'",
+    "open": "import {open} from 'fs/promises'",
+    "opendir": "import {opendir} from 'fs/promises'",
+    "rename": "import {rename} from 'fs/promises'",
+    "truncate": "import {truncate} from 'fs/promises'",
+    "rm": "import {rm} from 'fs/promises'",
+    "rmdir": "import {rmdir} from 'fs/promises'",
+    "mkdir": "import {mkdir} from 'fs/promises'",
+    "readdir": "import {readdir} from 'fs/promises'",
+    "readlink": "import {readlink} from 'fs/promises'",
+    "symlink": "import {symlink} from 'fs/promises'",
+    "lstat": "import {lstat} from 'fs/promises'",
+    "stat": "import {stat} from 'fs/promises'",
+    "link": "import {link} from 'fs/promises'",
+    "unlink": "import {unlink} from 'fs/promises'",
+    "chmod": "import {chmod} from 'fs/promises'",
+    "lchmod": "import {lchmod} from 'fs/promises'",
+    "lchown": "import {lchown} from 'fs/promises'",
+    "chown": "import {chown} from 'fs/promises'",
+    "utimes": "import {utimes} from 'fs/promises'",
+    "lutimes": "import {lutimes} from 'fs/promises'",
+    "realpath": "import {realpath} from 'fs/promises'",
+    "mkdtemp": "import {mkdtemp} from 'fs/promises'",
+    "writeFile": "import {writeFile} from 'fs/promises'",
+    "appendFile": "import {appendFile} from 'fs/promises'",
+    "readFile": "import {readFile} from 'fs/promises'",
+    "watch": "import {watch} from 'fs/promises'"
+}

package/lib/declare/modules/fs.json

@@ -0,0 +1,100 @@
+{
+    "appendFile": "import {appendFile} from 'fs'",
+    "appendFileSync": "import {appendFileSync} from 'fs'",
+    "access": "import {access} from 'fs'",
+    "accessSync": "import {accessSync} from 'fs'",
+    "chown": "import {chown} from 'fs'",
+    "chownSync": "import {chownSync} from 'fs'",
+    "chmod": "import {chmod} from 'fs'",
+    "chmodSync": "import {chmodSync} from 'fs'",
+    "close": "import {close} from 'fs'",
+    "closeSync": "import {closeSync} from 'fs'",
+    "copyFile": "import {copyFile} from 'fs'",
+    "copyFileSync": "import {copyFileSync} from 'fs'",
+    "cp": "import {cp} from 'fs'",
+    "cpSync": "import {cpSync} from 'fs'",
+    "createReadStream": "import {createReadStream} from 'fs'",
+    "createWriteStream": "import {createWriteStream} from 'fs'",
+    "exists": "import {exists} from 'fs'",
+    "existsSync": "import {existsSync} from 'fs'",
+    "fchown": "import {fchown} from 'fs'",
+    "fchownSync": "import {fchownSync} from 'fs'",
+    "fchmod": "import {fchmod} from 'fs'",
+    "fchmodSync": "import {fchmodSync} from 'fs'",
+    "fdatasync": "import {fdatasync} from 'fs'",
+    "fdatasyncSync": "import {fdatasyncSync} from 'fs'",
+    "fstat": "import {fstat} from 'fs'",
+    "fstatSync": "import {fstatSync} from 'fs'",
+    "fsync": "import {fsync} from 'fs'",
+    "fsyncSync": "import {fsyncSync} from 'fs'",
+    "ftruncate": "import {ftruncate} from 'fs'",
+    "ftruncateSync": "import {ftruncateSync} from 'fs'",
+    "futimes": "import {futimes} from 'fs'",
+    "futimesSync": "import {futimesSync} from 'fs'",
+    "lchown": "import {lchown} from 'fs'",
+    "lchownSync": "import {lchownSync} from 'fs'",
+    "lchmod": "import {lchmod} from 'fs'",
+    "lchmodSync": "import {lchmodSync} from 'fs'",
+    "link": "import {link} from 'fs'",
+    "linkSync": "import {linkSync} from 'fs'",
+    "lstat": "import {lstat} from 'fs'",
+    "lstatSync": "import {lstatSync} from 'fs'",
+    "lutimes": "import {lutimes} from 'fs'",
+    "lutimesSync": "import {lutimesSync} from 'fs'",
+    "mkdir": "import {mkdir} from 'fs'",
+    "mkdirSync": "import {mkdirSync} from 'fs'",
+    "mkdtemp": "import {mkdtemp} from 'fs'",
+    "mkdtempSync": "import {mkdtempSync} from 'fs'",
+    "open": "import {open} from 'fs'",
+    "openSync": "import {openSync} from 'fs'",
+    "opendir": "import {opendir} from 'fs'",
+    "opendirSync": "import {opendirSync} from 'fs'",
+    "readdir": "import {readdir} from 'fs'",
+    "readdirSync": "import {readdirSync} from 'fs'",
+    "read": "import {read} from 'fs'",
+    "readSync": "import {readSync} from 'fs'",
+    "readv": "import {readv} from 'fs'",
+    "readvSync": "import {readvSync} from 'fs'",
+    "readFile": "import {readFile} from 'fs'",
+    "readFileSync": "import {readFileSync} from 'fs'",
+    "readlink": "import {readlink} from 'fs'",
+    "readlinkSync": "import {readlinkSync} from 'fs'",
+    "realpath": "import {realpath} from 'fs'",
+    "realpathSync": "import {realpathSync} from 'fs'",
+    "rename": "import {rename} from 'fs'",
+    "renameSync": "import {renameSync} from 'fs'",
+    "rm": "import {rm} from 'fs'",
+    "rmSync": "import {rmSync} from 'fs'",
+    "rmdir": "import {rmdir} from 'fs'",
+    "rmdirSync": "import {rmdirSync} from 'fs'",
+    "stat": "import {stat} from 'fs'",
+    "statSync": "import {statSync} from 'fs'",
+    "symlink": "import {symlink} from 'fs'",
+    "symlinkSync": "import {symlinkSync} from 'fs'",
+    "truncate": "import {truncate} from 'fs'",
+    "truncateSync": "import {truncateSync} from 'fs'",
+    "unwatchFile": "import {unwatchFile} from 'fs'",
+    "unlink": "import {unlink} from 'fs'",
+    "unlinkSync": "import {unlinkSync} from 'fs'",
+    "utimes": "import {utimes} from 'fs'",
+    "utimesSync": "import {utimesSync} from 'fs'",
+    "watch": "import {watch} from 'fs'",
+    "watchFile": "import {watchFile} from 'fs'",
+    "writeFile": "import {writeFile} from 'fs'",
+    "writeFileSync": "import {writeFileSync} from 'fs'",
+    "write": "import {write} from 'fs'",
+    "writeSync": "import {writeSync} from 'fs'",
+    "writev": "import {writev} from 'fs'",
+    "writevSync": "import {writevSync} from 'fs'",
+    "Dir": "import {Dir} from 'fs'",
+    "Dirent": "import {Dirent} from 'fs'",
+    "Stats": "import {Stats} from 'fs'",
+    "ReadStream": "import {ReadStream} from 'fs'",
+    "WriteStream": "import {WriteStream} from 'fs'",
+    "FileReadStream": "import {FileReadStream} from 'fs'",
+    "FileWriteStream": "import {FileWriteStream} from 'fs'",
+    "F_OK": "import {F_OK} from 'fs'",
+    "R_OK": "import {R_OK} from 'fs'",
+    "W_OK": "import {W_OK} from 'fs'",
+    "X_OK": "import {X_OK} from 'fs'"
+}

package/lib/declare/modules/module.json

@@ -0,0 +1,10 @@
+{
+    "builtinModules": "import {builtinModules} from 'module'",
+    "globalPaths": "import {globalPaths} from 'module'",
+    "createRequire": "import {createRequire} from 'module'",
+    "syncBuiltinESMExports": "import {syncBuiltinESMExports} from 'module'",
+    "Module": "import {Module} from 'module'",
+    "runMain": "import {runMain} from 'module'",
+    "findSourceMap": "import {findSourceMap} from 'module'",
+    "SourceMap": "import {SourceMap} from 'module'"
+}

package/lib/declare/modules/os.json

@@ -0,0 +1,21 @@
+{
+    "arch": "import {arch} from 'os'",
+    "cpus": "import {cpus} from 'os'",
+    "endianness": "import {endianness} from 'os'",
+    "freemem": "import {freemem} from 'os'",
+    "getPriority": "import {getPriority} from 'os'",
+    "homedir": "import {homedir} from 'os'",
+    "hostname": "import {hostname} from 'os'",
+    "loadavg": "import {loadavg} from 'os'",
+    "networkInterfaces": "import {networkInterfaces} from 'os'",
+    "platform": "import {platform} from 'os'",
+    "release": "import {release} from 'os'",
+    "setPriority": "import {setPriority} from 'os'",
+    "tmpdir": "import {tmpdir} from 'os'",
+    "totalmem": "import {totalmem} from 'os'",
+    "userInfo": "import {userInfo} from 'os'",
+    "uptime": "import {uptime} from 'os'",
+    "constants": "import {constants} from 'os'",
+    "EOL": "import {EOL} from 'os'",
+    "devNull": "import {devNull} from 'os'"
+}

package/lib/declare/modules/path.json

@@ -0,0 +1,16 @@
+{
+    "resolve": "import {resolve} from 'path'",
+    "normalize": "import {normalize} from 'path'",
+    "isAbsolute": "import {isAbsolute} from 'path'",
+    "join": "import {join} from 'path'",
+    "relative": "import {relative} from 'path'",
+    "toNamespacedPath": "import {toNamespacedPath} from 'path'",
+    "dirname": "import {dirname} from 'path'",
+    "basename": "import {basename} from 'path'",
+    "extname": "import {extname} from 'path'",
+    "format": "import {format} from 'path'",
+    "sep": "import {sep} from 'path'",
+    "delimiter": "import {delimiter} from 'path'",
+    "win32": "import {win32} from 'path'",
+    "posix": "import {posix} from 'path'"
+}

package/lib/declare/modules/process.json

@@ -0,0 +1,55 @@
+{
+    "arch": "import {arch} from 'process'",
+    "platform": "import {platform} from 'process'",
+    "release": "import {release} from 'process'",
+    "moduleLoadList": "import {moduleLoadList} from 'process'",
+    "binding": "import {binding} from 'process'",
+    "domain": "import {domain} from 'process'",
+    "config": "import {config} from 'process'",
+    "dlopen": "import {dlopen} from 'process'",
+    "uptime": "import {uptime} from 'process'",
+    "reallyExit": "import {reallyExit} from 'process'",
+    "cpuUsage": "import {cpuUsage} from 'process'",
+    "resourceUsage": "import {resourceUsage} from 'process'",
+    "memoryUsage": "import {memoryUsage} from 'process'",
+    "kill": "import {kill} from 'process'",
+    "exit": "import {exit} from 'process'",
+    "openStdin": "import {openStdin} from 'process'",
+    "getuid": "import {getuid} from 'process'",
+    "geteuid": "import {geteuid} from 'process'",
+    "getgid": "import {getgid} from 'process'",
+    "getegid": "import {getegid} from 'process'",
+    "getgroups": "import {getgroups} from 'process'",
+    "allowedNodeEnvironmentFlags": "import {allowedNodeEnvironmentFlags} from 'process'",
+    "assert": "import {assert} from 'process'",
+    "features": "import {features} from 'process'",
+    "setUncaughtExceptionCaptureCallback": "import {setUncaughtExceptionCaptureCallback} from 'process'",
+    "hasUncaughtExceptionCaptureCallback": "import {hasUncaughtExceptionCaptureCallback} from 'process'",
+    "emitWarning": "import {emitWarning} from 'process'",
+    "nextTick": "import {nextTick} from 'process'",
+    "stdout": "import {stdout} from 'process'",
+    "stdin": "import {stdin} from 'process'",
+    "stderr": "import {stderr} from 'process'",
+    "abort": "import {abort} from 'process'",
+    "umask": "import {umask} from 'process'",
+    "chdir": "import {chdir} from 'process'",
+    "cwd": "import {cwd} from 'process'",
+    "initgroups": "import {initgroups} from 'process'",
+    "setgroups": "import {setgroups} from 'process'",
+    "setegid": "import {setegid} from 'process'",
+    "seteuid": "import {seteuid} from 'process'",
+    "setgid": "import {setgid} from 'process'",
+    "setuid": "import {setuid} from 'process'",
+    "title": "import {title} from 'process'",
+    "argv": "import {argv} from 'process'",
+    "execArgv": "import {execArgv} from 'process'",
+    "pid": "import {pid} from 'process'",
+    "ppid": "import {ppid} from 'process'",
+    "execPath": "import {execPath} from 'process'",
+    "debugPort": "import {debugPort} from 'process'",
+    "hrtime": "import {hrtime} from 'process'",
+    "argv0": "import {argv0} from 'process'",
+    "throwDeprecation": "import {throwDeprecation} from 'process'",
+    "setSourceMapsEnabled": "import {setSourceMapsEnabled} from 'process'",
+    "mainModule": "import {mainModule} from 'process'"
+}

package/lib/declare/modules/stream.json

@@ -0,0 +1,14 @@
+{
+    "isDisturbed": "import {isDisturbed} from 'stream'",
+    "Readable": "import {Readable} from 'stream'",
+    "Writable": "import {Writable} from 'stream'",
+    "Duplex": "import {Duplex} from 'stream'",
+    "Transform": "import {Transform} from 'stream'",
+    "PassThrough": "import {PassThrough} from 'stream'",
+    "pipeline": "import {pipeline} from 'stream'",
+    "addAbortSignal": "import {addAbortSignal} from 'stream'",
+    "finished": "import {finished} from 'stream'",
+    "destroy": "import {destroy} from 'stream'",
+    "compose": "import {compose} from 'stream'",
+    "Stream": "import {Stream} from 'stream'"
+}

package/lib/declare/modules/url.json

@@ -0,0 +1,7 @@
+{
+    "domainToASCII": "import {domainToASCII} from 'url'",
+    "domainToUnicode": "import {domainToUnicode} from 'url'",
+    "pathToFileURL": "import {pathToFileURL} from 'url'",
+    "fileURLToPath": "import {fileURLToPath} from 'url'",
+    "urlToHttpOptions": "import {urlToHttpOptions} from 'url'"
+}

package/lib/declare/modules/util.json

@@ -0,0 +1,14 @@
+{
+    "callbackify": "import {callbackify} from 'util'",
+    "formatWithOptions": "import {formatWithOptions} from 'util'",
+    "getSystemErrorMap": "import {getSystemErrorMap} from 'util'",
+    "getSystemErrorName": "import {getSystemErrorName} from 'util'",
+    "inherits": "import {inherits} from 'util'",
+    "inspect": "import {inspect} from 'util'",
+    "isDeepStrictEqual": "import {isDeepStrictEqual} from 'util'",
+    "promisify": "import {promisify} from 'util'",
+    "stripVTControlCharacters": "import {stripVTControlCharacters} from 'util'",
+    "toUSVString": "import {toUSVString} from 'util'",
+    "TextDecoder": "import {TextDecoder} from 'util'",
+    "TextEncoder": "import {TextEncoder} from 'util'"
+}

package/lib/declare/modules/zlib.json

@@ -0,0 +1,40 @@
+{
+    "Deflate": "import {Deflate} from 'zlib'",
+    "Inflate": "import {Inflate} from 'zlib'",
+    "Gzip": "import {Gzip} from 'zlib'",
+    "Gunzip": "import {Gunzip} from 'zlib'",
+    "DeflateRaw": "import {DeflateRaw} from 'zlib'",
+    "InflateRaw": "import {InflateRaw} from 'zlib'",
+    "Unzip": "import {Unzip} from 'zlib'",
+    "BrotliCompress": "import {BrotliCompress} from 'zlib'",
+    "BrotliDecompress": "import {BrotliDecompress} from 'zlib'",
+    "deflate": "import {deflate} from 'zlib'",
+    "deflateSync": "import {deflateSync} from 'zlib'",
+    "gzip": "import {gzip} from 'zlib'",
+    "gzipSync": "import {gzipSync} from 'zlib'",
+    "deflateRaw": "import {deflateRaw} from 'zlib'",
+    "deflateRawSync": "import {deflateRawSync} from 'zlib'",
+    "unzip": "import {unzip} from 'zlib'",
+    "unzipSync": "import {unzipSync} from 'zlib'",
+    "inflate": "import {inflate} from 'zlib'",
+    "inflateSync": "import {inflateSync} from 'zlib'",
+    "gunzip": "import {gunzip} from 'zlib'",
+    "gunzipSync": "import {gunzipSync} from 'zlib'",
+    "inflateRaw": "import {inflateRaw} from 'zlib'",
+    "inflateRawSync": "import {inflateRawSync} from 'zlib'",
+    "brotliCompress": "import {brotliCompress} from 'zlib'",
+    "brotliCompressSync": "import {brotliCompressSync} from 'zlib'",
+    "brotliDecompress": "import {brotliDecompress} from 'zlib'",
+    "brotliDecompressSync": "import {brotliDecompressSync} from 'zlib'",
+    "createDeflate": "import {createDeflate} from 'zlib'",
+    "createInflate": "import {createInflate} from 'zlib'",
+    "createDeflateRaw": "import {createDeflateRaw} from 'zlib'",
+    "createInflateRaw": "import {createInflateRaw} from 'zlib'",
+    "createGzip": "import {createGzip} from 'zlib'",
+    "createGunzip": "import {createGunzip} from 'zlib'",
+    "createUnzip": "import {createUnzip} from 'zlib'",
+    "createBrotliCompress": "import {createBrotliCompress} from 'zlib'",
+    "createBrotliDecompress": "import {createBrotliDecompress} from 'zlib'",
+    "constants": "import {constants} from 'zlib'",
+    "codes": "import {codes} from 'zlib'"
+}

package/lib/index.js

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@putout/plugin-nodejs",
-  "version": "3.2.0",
+  "version": "4.1.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",
@@ -35,17 +35,18 @@
     "c8": "^7.5.0",
     "eslint": "^8.0.1",
     "eslint-plugin-node": "^11.0.0",
-    "eslint-plugin-putout": "^13.0.0",
+    "eslint-plugin-putout": "^14.0.0",
     "lerna": "^4.0.0",
     "madrun": "^9.0.0",
+    "montag": "^1.2.1",
     "nodemon": "^2.0.1"
   },
   "peerDependencies": {
-    "putout": ">=24"
+    "putout": ">=25"
   },
   "license": "MIT",
   "engines": {
-    "node": ">=14"
+    "node": ">=16"
   },
   "publishConfig": {
     "access": "public"