Skip to content

Commit

Permalink
doc: add codemod for catalog (#554)
Browse files Browse the repository at this point in the history
* add codemod for catalog

update the doc and include codemod for catalog.

* update tip

---------

Co-authored-by: Zoltan Kochan <z@kochan.io>
  • Loading branch information
alexbit-codemod and zkochan authored Jul 10, 2024
1 parent 6e37a4a commit 8b8c4be
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions docs/catalogs.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,16 @@ Catalogs are defined in the `pnpm-workspace.yaml` file. There are two ways to de
1. Using the (singular) `catalog` field to create a catalog named `default`.
2. Using the (plural) `catalogs` field to create arbitrarily named catalogs.

:::tip

If you have an existing workspace that you want to migrate to using catalogs, you can use the following [codemod](https://go.codemod.com/pnpm-catalog):

```
pnpx codemod pnpm/catalog
```

:::

### Default Catalog

The top-level `catalog` field allows users to define a catalog named `default`.
Expand Down

0 comments on commit 8b8c4be

Please sign in to comment.