Write a basic wrapper over jscodeshift (#4)

Author: trivikr

.changeset/tall-games-knock.md

@@ -0,0 +1,5 @@
+---
+"aws-sdk-js-codemod": patch
+---
+
+Add a basic wrapper over jscodeshift

LICENSE

@@ -18,7 +18,9 @@
   "files": [
     "dist"
   ],
-  "main": "dist/index.js",
+  "main": "dist/cli.js",
+  "types": "dist/cli.d.ts",
+  "bin": "dist/cli.js",
   "repository": {
     "type": "git",
     "url": "https://github.com/trivikr/aws-sdk-js-codemod.git"

package.json

@@ -0,0 +1,34 @@
+import { spawn } from "child_process";
+
+// eslint-disable-next-line @typescript-eslint/ban-ts-comment
+// @ts-ignore: package.json will be imported from dist folders
+import { version } from "../../package.json"; // eslint-disable-line
+import { run } from "../cli";
+
+jest.mock("child_process");
+
+describe("cli", () => {
+  const jscodeshiftPath = "./node_modules/.bin/jscodeshift";
+
+  afterEach(() => {
+    jest.clearAllMocks();
+  });
+
+  it("should print aws-sdk-js-codemod version", async () => {
+    jest.spyOn(process.stdout, "write");
+
+    const mockArgs = ["--version"];
+    await run(mockArgs);
+
+    expect(process.stdout.write).toHaveBeenCalledWith(
+      expect.stringMatching(`aws-sdk-js-codemod: ${version}`)
+    );
+    expect(spawn).toHaveBeenCalledWith(jscodeshiftPath, mockArgs, { stdio: "inherit" });
+  });
+
+  it("should pass args to jscodeshift", async () => {
+    const mockArgs = ["random", "args", "one", "two", "three"];
+    await run(mockArgs);
+    expect(spawn).toHaveBeenCalledWith(jscodeshiftPath, mockArgs, { stdio: "inherit" });
+  });
+});

src/__tests__/cli.spec.ts

@@ -0,0 +1,21 @@
+#!/usr/bin/env node
+
+import { spawn } from "child_process";
+
+// eslint-disable-next-line @typescript-eslint/ban-ts-comment
+// @ts-ignore: package.json will be imported from dist folders
+import { version } from "../package.json"; // eslint-disable-line
+
+const [, , ...args] = process.argv;
+const jscodeshiftPath = "./node_modules/.bin/jscodeshift";
+
+export const run = async (args): Promise<void> => {
+  if (args[0] === "--version") {
+    process.stdout.write(`aws-sdk-js-codemod: ${version}\n\n`);
+    spawn(jscodeshiftPath, ["--version"], { stdio: "inherit" });
+  } else {
+    spawn(jscodeshiftPath, args, { stdio: "inherit" });
+  }
+};
+
+run(args);

src/cli.ts

@@ -4,6 +4,7 @@
     "declaration": true,
     "esModuleInterop": true,
     "outDir": "dist",
+    "resolveJsonModule": true,
     "rootDir": "src"
   },
   "exclude": ["**/dist/**", "**/__tests__/**", "**/__testfixtures__/**"]

src/index.spec.ts

@@ -1835,6 +1835,8 @@ __metadata:
     simple-git-hooks: 2.7.0
     ts-jest: 27.1.3
     typescript: 4.5.5
+  bin:
+    aws-sdk-js-codemod: dist/cli.js
   languageName: unknown
   linkType: soft