feat(fs-access-mode-constants): introduce (#152)

Author: nekojanai

package-lock.json

@@ -0,0 +1,23 @@
+# `fs.F_OK`, `fs.R_OK`, `fs.W_OK`, `fs.X_OK` DEP0176
+
+Handle DEP0176 via transforming imports of `fs.F_OK`, `fs.R_OK`, `fs.W_OK`, `fs.X_OK` from the root `fs` module to `fs.constants`.
+
+See [DEP0176](https://nodejs.org/api/deprecations.html#dep0176-fsf_ok-fsr_ok-fsw_ok-fsx_ok)
+
+## Example
+
+**Before:**
+```js
+const fs = require('node:fs');
+
+fs.access('/path/to/file', fs.F_OK, callback);
+fs.access('/path/to/file', fs.R_OK | fs.W_OK, callback);
+```
+
+**After:**
+```js
+const fs = require('node:fs');
+
+fs.access('/path/to/file', fs.constants.F_OK, callback);
+fs.access('/path/to/file', fs.constants.R_OK | fs.constants.W_OK, callback);
+```

recipes/fs-access-mode-constants/README.md

@@ -0,0 +1,21 @@
+schema_version: "1.0"
+name: "@nodejs/fs-access-mode-constants"
+version: "1.0.0"
+description: Handle DEP0176 via transforming imports of `fs.F_OK`, `fs.R_OK`, `fs.W_OK`, `fs.X_OK` from the root `fs` module to `fs.constants`.
+author: nekojanai (Jana)
+license: MIT
+workflow: workflow.yaml
+category: migration
+
+targets:
+  languages:
+    - javascript
+    - typescript
+
+keywords:
+  - transformation
+  - migration
+
+registry:
+  access: public
+  visibility: public

recipes/fs-access-mode-constants/codemod.yaml

@@ -0,0 +1,24 @@
+{
+  "name": "@nodejs/fs-access-mode-constants",
+  "version": "1.0.0",
+  "description": "Handle DEP0176 via transforming imports of `fs.F_OK`, `fs.R_OK`, `fs.W_OK`, `fs.X_OK` from the root `fs` module to `fs.constants`.",
+  "type": "module",
+  "scripts": {
+    "test": "npx codemod jssg test -l typescript ./src/workflow.ts ./"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/nodejs/userland-migrations.git",
+    "directory": "recipes/fs-access-mode-constants",
+    "bugs": "https://github.com/nodejs/userland-migrations/issues"
+  },
+  "author": "nekojanai (Jana)",
+  "license": "MIT",
+  "homepage": "https://github.com/nodejs/userland-migrations/blob/main/recipes/fs-access-mode-constants/README.md",
+  "dependencies": {
+    "@nodejs/codemod-utils": "*"
+  },
+  "devDependencies": {
+    "@codemod.com/jssg-types": "^1.0.3"
+  }
+}

recipes/fs-access-mode-constants/package.json

@@ -0,0 +1,76 @@
+import type { Edit, SgRoot } from "@codemod.com/jssg-types/main";
+import { getNodeRequireCalls } from "@nodejs/codemod-utils/ast-grep/require-call";
+import type Js from "@codemod.com/jssg-types/langs/javascript";
+import { getNodeImportStatements } from "@nodejs/codemod-utils/ast-grep/import-statement";
+
+export default function tranform(root: SgRoot<Js>): string | null {
+  const rootNode = root.root();
+  const edits: Edit[] = [];
+
+  // @ts-expect-error - ast-grep types are not fully compatible with JSSG types
+  const requireStatements = getNodeRequireCalls(root, "fs");
+
+  for (const statement of requireStatements) {
+    const objectPattern = statement.find({
+      rule:
+        { kind: 'object_pattern' },
+    });
+
+    if (objectPattern) {
+      let objPatArr = objectPattern.findAll({
+        rule:
+          { kind: 'shorthand_property_identifier_pattern' },
+      }).map((v) => v.text());
+      objPatArr = objPatArr.filter((v) => !['F_OK', 'R_OK', 'W_OK', 'X_OK'].includes(v));
+      objPatArr.push('constants');
+      edits.push(objectPattern.replace(`{ ${objPatArr.join(', ')} }`));
+    };
+  }
+
+  // @ts-expect-error - ast-grep types are not fully compatible with JSSG types
+  const importStatements = getNodeImportStatements(root, "fs");
+  let promisesImportName = '';
+
+  for (const statement of importStatements) {
+    const objectPattern = statement.find({
+      rule:
+        { kind: 'named_imports' },
+    });
+
+    if (objectPattern) {
+      let objPatArr = objectPattern.findAll({
+        rule:
+          { kind: 'import_specifier' },
+      }).map((v) => v.text());
+      objPatArr = objPatArr.filter((v) => !['F_OK', 'R_OK', 'W_OK', 'X_OK'].includes(v));
+      const promisesImport = objPatArr.find((v) => v.startsWith('promises'));
+      if (promisesImport) {
+        if (promisesImport.includes('as')) {
+          const m = promisesImport.matchAll((/promises as (\w+)/g));
+          m.forEach((v) => promisesImportName = v[1] ?? 'promises');
+        } else {
+          promisesImportName = promisesImport;
+        }
+        promisesImportName = `${promisesImportName}.`
+      } else {
+        objPatArr.push('constants');
+      }
+      edits.push(objectPattern.replace(`{ ${objPatArr.join(', ')} }`));
+    }
+  }
+
+  for (const _OK of ['F_OK', 'R_OK', 'W_OK', 'X_OK']) {
+    for (const [prefix, replacement] of [['fs.', 'fs.constants.'], ['', `${promisesImportName ? promisesImportName : ''}constants.`]]) {
+      const patterns = rootNode.findAll({
+        rule: {
+          pattern: `${prefix}${_OK}`
+        }
+      });
+      for (const pattern of patterns) {
+        edits.push(pattern.replace(`${replacement}${_OK}`));
+      }
+    }
+  }
+
+  return rootNode.commitEdits(edits);
+}

recipes/fs-access-mode-constants/src/workflow.ts

@@ -0,0 +1,4 @@
+const fs = require('node:fs');
+
+fs.access('/path/to/file', fs.constants.F_OK, callback);
+fs.access('/path/to/file', fs.constants.R_OK | fs.constants.W_OK, callback);

recipes/fs-access-mode-constants/tests/expected/file-00.js

@@ -0,0 +1,4 @@
+import * as fs from 'node:fs';
+
+fs.access('/path/to/file', fs.constants.F_OK, callback);
+fs.access('/path/to/file', fs.constants.X_OK, callback);

recipes/fs-access-mode-constants/tests/expected/file-01.js

@@ -0,0 +1,4 @@
+const { access, constants } = require('node:fs');
+
+access('/path/to/file', constants.F_OK, callback);
+access('/path/to/file', constants.R_OK | constants.W_OK, callback);

recipes/fs-access-mode-constants/tests/expected/file-02.js

@@ -0,0 +1,4 @@
+import { access, constants } from 'node:fs';
+
+access('/path/to/file', constants.F_OK, callback);
+access('/path/to/file', constants.R_OK | constants.W_OK | constants.X_OK, callback);

recipes/fs-access-mode-constants/tests/expected/file-03.js

@@ -0,0 +1,5 @@
+const { accessSync, constants } = require('node:fs');
+const fs = require('node:fs');
+
+accessSync('/path/to/file', constants.F_OK);
+fs.access('/path/to/file', fs.constants.W_OK | constants.R_OK, callback);