-
Notifications
You must be signed in to change notification settings - Fork 226
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add documentation regarding the use of plugins #166
Labels
Comments
There is some information about the plugins via the CLI, though I agree that some Github documentation may be helpful. My steps for discovering this were:
yarn ts-migrate --help
Usage: npm run ts-migrate -- <command> [options]
Commands:
npm run ts-migrate -- init <folder> Initialize tsconfig.json file in <folder>
npm run ts-migrate -- init:extended <folder> Initialize tsconfig.json file in <folder>
npm run ts-migrate -- rename [options] <folder> Rename files in folder from JS/JSX to TS/TSX
npm run ts-migrate -- migrate [options] <folder> Fix TypeScript errors, using codemods
npm run ts-migrate -- reignore <folder> Re-run ts-ignore on a project
Options:
-h, --help Show help [boolean]
Examples:
npm run ts-migrate -- --help Show help
npm run ts-migrate -- migrate --help Show help for the migrate command
npm run ts-migrate -- init frontend/foo Create tsconfig.json file at
frontend/foo/tsconfig.json
npm run ts-migrate -- init:extended frontend/foo Create extended from the base tsconfig.json
file at frontend/foo/tsconfig.json
npm run ts-migrate -- rename frontend/foo Rename files in frontend/foo from JS/JSX to
TS/TSX
npm run ts-migrate -- rename frontend/foo --s Rename files in frontend/foo/bar/baz from
"bar/baz" JS/JSX to TS/TSX
yarn ts-migrate migrate --help
npm run ts-migrate -- migrate [options] <folder>
Fix TypeScript errors, using codemods
Positionals:
folder [string] [required]
Options:
-h, --help Show help [boolean]
--plugin Run a specific plugin
[string] [choices: "add-conversions", "declare-missing-class-properties", "eslint-fix",
"explicit-any", "hoist-class-statics", "jsdoc", "member-accessibility",
"react-class-lifecycle-methods", "react-class-state", "react-default-props", "react-props",
"react-shape", "strip-ts-ignore", "ts-ignore"]
--sources, -s Path to a subset of your project to rename (globs are ok). [string]
Examples:
migrate /frontend/foo Migrate all the files in /frontend/foo
npm run ts-migrate -- migrate /frontend/foo -s Migrate all the files in /frontend/foo/bar,
"bar/**/*" -s "node_modules/**/*.d.ts" accounting for ambient types from
node_modules.
npm run ts-migrate -- migrate /frontend/foo Migrate JSDoc comments for all the files in
--plugin jsdoc /frontend/foo Related: #147 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
There doesn't appear to be any documentation regarding the use of plugins. It turns out there is a
--plugin
flag which can activate specific plugins. However, I cannot figure out how options are sent to plugins via the command line, which is why I'm opening an issue instead of submitting a pull request.I want to suggest adding something along the lines of the following to
packages/ts-migrate
:The text was updated successfully, but these errors were encountered: