Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[docs] Update codemod documentation #19661

Merged
merged 2 commits into from
Feb 12, 2020

Conversation

larsenwork
Copy link
Contributor

Changes to docs:

  1. Recommend npx instead of global install
  2. Recommend installing codemod as dev-dependency

Background:

  1. npm install -g for a one-time operation like a codemod seems like unnecessary bloat
  2. There doesn't seem to be any reason why @material-ui/codemod should be more than a dev-dependency (unless I'm missing something).

Side-note: I searched for npm install -g in the entire repo and this is the only location it's used.

@mui-pr-bot
Copy link

No bundle size changes comparing c3756df...350b240

Generated by 🚫 dangerJS against 350b240

@oliviertassinari oliviertassinari added the docs Improvements or additions to the documentation label Feb 11, 2020
@oliviertassinari oliviertassinari changed the title Update codemod documentation [docs] Update codemod documentation Feb 11, 2020
@oliviertassinari oliviertassinari merged commit d99fdd9 into mui:master Feb 12, 2020
@oliviertassinari
Copy link
Member

@larsenwork Thanks

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to the documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants