@hashicorp/design-system-codemods/README.md

Helios Design System codemods

# codemods

A collection of codemods for Helios components.

## Usage

To run a specific codemod (for example the `v3/dropdown`) in your project using `npx`, you would run the following:

```bash
npx @hashicorp/design-system-codemods v3/dropdown path/to/some/glob/**/*.hbs
```

## Local usage

To run a specific codemod (for example the `v3/dropdown`) in this repository (even before publishing it), you would run the following from the root directory of this repository:

```bash
node ./packages/codemods/bin/cli.js v3/dropdown path/to/some/glob/**/*.hbs
```

## Transforms

### v3

* [v3/dropdown](transforms/v3/dropdown/README.md)
* [v3/masked-input](transforms/v3/masked-input/README.md)
* [v3/radio-card](transforms/v3/radio-card/README.md)
* [v3/side-nav](transforms/v3/side-nav/README.md)

### v4
<!--TRANSFORMS_START-->
* [v4/contextual-components](transforms/v4/contextual-components/README.md)
* [v4/dropdown-list-item-interactive](transforms/v4/dropdown-list-item-interactive/README.md)
* [v4/table](transforms/v4/table/README.md)
* [v4/icon](transforms/v4/icon/README.md)
<!--TRANSFORMS_END-->

## Contributing

### Installation

* clone the repo
* change into the repo directory
* `pnpm i`

### Running tests

* `pnpm test`

### Update documentation

* `pnpm update-docs`