codemod 0.0.4 → 0.8.0-rc1

package/package.json

@@ -1,24 +1,93 @@
 {
   "name": "codemod",
-  "version": "0.0.4",
-  "description": "Utilities for modifying your code with code",
-  "main": "index.js",
-  "scripts": {
-    "test": "jest"
+  "version": "0.8.0-rc1",
+  "description": "A codemod engine for Node.js libraries (jscodeshift, ts-morph, etc.)",
+  "type": "module",
+  "exports": null,
+  "repository": {
+    "type": "git"
   },
   "keywords": [
-    "codemod"
+    "codemod",
+    "jscodeshift",
+    "ts-morph",
+    "refactor",
+    "transform",
+    "cli",
+    "dependencies",
+    "migrate",
+    "eslint",
+    "prettier",
+    "progress",
+    "AST",
+    "next.js",
+    "ember",
+    "react"
+  ],
+  "main": "./dist/index.cjs",
+  "bin": "./dist/index.cjs",
+  "devDependencies": {
+    "@babel/core": "^7.20.2",
+    "@babel/parser": "^7.22.10",
+    "@babel/preset-env": "^7.20.2",
+    "@babel/traverse": "7.23.2",
+    "@effect/schema": "0.27.0",
+    "@svgr/hast-util-to-babel-ast": "^7.0.0",
+    "applicationinsights": "^2.9.1",
+    "ast-types": "^0.14.2",
+    "axios": "^1.4.0",
+    "cosmiconfig": "^8.3.6",
+    "form-data": "^4.0.0",
+    "fast-glob": "3.3.2",
+    "jscodeshift": "^0.14.0",
+    "mdast-util-from-markdown": "^2.0.0",
+    "mdast-util-mdx": "^3.0.0",
+    "mdast-util-to-markdown": "^2.1.0",
+    "memfs": "^4.2.0",
+    "micromark-extension-mdxjs": "^2.0.0",
+    "minimatch": "^9.0.3",
+    "rehype-parse": "^8.0.4",
+    "tar": "^6.1.15",
+    "terminal-link": "^3.0.0",
+    "ts-morph": "18.0.0",
+    "unified": "^10.1.2",
+    "unist-util-filter": "^5.0.1",
+    "unist-util-visit": "^5.0.0",
+    "valibot": "^0.24.1",
+    "yargs": "^17.6.2",
+    "@types/babel__traverse": "^7.20.1",
+    "@types/jscodeshift": "^0.11.5",
+    "@types/node": "18.11.9",
+    "@types/sinon": "^10.0.20",
+    "@types/tar": "^6.1.5",
+    "@types/yargs": "^17.0.13",
+    "@vitest/coverage-v8": "^1.0.1",
+    "esbuild": "^0.17.14",
+    "sinon": "^17.0.0",
+    "ts-node": "^10.9.1",
+    "typescript": "5.2.2",
+    "vitest": "^1.0.1",
+    "@codemod-com/filemod": "2.0.2",
+    "@codemod-com/utilities": "1.1.0"
+  },
+  "packageManager": "pnpm@8.6.7",
+  "pkg": {
+    "outputPath": "./package/"
+  },
+  "author": "Caartaa, Inc.",
+  "license": "Apache License, Version 2.0",
+  "files": [
+    "./dist/index.cjs",
+    "LICENSE",
+    "README.md"
   ],
-  "author": "Jahred Hope <jahredhope@gmail.com>",
-  "license": "ISC",
-  "dependencies": {
-    "babylon": "^6.16.1",
-    "camelcase": "^4.0.0",
-    "eslint": "^3.17.0",
-    "eslint-plugin-import": "^2.2.0",
-    "jest": "^19.0.2",
-    "prettier": "^0.21.0",
-    "recursive-readdir": "^2.1.1",
-    "some-values": "^0.0.1"
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "esbuild ./src/index.ts  --define:__CODEMODCOM_CLI_VERSION__=\\\"0.8.0-rc1\\\" --bundle --platform=node --target=node16 --minify --format=cjs --legal-comments=inline --outfile=./dist/index.cjs",
+    "package": "pkg --compress GZip .",
+    "test": "TEST=1 vitest run",
+    "coverage": "TEST=1 vitest run --coverage"
   }
-}
+}

package/.eslintrc.js

@@ -1,30 +0,0 @@
-module.exports = {
-    "env": {
-        "es6": true,
-        "node": true,
-        "jest": true
-    },
-    "extends": "eslint:recommended",
-    "parserOptions": {
-        "sourceType": "module"
-    },
-    "rules": {
-        "indent": [
-            "error",
-            2
-        ],
-        "linebreak-style": [
-            "error",
-            "unix"
-        ],
-        "quotes": [
-            "error",
-            "single"
-        ],
-        "semi": [
-            "error",
-            "never"
-        ],
-        "no-console": 0
-    }
-};

package/.npmignore

@@ -1,2 +0,0 @@
-node_modules
-.git

package/.travis.yml

@@ -1,4 +0,0 @@
-language: node_js
-node_js:
-  - "7"
-cache: yarn

package/__snapshots__/formatWithImports.test.js.snap

@@ -1,21 +0,0 @@
-// Jest Snapshot v1, https://goo.gl/fbAQLP
-
-exports[`formatWithImports render with imports 1`] = `
-"const aVar = require('./aVar');
-const bVar = require('./bVar');
-
-require('./nameless');
-
-window.cVar = require('./cVar');
-
-initial
-content"
-`;
-
-exports[`formatWithImports should remove duplicate includes 1`] = `
-"const aVar = require('./aVar');
-const bVar = require('./bVar');
-
-initial
-content"
-`;

package/clean.js

@@ -1,31 +0,0 @@
-const { log, writeLog } = require('./logger')
-const findFilesWith = require('./findFilesWith')
-
-const { readFile, writeFile } = require('./file')
-const babylon = require('babylon')
-
-const parse = (contents) => babylon.parse(contents, {
-  plugins: ['objectRestSpread']
-})
-
-const print = require('./print')
-
-log('Cleaning all files')
-
-module.exports = (rootDir) => findFilesWith(rootDir, /\.js$/)
-  .then(fileNames => {
-    fileNames.map(fileName => {
-      const contents = readFile(fileName)
-      // const tree = parse(contents)
-      writeFile(fileName, print(contents))
-      return fileName
-    })
-  })
-  .then(fileNames => {
-    if (fileNames && fileNames.length) {
-      writeLog(`Cleaned ${fileNames.length} files`)
-    } else {
-      writeLog('No files cleaned')
-    }
-
-  })

package/encodeRegex.js

@@ -1,6 +0,0 @@
-module.exports = (txt) => {
-  if (typeof txt !== 'string') {
-    throw new TypeError(`Unable to encode value of type ${typeof txt}`)
-  }
-  return txt && txt.replace(/[-[\]{}()*+?.,\\^$|#\s]/g, '\\$&')
-}

package/file.js

@@ -1,14 +0,0 @@
-const fs = require('fs')
-
-const { log } = require('./logger')
-
-function writeFile(file, content) {
-  log('write file', file, content.length)
-  fs.writeFileSync(file, content)
-}
-
-function readFile(file) {
-  return fs.readFileSync(file, 'utf8')
-}
-
-module.exports = { writeFile, readFile }

package/file.test.js

@@ -1,55 +0,0 @@
-const file = require('./file')
-
-jest.mock('fs')
-
-const fs = require('fs')
-
-describe('File wrapper', () => {
-  describe('writer', () => {
-    beforeEach(() => {
-      fs.writeFileSync.mockReset()
-    })
-    it('should write a file when writeFile called', () => {
-      file.writeFile('example.file', 'example content')
-
-      expect(fs.writeFileSync).toHaveBeenCalled()
-    })
-    it('should write a file for each file', () => {
-      file.writeFile('example1.file', 'example content')
-      file.writeFile('example2.file', 'example content')
-
-      expect(fs.writeFileSync).toHaveBeenCalledTimes(2)
-    })
-    it('should write a file with given file name', () => {
-      const fileName = 'example.file'
-      const content = 'example content'
-
-      file.writeFile(fileName, content)
-
-      expect(fs.writeFileSync).toHaveBeenCalledWith(fileName, content)
-    })
-
-  })
-  describe('reader', () => {
-    beforeEach(() => {
-      fs.readFileSync.mockReset()
-    })
-    it('should read a file when readFile called', () => {
-      file.readFile('example.file')
-
-      expect(fs.readFileSync).toHaveBeenCalled()
-    })
-    it('should read a file as utf8', () => {
-      file.readFile('example.file')
-
-      expect(fs.readFileSync).toHaveBeenCalledWith('example.file', 'utf8')
-    })
-    it('should multiple files', () => {
-      file.readFile('example1.file')
-      file.readFile('example2.file')
-
-      expect(fs.readFileSync).toHaveBeenCalledTimes(2)
-    })
-
-  })
-})

package/findFilesWith.js

@@ -1,19 +0,0 @@
-const recursive = require('recursive-readdir')
-const fs = require('fs')
-
-module.exports = function findFilesWith(rootDir, fileRegex, contentRegex) {
-  return new Promise((resolve, reject) => {
-    const ignoreFunc = (file, stats) => fileRegex && !stats.isDirectory() && !file.match(fileRegex)
-    recursive(rootDir, [ignoreFunc], (err, files) => {
-      if (err) {
-        return reject(err)
-      }
-      return contentRegex
-        ? resolve(files.filter(file => {
-          const contents = fs.readFileSync(file, 'utf8')
-          return contents.match(contentRegex)
-        }))
-        : resolve(files)
-    })
-  })
-}

package/formatWithImports.js

@@ -1,122 +0,0 @@
-/*
- * Renders a file by first adding any imports given that don't already exist
- */
-
-const regexNamedImport = /(?:\n|^) *const (\w{3,50}) = require\(["']([^'"]+)["']\);?/g
-const regexNamelessImport = /(?:\n|^) *require\(["']([^'"]+)["']\);?/g
-const regexGlobalImport = /(?:\n|^) *window.(\w{3,50}) = require\(["']([^'"]+)["']\);?/g
-
-module.exports = ({
-  content,
-  imports, // Deprecated
-  namedImports,
-  namelessImports,
-  globalImports
-}, options = {}) => {
-
-  let newContent
-  const existingNamedImports = {}
-  const existingNamelessImports = new Set()
-  const existingGlobalImports = {}
-
-  if (typeof content !== 'string') {
-    throw new TypeError('Must contain intial content')
-  }
-
-  if (typeof options === 'boolean') {
-    console.warn('DEPRECATED: Third parameter is object field. Use { replaceOld: true }')
-    options = {replaceOld: options}
-  }
-  if (typeof imports !== 'undefined') {
-    console.warn('DEPRECATED: imports has been renamed to namedImports')
-    if (!namedImports) {
-      namedImports = imports
-    }
-  }
-
-  newContent = content
-
-  newContent = newContent.replace(regexNamelessImport, (match, importDirectory) => {
-    existingNamelessImports.add(importDirectory)
-    return ''
-  })
-
-  newContent = newContent.replace(regexNamedImport, (match, importName, importDirectory) => {
-    existingNamedImports[importName] = importDirectory
-    return ''
-  })
-
-  newContent = newContent.replace(regexGlobalImport, (match, importName, importDirectory) => {
-    existingGlobalImports[importName] = importDirectory
-    return ''
-  })
-
-
-  // Clear newlines from the start of file
-  newContent = newContent.replace(/^\n*/, '')
-
-  // Combine or replace with new imports
-  const newNamedImports = {}
-  const newNamelessImports = existingNamelessImports
-  const newGlobalImports = {}
-
-  if (namelessImports) {
-    namelessImports.forEach((namelessImport => { newNamelessImports.add(namelessImport) }))
-  }
-  if (!options.replaceOld) {
-    Object.assign(newNamedImports, existingNamedImports)
-    Object.assign(newGlobalImports, existingGlobalImports)
-  }
-  Object.assign(newNamedImports, namedImports)
-  Object.assign(newGlobalImports, globalImports)
-
-  if (newNamelessImports) {
-    // Clear nameless imports that are imported elsewhere
-    Object.values(newNamedImports)
-      .forEach(importLocation => {
-        newNamelessImports.delete(importLocation)
-      })
-
-    Object.values(newGlobalImports)
-      .forEach(importLocation => {
-        newNamelessImports.delete(importLocation)
-      })
-  }
-
-  // Add named imports to newContent
-  const namedImportsAsString = Object.entries(newNamedImports)
-    .sort(([importNameA], [importNameB]) => importNameA.localeCompare(importNameB))
-    .map(([importName, importDirectory]) => `const ${importName} = require('${importDirectory}');`)
-    .join('\n')
-
-
-  // Add nameless imports to newContent
-  const namelessImportsAsString = Array.from(newNamelessImports)
-    .sort()
-    .map(importDirectory => `require('${importDirectory}');`)
-    .join('\n')
-
-  // Add imports to newContent
-  const globalImportsAsString = Object.entries(newGlobalImports)
-    .sort(([importNameA], [importNameB]) => importNameA.localeCompare(importNameB))
-    .map(([importName, importDirectory]) => `window.${importName} = require('${importDirectory}');`)
-    .join('\n')
-
-  const contentArray = []
-
-  if (namedImportsAsString) {
-    contentArray.push(namedImportsAsString)
-  }
-
-  if (namelessImportsAsString) {
-    contentArray.push(namelessImportsAsString)
-  }
-
-  if (globalImportsAsString) {
-    contentArray.push(globalImportsAsString)
-  }
-
-  contentArray.push(newContent)
-
-  return contentArray.join('\n\n')
-}

package/formatWithImports.test.js

@@ -1,61 +0,0 @@
-let formatWithImports = require('./formatWithImports')
-
-jest.mock('./file')
-
-const file = require('./file')
-
-describe('formatWithImports', () => {
-  beforeEach(() => {
-    file.writeFile.mockReset()
-  })
-
-  it('should export a function', () => {
-    expect(typeof formatWithImports).toBe('function')
-  })
-
-  it('should require contents', () => {
-    expect(() => formatWithImports('', {})).toThrow(TypeError)
-  })
-
-  it('should return a string', () => {
-    const result = formatWithImports({content: 'initial content'})
-
-    expect(typeof result).toBe('string')
-  })
-
-  it('should not change content', () => {
-    let content = 'initial content'
-    const result = formatWithImports({content: content})
-
-    expect(result).toBe(content)
-  })
-
-  it('should strip initial whitespace', () => {
-    let content = 'initial content'
-    const result = formatWithImports({content: '\n\n\n'+content})
-
-    expect(result).toBe(content)
-  })
-
-  it('render with imports', () => {
-    let content = 'initial\ncontent'
-    const result = formatWithImports({
-      content: content,
-      namedImports: {aVar: './aVar', bVar: './bVar'},
-      namelessImports: ['./nameless'],
-      globalImports: {cVar: './cVar'}
-    })
-    expect(result).toMatchSnapshot()
-  })
-
-  it('should remove duplicate includes', () => {
-    let content = 'initial\ncontent'
-    const result = formatWithImports({
-      content: content,
-      namedImports: {aVar: './aVar', bVar: './bVar'},
-      namelessImports: ['./aVar']
-    })
-    expect(result).toMatchSnapshot()
-
-  })
-})

package/index.js

@@ -1,21 +0,0 @@
-const { writeFile, readFile } = require('./file')
-const writeFileWithImports = require('./writeFileWithImports')
-const findFilesWith = require('./findFilesWith')
-const {log, writeLog} = require('./logger')
-const camelCase = require('camelcase')
-const print = require('./print')
-const clean = require('./clean')
-const encodeRegex = require('./encodeRegex')
-
-module.exports = {
-  writeFileWithImports,
-  writeFile,
-  readFile,
-  findFilesWith,
-  log,
-  writeLog,
-  camelCase,
-  print,
-  clean,
-  encodeRegex
-}

package/logger.js

@@ -1,17 +0,0 @@
-const fs = require('fs')
-const path = require('path')
-
-let logOutput = []
-
-let reportFileLocation = path.join(process.cwd(), 'output.log')
-function log(...args) {
-  logOutput.push(args.join(' '))
-}
-function writeLog(...args) {
-  log(...args)
-  console.log(...args)
-  console.log('writing log to', reportFileLocation)
-  fs.writeFileSync(reportFileLocation, logOutput.join('\n'))
-}
-
-module.exports = { log, writeLog, reportFileLocation }

package/logger.test.js

@@ -1,23 +0,0 @@
-const logger = require('./logger')
-
-jest.mock('fs')
-
-describe('logger', () => {
-  let oldLog
-
-  beforeAll(() => {
-    oldLog = global.console.log
-    global.console.log = jest.fn()
-  })
-  afterAll(() => {
-    global.console.log = oldLog
-  })
-
-  it('should export two functions', () => {
-    expect(logger.log).toBeDefined()
-    expect(logger.writeLog).toBeDefined()
-  })
-  it('should have a default report location', () => {
-    expect(logger.reportFileLocation).toContain('/output.log')
-  })
-})

package/print.js

@@ -1,29 +0,0 @@
-/* eslint-disable */
-const prettier = require("prettier");
-
-module.exports = (source) => prettier.format(source, {
-  // Fit code within this line limit
-  printWidth: 180,
-
-  // Number of spaces it should use per tab
-  tabWidth: 4,
-
-  // If true, will use single instead of double quotes
-  singleQuote: true,
-
-  // Controls the printing of trailing commas wherever possible. Valid options:
-  // "none" - No trailing commas
-  // "es5"  - Trailing commas where valid in ES5 (objects, arrays, etc)
-  // "all"  - Trailing commas wherever possible (function arguments)
-  trailingComma: 'none',
-
-  // Controls the printing of spaces inside object literals
-  bracketSpacing: true,
-
-  // If true, puts the `>` of a multi-line jsx element at the end of
-  // the last line instead of being alone on the next line
-  jsxBracketSameLine: false,
-
-  // Which parser to use. Valid options are 'flow' and 'babylon'
-  parser: 'babylon'
-});

package/writeFileWithImports.js

@@ -1,12 +0,0 @@
-/*
- * Writes a file to the filesystem by first adding any imports given that don't already exist
- */
-
-const { writeFile } = require('./file')
-const formatWithImports = require('./formatWithImports')
-
-module.exports = (fileName, fileContentsObject, options = {}) => {
-
-  const newContent = formatWithImports(fileContentsObject, options)
-  writeFile(fileName, newContent)
-}

package/writeFileWithImports.test.js

@@ -1,25 +0,0 @@
-let writeFileWithImports = require('./writeFileWithImports')
-
-jest.mock('./file')
-
-const file = require('./file')
-
-describe('writeFileWithImports', () => {
-  beforeEach(() => {
-    file.writeFile.mockReset()
-  })
-
-  it('should export a function', () => {
-    expect(typeof writeFileWithImports).toBe('function')
-  })
-
-  it('should require contents', () => {
-    expect(() => writeFileWithImports('', {})).toThrow(TypeError)
-  })
-
-  it('should write a file', () => {
-    writeFileWithImports('example.file', {content: 'initial content'})
-
-    expect(file.writeFile).toHaveBeenCalled()
-  })
-})