@itwin/appui-codemod/package.json

Codemod scripts for AppUI.

{
  "name": "@itwin/appui-codemod",
  "version": "0.1.0",
  "bin": "./lib/codemod.js",
  "description": "Codemod scripts for AppUI.",
  "license": "MIT",
  "repository": {
    "type": "git",
    "url": "https://github.com/iTwin/appui.git",
    "directory": "tools/codemod"
  },
  "keywords": [
    "appui",
    "codemod"
  ],
  "author": {
    "name": "Bentley Systems, Inc.",
    "url": "http://www.bentley.com"
  },
  "dependencies": {
    "@types/jscodeshift": "^0.11.6",
    "jscodeshift": "^0.14.0",
    "typescript": "~5.0.2",
    "yargs": "^17.6.2",
    "postcss": "~8.4.23",
    "ts-node": "^10.8.2",
    "postcss-value-parser": "~4.2.0",
    "glob": "~10.2.4",
    "postcss-scss": "~4.0.6"
  },
  "devDependencies": {
    "@types/jest": "^29.4.0",
    "@types/node": "18.11.5",
    "@types/yargs": "^17.0.22",
    "jest": "^29.4.2",
    "ts-jest": "^29.0.5"
  },
  "scripts": {
    "build": "tsc",
    "clean": "",
    "cover": "",
    "docs": "",
    "lint": "",
    "test": "jest"
  },
  "readme": "# @itwin/appui-codemod\r\n\r\nThis package provides a tool that runs a collection of codemod scripts for use with [jscodeshift](https://github.com/facebook/jscodeshift) that help update projects using AppUI.\r\n\r\n## Usage\r\n\r\n```cmd\r\nnpx @itwin/appui-codemod <codemod> <paths...>\r\n\r\nApplies an `@itwin/appui-codemod` to the specified paths\r\n\r\nPositionals:\r\n  codemod  The name of the codemod                                      [string]\r\n  paths    Paths forwarded to `jscodeshift`                             [string]\r\n\r\nOptions:\r\n  --version       Show version number                                  [boolean]\r\n  --help          Show help                                            [boolean]\r\n  --debug         Prints configuration used by `jscodeshift`.\r\n                                                      [boolean] [default: false]\r\n  --printOptions  Options that are passed down to recast's printer. See:\r\n                  https://github.com/benjamn/recast/blob/master/lib/options.ts\r\n\r\nExamples:\r\n  npx @itwin/appui-codemod v4.0.0/full src  Apply all 4.0.0 transforms on `src`\r\n                                            path.\r\n  npx @itwin/appui-codemod                  Apply a specific transform on `src`\r\n  v4.0.0/layout-react src                   path.\r\n  npx @itwin/appui-codemod <codemod>        Pass additional options to recast's\r\n  <paths...> --printOptions.quote=\"single\"  printer.\r\n  npx @itwin/appui-codemod <codemod>        Pass additional options to recast's\r\n  <paths...> --printOptions='{\\\"lineTermin  printer as a string.\r\n  ator\\\":\\\"\\r\\n\\\"}'\r\n\r\nAdditional options are passed down to `jsdcodeshift`.\r\n```\r\n\r\n### Available codemods\r\n\r\nTo update to **4.0.0** version of **AppUI** use `v4.0.0/full` codemod. Alternatively, distinct codemods can be found under [v4.0.0](./src/v4.0.0/) directory.\r\n\r\n### Debug `jscodeshift` options\r\n\r\nUse `--debug` to print options provided to `jscodeshift`.\r\n\r\n### Recast options\r\n\r\nUse `--printOptions` to pass down options to recast's printer. See: <https://github.com/benjamn/recast/blob/master/lib/options.ts>\r\n"
}