Merge pull request #50 from MiniCheese26/feat/add-get-symbol-description

feat: Add `get-symbol-description`

Author: thepassle

codemods/get-symbol-description/index.js

@@ -0,0 +1,47 @@
+import jscodeshift from 'jscodeshift';
+import { removeImport } from '../shared.js';
+
+/**
+ * @typedef {import('../../types.js').Codemod} Codemod
+ * @typedef {import('../../types.js').CodemodOptions} CodemodOptions
+ */
+
+/**
+ * @param {CodemodOptions} [options]
+ * @returns {Codemod}
+ */
+export default function (options) {
+	return {
+		name: 'get-symbol-description',
+		transform: ({ file }) => {
+			const j = jscodeshift;
+			const root = j(file.source);
+			let dirtyFlag = false;
+
+			const { identifier } = removeImport('get-symbol-description', root, j);
+
+			root
+				.find(j.CallExpression, {
+					callee: {
+						type: 'Identifier',
+						name: identifier,
+					},
+				})
+				.forEach((path) => {
+					const args = path.value.arguments;
+					if (args.length === 1) {
+						const newExpression = j.memberExpression(
+							//@ts-ignore
+							args[0],
+							j.identifier('description'),
+						);
+
+						j(path).replaceWith(newExpression);
+						dirtyFlag = true;
+					}
+				});
+
+			return dirtyFlag ? root.toSource(options) : file.source;
+		},
+	};
+}

test/fixtures/get-symbol-description/case-1/after.js

@@ -0,0 +1,8 @@
+var assert = require("assert");
+
+var testSymbol = symbol("foo");
+
+assert.equal(
+  testSymbol.description,
+  "foo",
+);

test/fixtures/get-symbol-description/case-1/before.js

@@ -0,0 +1,9 @@
+var symbolDescription = require("get-symbol-description");
+var assert = require("assert");
+
+var testSymbol = symbol("foo");
+
+assert.equal(
+  symbolDescription(testSymbol),
+  "foo",
+);

test/fixtures/get-symbol-description/case-1/result.js

@@ -0,0 +1,8 @@
+var assert = require("assert");
+
+var testSymbol = symbol("foo");
+
+assert.equal(
+  testSymbol.description,
+  "foo",
+);