feat: add CLI

Author: jedwards1211

package.json

@@ -2,9 +2,13 @@
   "name": "astx",
   "version": "0.0.0-development",
   "description": "JS/TS find and replace API/CLI for jscodeshift",
+  "bin": {
+    "astx": "cli/index.js"
+  },
   "main": "index.js",
   "sideEffects": false,
   "scripts": {
+    "cli": "ts-node src/cli/index.ts",
     "lint": "eslint $npm_package_config_lint",
     "lint:fix": "eslint $npm_package_config_lint",
     "prettier": "prettier --write .babelrc.js *.json *.md *.ts '{src,test}/**/*.{js,ts}'",
@@ -101,9 +105,11 @@
     "@jedwards1211/commitlint-config": "^1.0.1",
     "@jedwards1211/eslint-config-typescript": "^1.0.0",
     "@types/chai": "^4.2.0",
+    "@types/inquirer": "^7.3.1",
     "@types/jscodeshift": "^0.7.1",
     "@types/mocha": "^5.2.7",
     "@types/node": "^12.12.6",
+    "@types/yargs": "^15.0.10",
     "babel-eslint": "^10.0.1",
     "babel-plugin-istanbul": "^5.1.0",
     "chai": "^4.2.0",
@@ -123,11 +129,17 @@
     "require-glob": "^3.2.0",
     "rimraf": "^2.6.0",
     "semantic-release": "^17.1.2",
-    "typescript": "^3.7.2"
+    "ts-node": "^9.0.0",
+    "typescript": "^4.1.2"
   },
   "dependencies": {
     "@babel/runtime": "^7.1.5",
-    "jscodeshift": "^0.11.0"
+    "chalk": "^4.1.0",
+    "inquirer": "^7.3.3",
+    "jscodeshift": "^0.11.0",
+    "print-diff": "^1.0.0",
+    "smart-restart": "^2.5.0",
+    "yargs": "^16.1.1"
   },
   "renovate": {
     "extends": [

src/cli/index.ts

@@ -0,0 +1,12 @@
+#!/usr/bin/env node
+
+import launch from 'smart-restart'
+import path from 'path'
+
+launch({
+  main: path.resolve(__dirname, 'runner' + path.extname(__filename)),
+  command: __filename.endsWith('.ts') ? 'ts-node' : 'node',
+  args: process.argv.slice(2),
+  restartOnError: false,
+  restartOnExit: false,
+})

src/cli/runner.ts

@@ -0,0 +1,118 @@
+/* eslint-disable no-console */
+
+import chalk from 'chalk'
+import path from 'path'
+import fs from 'fs'
+import printDiff from 'print-diff'
+import jscodeshift from 'jscodeshift'
+import yargs from 'yargs'
+import inquirer from 'inquirer'
+import parseFindOrReplace from '../util/parseFindOrReplace'
+import replace from '../replace'
+import * as astx from '../index'
+
+const argv = yargs.option('transform', {
+  alias: 't',
+  describe: 'path to the transform file. Can be either a local path or url',
+  default: './astx.js',
+}).argv
+
+const { _: files } = argv
+
+// eslint-disable-next-line @typescript-eslint/no-var-requires
+const transform = require(path.resolve(argv.transform))
+
+const results: Record<string, string> = {}
+
+const j = transform.parser
+  ? jscodeshift.withParser(transform.parser)
+  : jscodeshift
+
+let parsedFind, parsedReplace
+if (transform.find) {
+  try {
+    parsedFind = parseFindOrReplace(j, transform.find)
+  } catch (error) {
+    console.error(`failed to parse find: ${error.message}`)
+    process.exit(1)
+  }
+}
+if (transform.replace) {
+  try {
+    parsedReplace =
+      typeof transform.replace === 'function'
+        ? transform.replace
+        : parseFindOrReplace(j, transform.replace)
+  } catch (error) {
+    console.error(`failed to parse replace: ${error.message}`)
+    process.exit(1)
+  }
+}
+
+for (const file of files) {
+  const source = fs.readFileSync(file, 'utf8')
+  let result
+  const reports: any[] = []
+  if (typeof transform === 'function') {
+    result = transform(
+      {
+        source,
+        path: file,
+      },
+      {
+        jscodeshift: transform.parser
+          ? jscodeshift.withParser(transform.parser)
+          : jscodeshift,
+        // eslint-disable-next-line @typescript-eslint/no-empty-function
+        stats: () => {},
+        report: (msg: any) => reports.push(msg),
+        astx,
+      },
+      {}
+    )
+  } else if (parsedFind && parsedReplace) {
+    const code = fs.readFileSync(file, 'utf8')
+    const root = j(code)
+    replace(root, parsedFind, parsedReplace)
+    result = root.toSource()
+  }
+  if (source !== result) results[file] = result
+  if (files.length > 1) {
+    console.error(
+      chalk.blue(`
+==========================================
+${file}
+==========================================
+`)
+    )
+  }
+  printDiff(source, result)
+  if (reports.length) {
+    console.error(chalk.blue`
+Reports
+-------
+`)
+    reports.forEach(r => console.error(...r))
+  }
+}
+
+if (Object.keys(results).length) {
+  inquirer
+    .prompt([
+      {
+        type: 'confirm',
+        name: 'apply',
+        message: 'Apply changes',
+        default: false,
+      },
+    ])
+    .then(({ apply }: { apply: boolean }) => {
+      if (apply) {
+        for (const file in results) {
+          fs.writeFileSync(file, results[file], 'utf8')
+          console.error(`Wrote ${file}`)
+        }
+      }
+      if (process.send) process.send({ exit: 0 })
+    })
+}

src/index.spec.ts

@@ -0,0 +1,4 @@
+import find, { Match } from './find'
+import replace, { replaceMatches } from './replace'
+
+export { find, replace, replaceMatches, Match }

src/index.ts

@@ -5,7 +5,7 @@ import jscodeshift, { ASTPath } from 'jscodeshift'
 import find from '../../src/find'
 import requireGlob from 'require-glob'
 import mapValues from '../../src/util/mapValues'
-import parseFindOrReplace from '../util/parseFindOrReplace'
+import parseFindOrReplace from '../../src/util/parseFindOrReplace'
 
 type Fixture = {
   input: string

test/util/parseFindOrReplace.ts src/util/parseFindOrReplace.tstest/util/parseFindOrReplace.ts renamed to src/util/parseFindOrReplace.ts

@@ -5,7 +5,7 @@ import jscodeshift, { ASTNode } from 'jscodeshift'
 import replace from '../../src/replace'
 import requireGlob from 'require-glob'
 import { Match } from '../../src/find'
-import parseFindOrReplace from '../util/parseFindOrReplace'
+import parseFindOrReplace from '../../src/util/parseFindOrReplace'
 
 type Fixture = {
   input: string

test/find/index.ts

@@ -1,10 +1,13 @@
 {
   "include": ["./src"],
-  "exclude": ["node_modules", "./src/**/*.spec.ts", "./test"],
+  "exclude": ["node_modules"],
   "compilerOptions": {
+    /* Visit https://aka.ms/tsconfig.json to read more about this file */
+
     /* Basic Options */
-    "target": "esnext" /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017','ES2018' or 'ESNEXT'. */,
-    "module": "commonjs" /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */,
+    // "incremental": true,                   /* Enable incremental compilation */
+    "target": "es5" /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019', 'ES2020', or 'ESNEXT'. */,
+    "module": "commonjs" /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', 'es2020', or 'ESNext'. */,
     // "lib": [],                             /* Specify library files to be included in the compilation. */
     // "allowJs": true,                       /* Allow javascript files to be compiled. */
     // "checkJs": true,                       /* Report errors in .js files. */
@@ -16,6 +19,7 @@
     "outDir": "./" /* Redirect output structure to the directory. */,
     // "rootDir": "./",                       /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
     // "composite": true,                     /* Enable project compilation */
+    // "tsBuildInfoFile": "./",               /* Specify file to store incremental compilation information */
     // "removeComments": true,                /* Do not emit comments to output. */
     // "noEmit": true,                        /* Do not emit outputs. */
     // "importHelpers": true,                 /* Import emit helpers from 'tslib'. */
@@ -27,6 +31,7 @@
     // "noImplicitAny": true,                 /* Raise error on expressions and declarations with an implied 'any' type. */
     // "strictNullChecks": true,              /* Enable strict null checks. */
     // "strictFunctionTypes": true,           /* Enable strict checking of function types. */
+    // "strictBindCallApply": true,           /* Enable strict 'bind', 'call', and 'apply' methods on functions. */
     // "strictPropertyInitialization": true,  /* Enable strict checking of property initialization in classes. */
     // "noImplicitThis": true,                /* Raise error on 'this' expressions with an implied 'any' type. */
     // "alwaysStrict": true,                  /* Parse in strict mode and emit "use strict" for each source file. */
@@ -36,21 +41,26 @@
     // "noUnusedParameters": true,            /* Report errors on unused parameters. */
     // "noImplicitReturns": true,             /* Report error when not all code paths in function return a value. */
     // "noFallthroughCasesInSwitch": true,    /* Report errors for fallthrough cases in switch statement. */
+    // "noUncheckedIndexedAccess": true,      /* Include 'undefined' in index signature results */
 
     /* Module Resolution Options */
     // "moduleResolution": "node",            /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */
     // "baseUrl": "./",                       /* Base directory to resolve non-absolute module names. */
     // "paths": {},                           /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */
     // "rootDirs": [],                        /* List of root folders whose combined content represents the structure of the project at runtime. */
-    // "typeRoots": [],                       /* List of folders to include type definitions from. */
+    "typeRoots": [
+      "./node_modules/@types",
+      "./types"
+    ] /* List of folders to include type definitions from. */,
     // "types": [],                           /* Type declaration files to be included in compilation. */
-    "allowSyntheticDefaultImports": true /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */,
-    "esModuleInterop": true /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
+    // "allowSyntheticDefaultImports": true,  /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
+    "esModuleInterop": true /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */,
     // "preserveSymlinks": true,              /* Do not resolve the real path of symlinks. */
+    // "allowUmdGlobalAccess": true,          /* Allow accessing UMD globals from modules. */
 
     /* Source Map Options */
-    // "sourceRoot": "./",                    /* Specify the location where debugger should locate TypeScript files instead of source locations. */
-    // "mapRoot": "./",                       /* Specify the location where debugger should locate map files instead of generated locations. */
+    // "sourceRoot": "",                      /* Specify the location where debugger should locate TypeScript files instead of source locations. */
+    // "mapRoot": "",                         /* Specify the location where debugger should locate map files instead of generated locations. */
     // "inlineSourceMap": true,               /* Emit a single file with source maps instead of having a separate file. */
     // "inlineSources": true,                 /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */
 
@@ -59,6 +69,7 @@
     // "emitDecoratorMetadata": true,         /* Enables experimental support for emitting type metadata for decorators. */
 
     /* Advanced Options */
-    // "declarationDir": "lib"                /* Output directory for generated declaration files. */
+    "skipLibCheck": true /* Skip type checking of declaration files. */,
+    "forceConsistentCasingInFileNames": true /* Disallow inconsistently-cased references to the same file. */
   }
 }

test/replace/index.ts

@@ -0,0 +1,3 @@
+declare module 'require-glob' {
+  export function sync(path: string): Record<string, any>
+}