Canvas Kit Codemods

This package is designed to help you migrate between major versions of Canvas Kit and adopt API changes.

Usage

> npx @workday/canvas-kit-codemod <transform> [path]

Commands (transforms):
  canvas-kit-codemod v5 [path]  Canvas Kit v4 > v5 migration transform

Options:
  --ignore-config,  Ignore files if they match patterns sourced from a config file [string]
  --ignore-pattern, Ignore files that match a provided glob expression             [string] [default: **/node_modules/**]
  --verbose,        Show more information about the transform process              [number] [choices: 0, 1, 2] [default: 0]
  -v, --version     Show version number                                            [boolean]
  -h, --help        Show help                                                      [boolean]

Note: These codemods only work on .js, .jsx, .ts, and .tsx extensions. You may need to make some manual changes in other file types (.json, .mdx, .md, etc.).

Note: You may need to run your linter after executing the codemod, as it's resulting formatting (spacing, quotes, etc.) may not match your project's styling.

Installation

Alternatively, you can install the codemod package and run it without npx.

> yarn add @workday/canvas-kit-codemod
> canvas-kit-codemod <transform> [path]

Options

Ignore Config

If you'd like to provide a configuration for files to ignore instead of a glob, use --ignore-config.

> canvas-kit-codemod <transform> [path] --ignore-config=.gitignore

Ignore Pattern

If you'd like to provide a glob to ignore files, use --ignore-pattern. By default, this is set to ignore all node_modules directories.

> canvas-kit-codemod <transform> [path] --ignore-pattern=**/dist/**

Verbose

If you'd like to have more verbose logging to know which files are being parsed, use --verbose. By default this is set to 0.

# See all files being parsed
> canvas-kit-codemod <transform> [path] --verbose=2