Initial scaffolding

Author: Laurie

README.md

@@ -1,2 +1,7 @@
 # codemods
+
 Tools for migrating MDX projects from v1 to v2
+
+To run `jscodeshift -t <path-to-transform> <path-to-project>`
+
+When published `npx codemods <path-to-project>` (This may be a longer package name than codemods when published)

bin/cli.js

@@ -0,0 +1,40 @@
+import path from "path";
+import execa from "execa";
+
+export const transformerDirectory = path.join(__dirname, "../", "transforms");
+export const jscodeshiftExecutable = require.resolve(".bin/jscodeshift");
+
+export function runTransform(targetDir) {
+  const transformerPath = path.join(transformerDirectory, `mdx-v2.js`);
+
+  let args = [];
+
+  args.push("--ignore-pattern=**/node_modules/**");
+
+  args.push("--extensions=mdx");
+
+  args = args.concat(["--transform", transformerPath, targetDir]);
+
+  console.log(`Executing command: jscodeshift ${args.join(" ")}`);
+
+  const result = execa.sync(jscodeshiftExecutable, args, {
+    stdio: "inherit",
+    stripEof: false,
+  });
+
+  if (result.error) {
+    throw result.error;
+  }
+}
+
+export function run() {
+  let [targetDir] = process.argv.slice(2);
+
+  if (!targetDir) {
+    console.log(
+      `You have not provided a target directory to run the codemod against, will default to root.`
+    );
+    targetDir = `.`;
+  }
+  runTransform(targetDir);
+}

bin/codemods.js

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+
+require("./cli").run();

package-lock.json

@@ -0,0 +1,29 @@
+{
+  "name": "codemods",
+  "version": "1.0.0",
+  "description": "Tools for migrating MDX projects from v1 to v2",
+  "main": "index.js",
+  "dependencies": {
+    "execa": "^5.0.0",
+    "jscodeshift": "^0.11.0"
+  },
+  "devDependencies": {
+    "jest": "^26.6.3"
+  },
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "jest": "jest"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/mdx-js/codemods.git"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "bugs": {
+    "url": "https://github.com/mdx-js/codemods/issues"
+  },
+  "homepage": "https://github.com/mdx-js/codemods#readme",
+  "bin": "./bin/codemods.js"
+}

package.json

@@ -0,0 +1,5 @@
+---
+title: test
+---
+
+This is a test

src/transforms/__testfixtures__/example.input.mdx

@@ -0,0 +1,5 @@
+---
+title: test
+---
+
+This is a test

src/transforms/__testfixtures__/example.output.mdx

@@ -0,0 +1,10 @@
+const tests = [`example`];
+
+const defineTest = require(`jscodeshift/dist/testUtils`).defineTest;
+
+// This won't work, we'll need to use inline or snapshot tests instead
+describe(`codemods`, () => {
+  tests.forEach((test) =>
+    defineTest(__dirname, `mdx-v2`, { parser: `mdx` }, `${test}`)
+  );
+});

src/transforms/__tests__/mdx-v2-test.js

@@ -0,0 +1,9 @@
+export default function jsCodeShift({ source, path }) {
+  console.log(source);
+  dummyForJohn();
+  return source;
+}
+
+function dummyForJohn() {
+  //noop
+}