scaffold codemod

Author: AugustinMauroy

package-lock.json

@@ -0,0 +1,33 @@
+# DEP0081: `fs.truncate()` using a file descriptor
+
+This recipe transforms the usage of `fs.truncate()` to `fs.ftruncateSync()` when a file descriptor is used.
+
+See [DEP0081](https://nodejs.org/api/deprecations.html#DEP0081).
+
+## Example
+
+**Before:**
+```js
+const { truncate, open, close } = require('node:fs');
+
+open('file.txt', 'w', (err, fd) => {
+  if (err) throw err;
+  truncate(fd, 10, (err) => {
+    if (err) throw err;
+    close(fd, () => {});
+  });
+});
+```
+
+**After:**
+```js
+const { ftruncate, open, close } = require('node:fs');
+
+open('file.txt', 'w', (err, fd) => {
+  if (err) throw err;
+  ftruncate(fd, 10, (err) => {
+    if (err) throw err;
+    close(fd, () => {});
+  });
+});
+```

recipes/fs-truncate-fs-depreciation/README.md

@@ -0,0 +1,21 @@
+schema_version: "1.0"
+name: nodejs/create-require-from-path
+version: 0.0.1
+description: Handle DEP0081 via transforming `truncate` to `ftruncateSync` when using a file descriptor.
+author: Augustin Mauroy
+license: MIT
+workflow: workflow.yaml
+category: migration
+
+targets:
+  languages:
+    - javascript
+    - typescript
+
+keywords:
+  - transformation
+  - migration
+
+registry:
+  access: public
+  visibility: public

recipes/fs-truncate-fs-depreciation/codemod.yml

@@ -0,0 +1,24 @@
+{
+  "name": "@nodejs/fs-truncate-fs-depreciation",
+  "version": "0.0.1",
+  "description": "Handle DEP0081 via transforming `truncate` to `ftruncateSync` when using a file descriptor.",
+  "type": "module",
+  "scripts": {
+    "test": "npx codemod@next jssg test -l typescript ./src/workflow.ts ./"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/nodejs/userland-migrations.git",
+    "directory": "recipes/fs-truncate-fs-depreciation",
+    "bugs": "https://github.com/nodejs/userland-migrations/issues"
+  },
+  "author": "Augustin Mauroy",
+  "license": "MIT",
+  "homepage": "https://github.com/nodejs/userland-migrations/blob/main/recipes/fs-truncate-fs-depreciation/README.md",
+  "devDependencies": {
+    "@codemod.com/jssg-types": "^1.0.3"
+  },
+  "dependencies": {
+    "@nodejs/codemod-utils": "0.0.0"
+  }
+}

recipes/fs-truncate-fs-depreciation/package.json

@@ -0,0 +1,15 @@
+import type { SgRoot, Edit } from "@codemod.com/jssg-types/main";
+
+/**
+ *
+ */
+export default function transform(root: SgRoot): string | null {
+  const rootNode = root.root();
+  const edits: Edit[] = [];
+  let hasChanges = false;
+
+
+  if (!hasChanges) return null;
+
+  return rootNode.commitEdits(edits);
+}

recipes/fs-truncate-fs-depreciation/src/workflow.ts

@@ -0,0 +1,9 @@
+const { ftruncate, open, close } = require('node:fs');
+
+open('file.txt', 'w', (err, fd) => {
+	if (err) throw err;
+	ftruncate(fd, 10, (err) => {
+		if (err) throw err;
+		close(fd, () => { });
+	});
+});

recipes/fs-truncate-fs-depreciation/tests/expected/file-1.js

@@ -0,0 +1,8 @@
+const fs = require('node:fs');
+
+const fd = fs.openSync('file.txt', 'w');
+try {
+	fs.ftruncateSync(fd, 10);
+} finally {
+	fs.closeSync(fd);
+}

recipes/fs-truncate-fs-depreciation/tests/expected/file-2.js

@@ -0,0 +1,11 @@
+const { truncate, ftruncateSync, open, openSync, close, closeSync } = require('node:fs');
+
+// This should be replaced (file descriptor)
+const fd = openSync('file.txt', 'w');
+ftruncateSync(fd, 10);
+closeSync(fd);
+
+// This should NOT be replaced (file path)
+truncate('other.txt', 5, (err) => {
+	if (err) throw err;
+});

recipes/fs-truncate-fs-depreciation/tests/expected/file-3.js

@@ -0,0 +1,9 @@
+import { ftruncate, open, close } from 'node:fs';
+
+open('file.txt', 'w', (err, fd) => {
+	if (err) throw err;
+	ftruncate(fd, 10, (err) => {
+		if (err) throw err;
+		close(fd, () => { });
+	});
+});

recipes/fs-truncate-fs-depreciation/tests/expected/file-4.mjs

@@ -0,0 +1,9 @@
+import fs from 'node:fs';
+
+fs.open('file.txt', 'w', (err, fd) => {
+	if (err) throw err;
+	fs.ftruncate(fd, 10, (err) => {
+		if (err) throw err;
+		fs.close(fd, () => { });
+	});
+});