Skip to content

Commit

Permalink
[docs] Always mention the npm tag with npx (mui#40335)
Browse files Browse the repository at this point in the history
  • Loading branch information
oliviertassinari authored Dec 27, 2023
1 parent cfbf83e commit 81bcb11
Show file tree
Hide file tree
Showing 9 changed files with 97 additions and 97 deletions.
6 changes: 3 additions & 3 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -1369,7 +1369,7 @@ A big thanks to the 18 contributors who made this release possible. Here are som
A codemod is provided to help with the migration:

```bash
npx @mui/codemod v5.0.0/base-use-named-exports <path>
npx @mui/codemod@latest v5.0.0/base-use-named-exports <path>
```

#### Changes
Expand Down Expand Up @@ -2251,7 +2251,7 @@ A big thanks to the 18 contributors who made this release possible. Here are som
There is codemod that you can run in your project to do the transformation:

```bash
npx @mui/codemod v5.0.0/base-remove-component-prop <path>
npx @mui/codemod@latest v5.0.0/base-remove-component-prop <path>
```

The full documentation about the codemod can be found [here](https://github.com/mui/material-ui/blob/master/packages/mui-codemod/README.md#base-remove-component-prop).
Expand Down Expand Up @@ -2350,7 +2350,7 @@ A big thanks to the 12 contributors who made this release possible. Here are som
You can use this [codemod](https://github.com/mui/material-ui/blob/master/packages/mui-codemod/src/v5.0.0/base-remove-unstyled-suffix.js) to help with the migration:

```bash
npx @mui/codemod v5.0.0/base-remove-unstyled-suffix <path>
npx @mui/codemod@latest v5.0.0/base-remove-unstyled-suffix <path>
```

#### Changes
Expand Down
2 changes: 1 addition & 1 deletion docs/data/joy/components/text-field/text-field.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ To learn more why it has been removed, visit the [RFC](https://github.com/mui/ma
Run this [codemod](https://github.com/mui/material-ui/blob/master/packages/mui-codemod/README.md#joy-text-field-to-input) in your project's terminal:

```bash
npx @mui/codemod v5.0.0/joy-text-field-to-input <path>
npx @mui/codemod@latest v5.0.0/joy-text-field-to-input <path>
```

It will go through all files under `<path>` and replace `<TextField />` with the `<Input />` composition.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ If you want to refine them later, you can refer to the examples shown in the sec
:::

```bash
npx @mui/codemod v5.0.0/jss-to-styled <path>
npx @mui/codemod@latest v5.0.0/jss-to-styled <path>
```

Example transformation:
Expand Down Expand Up @@ -216,7 +216,7 @@ yarn add tss-react
We provide [a codemod](https://github.com/mui/material-ui/blob/master/packages/mui-codemod/README.md#jss-to-tss-react) to help migrate JSS styles to the `tss-react` API.

```bash
npx @mui/codemod v5.0.0/jss-to-tss-react <path>
npx @mui/codemod@latest v5.0.0/jss-to-tss-react <path>
```

Example transformation:
Expand Down
6 changes: 3 additions & 3 deletions docs/data/material/migration/migration-v4/migration-v4.md
Original file line number Diff line number Diff line change
Expand Up @@ -299,7 +299,7 @@ Make sure that your application still runs without errors after running each cod
This codemod contains most of the transformers that are necessary for migration. It should be only applied **once per folder.**

```bash
npx @mui/codemod v5.0.0/preset-safe <path>
npx @mui/codemod@latest v5.0.0/preset-safe <path>
```

:::info
Expand Down Expand Up @@ -331,7 +331,7 @@ createMuiTheme({
If you want to keep `variant="standard"` in your components, run this codemod or else configure the corresponding default theme props.

```bash
npx @mui/codemod v5.0.0/variant-prop <path>
npx @mui/codemod@latest v5.0.0/variant-prop <path>
```

For more details, check out the [variant-prop codemod README](https://github.com/mui/material-ui/blob/master/packages/mui-codemod/README.md#variant-prop).
Expand Down Expand Up @@ -361,7 +361,7 @@ createMuiTheme({
If you want to keep `underline="hover"`, run this codemod or else configure the corresponding default theme props.

```bash
npx @mui/codemod v5.0.0/link-underline-hover <path>
npx @mui/codemod@latest v5.0.0/link-underline-hover <path>
```

For more details, check out the [link-underline-hover codemod README](https://github.com/mui/material-ui/blob/master/packages/mui-codemod/README.md#link-underline-hover).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -204,7 +204,7 @@ For more details, see [this GitHub issue](https://github.com/mui/material-ui/iss
We recommend using this codemod to fix all imports in your project:

```bash
npx @mui/codemod v5.0.0/optimal-imports <path>
npx @mui/codemod@latest v5.0.0/optimal-imports <path>
```

You can fix it manually like this:
Expand Down
2 changes: 1 addition & 1 deletion docs/pages/blog/lab-date-pickers-to-mui-x.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ Follow the [migration steps](/x/migration/migration-pickers-lab/) by updating th
We have prepared a codemod to help you migrate your codebase from `@mui/lab` to `@mui/x-date-pickers` or `@mui/x-date-pickers-pro`:

```bash
npx @mui/codemod v5.0.0/date-pickers-moved-to-x <path>
npx @mui/codemod@latest v5.0.0/date-pickers-moved-to-x <path>
```

## Where is the Date and Time Picker documentation?
Expand Down
2 changes: 1 addition & 1 deletion docs/pages/blog/lab-tree-view-to-mui-x.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ or
We have prepared a codemod to help you migrate your codebase from `@mui/lab` to `@mui/x-tree-view`:

```bash
npx @mui/codemod v5.0.0/tree-view-moved-to-x <path>
npx @mui/codemod@latest v5.0.0/tree-view-moved-to-x <path>
```

## Where is the Tree View documentation?
Expand Down
Loading

0 comments on commit 81bcb11

Please sign in to comment.