diff --git a/.changeset/lazy-shirts-bet.md b/.changeset/lazy-shirts-bet.md new file mode 100644 index 00000000..5d0cb9a4 --- /dev/null +++ b/.changeset/lazy-shirts-bet.md @@ -0,0 +1,5 @@ +--- +"docs-app-for-codemod-utils": patch +--- + +Described codemod-utils as a framework for writing codemods diff --git a/README.md b/README.md index 7c5769a9..e25ab5f8 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ # @codemod-utils -_Utilities for writing codemods_ +_Framework for writing codemods_ ## What are codemods? @@ -20,7 +20,7 @@ In short, codemods are everywhere and you’ve likely used a few already. ## What is codemod-utils? -`codemod-utils` provides a set of **tools and conventions** to help you write codemods. Use [`@codemod-utils/cli`](./packages/cli/README.md) to get started. +`codemod-utils` provides a **framework** (tools and conventions) to help you write codemods. Use [`@codemod-utils/cli`](./packages/cli/README.md) to get started. ```sh pnpx @codemod-utils/cli @@ -69,6 +69,7 @@ Visit https://codemod-utils.netlify.app/. 1. [ember-codemod-v1-to-v2](https://github.com/ijlee2/ember-codemod-v1-to-v2) 1. [ignore-lint-errors](https://github.com/ijlee2/ignore-lint-errors) 1. [prettier-plugin-ember-hbs-tag](https://github.com/ijlee2/prettier-plugin-ember-hbs-tag/) +1. [shadcn-ember](https://github.com/IgnaceMaes/shadcn-ember/tree/main/packages/cli) 1. [type-css-modules](https://github.com/ijlee2/embroider-css-modules/tree/main/packages/type-css-modules) 1. [update-workspace-root-version](https://github.com/ijlee2/update-workspace-root-version) diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts index 1a1c5ecf..d4a693e3 100644 --- a/docs/.vitepress/config.mts +++ b/docs/.vitepress/config.mts @@ -5,7 +5,7 @@ import { sidebar } from './sidebar.mts'; export default defineConfig({ base: '/', cleanUrls: true, - description: 'Utilities for writing codemods', + description: 'Framework for writing codemods', markdown: { anchor: { level: [2, 3], diff --git a/docs/src/docs/index.md b/docs/src/docs/index.md index 7720cf17..d20ef432 100644 --- a/docs/src/docs/index.md +++ b/docs/src/docs/index.md @@ -13,7 +13,7 @@ In short, codemods are everywhere and you’ve likely used a few already. ## What is codemod-utils? -`codemod-utils` provides a set of **tools and conventions** to help you write codemods. Use `@codemod-utils/cli` to get started. +`codemod-utils` provides a **framework** (tools and conventions) to help you write codemods. Use `@codemod-utils/cli` to get started. ```sh {:no-line-numbers} pnpx @codemod-utils/cli @@ -57,5 +57,6 @@ pnpx @codemod-utils/cli 1. [ember-codemod-v1-to-v2](https://github.com/ijlee2/ember-codemod-v1-to-v2) 1. [ignore-lint-errors](https://github.com/ijlee2/ignore-lint-errors) 1. [prettier-plugin-ember-hbs-tag](https://github.com/ijlee2/prettier-plugin-ember-hbs-tag/) +1. [shadcn-ember](https://github.com/IgnaceMaes/shadcn-ember/tree/main/packages/cli) 1. [type-css-modules](https://github.com/ijlee2/embroider-css-modules/tree/main/packages/type-css-modules) 1. [update-workspace-root-version](https://github.com/ijlee2/update-workspace-root-version) diff --git a/docs/src/index.md b/docs/src/index.md index 7f7823f2..b52abc14 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -3,7 +3,7 @@ layout: home hero: name: codemod-utils - tagline: Utilities for writing codemods + tagline: Framework for writing codemods actions: - link: /docs