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 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 for a full list of breaking changes.

Installation

Install the package globally and use it anywhere:

npm i -g calcite-codemod@v2

Use it in a single application:

npm i -D calcite-codemod@v2

Or try it out before installing:

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 by the package calcite-codemod uses internally.

Here are a couple usage examples:

# 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.

<script
  type="module"
  src="https://cdn.jsdelivr.net/npm/@esri/calcite-components@v2/dist/calcite/calcite.esm.js"
></script>
<link
  rel="stylesheet"
  type="text/css"
  href="https://cdn.jsdelivr.net/npm/@esri/calcite-components@v2/dist/calcite/calcite.css"
/>

<!-- Make sure to add `legacy-tokens.css` after `calcite.css` -->
<link
  rel="stylesheet"
  type="text/css"
  href="https://cdn.jsdelivr.net/npm/calcite-codemod@v2/dist/legacy-tokens.css"
/>