feat(import-assertions-to-attributes): introduce (#89)

Author: AugustinMauroy

biome.jsonc

@@ -1,7 +1,7 @@
 {
   "$schema": "https://biomejs.dev/schemas/2.0.0/schema.json",
   "files": {
-    "includes": ["**", "!**/*.snap.cjs", "!**/fixtures/**"]
+    "includes": ["**", "!**/*.snap.cjs", "!**/fixtures/**", "!**/expected/**", "!**/input/**"]
   },
   "assist": { "actions": { "source": { "organizeImports": "off" } } },
   // Rules for the linter

package-lock.json

@@ -0,0 +1,26 @@
+# Import Assertions to Attributes
+
+This recipe converts import assertions (`assert` syntax) to the standardized import attributes (`with` syntax). It modifies code like:
+
+```ts
+// Before
+import data from './data.json' assert { type: 'json' };
+
+// After
+import data from './data.json' with { type: 'json' };
+```
+
+## Usage
+
+Run this codemod with:
+
+```sh
+npx codemod@next nodejs/import-assertions-to-attributes
+```
+
+## When is it useful?
+
+The import assertions syntax is being deprecated in favor of the standardized import attributes syntax. This codemod helps transition existing codebases to the new syntax, ensuring compatibility with future versions of Node.js.
+
+Node.js drop support of import assertions in favor of import attributes in version [`22.0.0`](https://nodejs.org/fr/blog/release/v22.0.0#other-notable-changes)
+But the support for import attributes was added in Node.js version [`18.20.0`](https://nodejs.org/fr/blog/release/v18.20.0#added-support-for-import-attributes)

recipes/import-assertions-to-attributes/README.md

@@ -0,0 +1,21 @@
+schema_version: "1.0"
+name: nodejs/import-assertions-to-attributes
+version: 0.0.1
+description: Replace `assert` import attribute to the `with` ECMAScript import attribute.
+author: Augustin Mauroy
+license: MIT
+workflow: workflow.yaml
+category: migration
+
+targets:
+  languages:
+    - javascript
+    - typescript
+
+keywords:
+  - transformation
+  - migration
+
+registry:
+  access: public
+  visibility: public

recipes/import-assertions-to-attributes/codemod.yaml

@@ -0,0 +1,22 @@
+{
+  "name": "@nodejs/import-assertions-to-attributes",
+  "version": "0.0.1",
+  "description": "Replace `assert` import attribute to the `with` ECMAScript import attribute.",
+  "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/import-assertions-to-attributes",
+    "bugs": "https://github.com/nodejs/userland-migrations/issues"
+  },
+  "author": "Augustin Mauroy",
+  "license": "MIT",
+  "homepage": "https://github.com/nodejs/userland-migrations/tree/main/import-assertions-to-attributes#readme",
+  "devDependencies": {
+    "@types/node": "^24.0.3",
+    "@codemod.com/jssg-types": "^1.0.3"
+  }
+}

recipes/import-assertions-to-attributes/package.json

@@ -0,0 +1,63 @@
+import type { SgRoot, Edit } from "@codemod.com/jssg-types/main";
+
+/**
+ * Transform function that converts import assertions to import attributes
+ *
+ * Handles:
+ * 1. import { something } from './module.json' assert { type: 'json' };
+ * 2. import('./module.json', { assert: { type: 'json' } })
+ *
+ * Converts them to:
+ * 1. import { something } from './module.json' with { type: 'json' };
+ * 2. import('./module.json', { with: { type: 'json' } })
+ */
+export default async function transform(root: SgRoot): Promise<string> {
+	const rootNode = root.root();
+	const edits: Edit[] = [];
+
+	const importStatements = rootNode.findAll({
+		rule: {
+			kind: 'import_attribute',
+			regex: '^assert\\s*\\{',
+		}
+	});
+
+	for (const importNode of importStatements) {
+		// Replace 'assert' with 'with' in the import statement
+		importNode.children().map(child => {
+			if (child.kind() === 'assert' && child.text() === 'assert') {
+				//return child.replace('with');
+				edits.push(child.replace('with'));
+			}
+		})
+	}
+
+	// Handle dynamic import call expressions with assert attributes
+	// e.g., import('./module.json', { assert: { type: 'json' } })
+	const assertIdentifiers = rootNode.findAll({
+		rule: {
+			kind: 'property_identifier',
+			regex: '^assert$',
+			inside: {
+				kind: 'pair',
+				inside: {
+					kind: 'object',
+					inside: {
+						kind: 'arguments',
+						inside: {
+							kind: 'call_expression',
+							pattern: "import($_SPECIFIER, $_ARGS)"
+						}
+					}
+				}
+			}
+		}
+	});
+
+	for (const assertNode of assertIdentifiers) {
+		edits.push(assertNode.replace('with'));
+	}
+
+	return rootNode.commitEdits(edits);
+}
+

recipes/import-assertions-to-attributes/src/workflow.ts

@@ -0,0 +1,14 @@
+import { createRequire } from 'node:module';
+import data from './data.json' with { type: 'json' };
+import systemOfADown from './system;of;a;down.json' with { type: 'json' };
+import { default as config } from './config.json'with{type: 'json'};
+import { thing } from "./data.json"with{type: 'json'};
+import { fileURLToPath } from 'node:url' invalid { };
+const require = createRequire(import.meta.url);
+const foo = require('./foo.ts');
+
+const data2 = await import('./data2.json', {
+	with: { type: 'json' },
+});
+
+await import('foo-bis');

recipes/import-assertions-to-attributes/tests/expected/file-edge-case.js

@@ -0,0 +1,6 @@
+async function main() {
+	const data = await import('./data.json', { with: { type: 'json' } });
+	const pkg = await import('pkg');
+
+	return data;
+}

recipes/import-assertions-to-attributes/tests/expected/file.cjs

@@ -0,0 +1,19 @@
+import data from './data.json' with { type: 'json' };
+
+const data2 = await import('./data2.json', {
+	with: { type: 'json' },
+});
+
+await import('./data3.json', {
+	with: { type: 'json' },
+});
+
+await import('pkg');
+
+function getData4() {
+	import('pkg-bis');
+
+	return import('./data4.json', {
+		with: { type: 'json' },
+	});
+}

recipes/import-assertions-to-attributes/tests/expected/file.js

@@ -0,0 +1,19 @@
+import data from './data.json' with { type: 'json' };
+
+const data2 = await import('./data2.json', {
+	with: { type: 'json' },
+});
+
+await import('./data3.json', {
+	with: { type: 'json' },
+});
+
+await import('pkg');
+
+function getData4() {
+	import('pkg-bis');
+
+	return import('./data4.json', {
+		with: { type: 'json' },
+	});
+}