# @workday/canvas-kit-codemod

> A collection of codemods for use on Workday Canvas Kit packages.

Latest version **16.2.3** (published 2026-10-16) · Apache-2.0 license · 1.7K weekly downloads

## Install

```sh
npm install @workday/canvas-kit-codemod
pnpm add @workday/canvas-kit-codemod
yarn add @workday/canvas-kit-codemod
bun add @workday/canvas-kit-codemod
```

Provides the command `canvas-kit-codemod`.

## Health

**Score 70/100 (B)** — status: active.

Positive: no vulnerabilities; has provenance; recently updated; high maintenance score.

Warnings: no types; no esm support.

## Facts

| | |
|---|---|
| Version | 16.2.3 |
| Published | 2026-10-16 |
| First published | 2021-03-22 |
| Weekly downloads | 1.7K |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 604.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Provenance | attested (GitHub Actions) |
| GitHub stars | 365 |
| Author | Workday, Inc. |
| Maintainers | workday-canvas-kit, mannycarrera4, raisa.primerova, alanbsmith, jaclynjessup, jheddings, sheelah |
| Keywords | workday, canvas, kit, codemod |

## Links

- npm: https://www.npmjs.com/package/@workday/canvas-kit-codemod
- Repository: https://github.com/Workday/canvas-kit
- Homepage: https://github.com/Workday/canvas-kit#readme
- Issues: https://github.com/Workday/canvas-kit/issues
- npm.io page: https://npm.io/package/@workday/canvas-kit-codemod

## Dependencies (3)

- [chalk](https://npm.io/package/chalk.md) 4.1.2
- [yargs](https://npm.io/package/yargs.md) ^16.2.0
- [jscodeshift](https://npm.io/package/jscodeshift.md) ^17.1.0

## Alternatives

- [@sveltejs/kit](https://npm.io/package/@sveltejs/kit.md) — 2.2M weekly downloads
- [@tangle-network/brand](https://npm.io/package/@tangle-network/brand.md) — 10.0K weekly downloads
- [seneca](https://npm.io/package/seneca.md) — 7.4K weekly downloads
- [@bsb/base](https://npm.io/package/@bsb/base.md) — 7.2K weekly downloads
- [@modern-js/plugin-swc](https://npm.io/package/@modern-js/plugin-swc.md) — 3.4K weekly downloads

## Recent versions

- 16.2.3 (latest) — 2026-10-16
- 17.0.0-alpha.0655-next.0 (prerelease-next) — 2026-10-14
- 16.2.0-0654-next.0 (next) — 2026-10-14
- 15.1.12 (support) — 2026-10-01
- 16.2.2 — 2026-10-15
- 16.2.1 — 2026-10-15
- 16.2.0 — 2026-10-14
- 17.0.0-alpha.0653-next.0 — 2026-10-14
- 16.1.12 — 2026-10-14
- 16.2.0-0648-next.0 — 2026-10-13
- 17.0.0-alpha.0649-next.0 — 2026-10-13
- 16.1.11 — 2026-10-13
- 17.0.0-alpha.0645-next.0 — 2026-10-12
- 16.2.0-0644-next.0 — 2026-10-12
- 16.1.10 — 2026-10-12
- … 1731 more at https://npm.io/package/@workday/canvas-kit-codemod/versions

## README

# Canvas Kit Codemods

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

## Usage

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

```sh
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.

```sh
> 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`.

```sh
> 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.

```sh
> 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`.

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

---
_Source: https://npm.io/package/@workday/canvas-kit-codemod · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
