https://github.com/benelan/calcite-codemod

Code modification tool for automatically updating applications after breaking changes to Calcite Design System packages
https://github.com/benelan/calcite-codemod

calcite calcite-components calcite-design-system calcite-design-tokens cli codemod esri npm-package published vanilla-javascript

Last synced: about 22 hours ago
JSON representation

Code modification tool for automatically updating applications after breaking changes to Calcite Design System packages

• Host: GitHub
• URL: https://github.com/benelan/calcite-codemod
• Owner: benelan
• License: mit
• Created: 2023-12-05T01:32:55.000Z (10 months ago)
• Default Branch: master
• Last Pushed: 2023-12-13T23:33:46.000Z (10 months ago)
• Last Synced: 2024-09-17T03:50:51.070Z (18 days ago)
• Topics: calcite, calcite-components, calcite-design-system, calcite-design-tokens, cli, codemod, esri, npm-package, published, vanilla-javascript
• Language: JavaScript
• Homepage: https://www.npmjs.com/package/calcite-codemod
• Size: 58.6 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# Calcite Codemod

This is a small (unofficial) tool for automatically updating code after breaking changes to Calcite Design System packages.

The major version of this package will always align with the major version of [`@esri/calcite-components`](https://www.npmjs.com/package/@esri/calcite-components) that it targets.

However, this package may not be updated for every major release of Calcite Components.

The current iteration of this package renames the CSS variables used to modify the styles of Calcite Components.

Please read the [Calcite Components v2 changelog](https://github.com/Esri/calcite-design-system/blob/main/packages/calcite-components/package.json) for a full list of breaking changes.

## Installation

Install [the package](https://www.npmjs.com/package/calcite-codemod) globally and use it anywhere:

```bash

npm i -g calcite-codemod@v2

```

Use it in a single application:

```bash

npm i -D calcite-codemod@v2

```

Or try it out before installing:

```bash

npx calcite-codemod "styles.css" "index.html" "src/*.js"

```

> **NOTE:** You cannot specify the version of a package when using `npx`, so make sure the current major version of `calcite-codemod` aligns with your major version of `@esri/calcite-components`. Otherwise, use one of the previous installation methods above.

## Using the CLI

`calcite-codemod` provides a command line interface (CLI) that renames the CSS Variables in your application.

The CLI requires one or more arguments specifying which files/directories to update. The arguments support glob syntax.

For more information, see this [glob primer](https://github.com/isaacs/node-glob#glob-primer) by the package `calcite-codemod` uses internally.

Here are a couple usage examples:

```sh

# replace occurrences of renamed CSS variables in style.css, index.html, and all js files in src/

calcite-codemod "styles.css" "index.html" "src/*.js"

# all js/ts/jsx/tsx/css/scss files in src/ and all of its child directories

calcite-codemod "src/**/*.{js,ts,jsx,tsx,css,scss}"

# same as the previous example, except a lot more confusing

calcite-codemod "src/**/*.{{j,t}s{x,},{s,}css}"

```

## Using the CSS

This package also contains a CSS file that maps the old variable names to the new ones.

Add this to your application so you can update to Calcite Components v2 before renaming all the CSS Variables.

```html

```