hypermod-io / hypermod-community

Community-owned global registry and documentation hub for codemods. Write & run codemods, share them with your friends!
https://hypermod.io
MIT License
133 stars 18 forks source link

`codeshift-cli` package doesn't exist on npm #79

Open kiprasmel opened 2 years ago

kiprasmel commented 2 years ago

hey, the stuff you added in https://github.com/CodeshiftCommunity/CodeshiftCommunity/pull/58 is very exciting!

i think only problem is that the codeshift-cli package is not available on npm yet?

i would actually consider naming it codemods-cli - since end consumers of the library don't necessarily know what "codeshift" is, but do know what a "codemod" is - i think it'd be better understandable.

danieldelcore commented 2 years ago

Hey @kiprasmel 👋

The cli should be available on npm after installing it via the module name npm install -g @codeshift/cli.

Unfortunately, there's no way to make the cli command match the module name due to an npm bug 😢 so the cli command is currently codeshift-cli. However I would be open to adding the alias you suggested to the bin property of the package.json. Feel free to contribute that if you like!

kiprasmel commented 2 years ago

oh yes, after installing it, it's fine. but i was thinking - most people who will be consuming codemods,

  1. they don't need to use the cli often, so using through npx would be better, and
  2. they don't know much about the codeshift stuff, but they know about codemods, thus i think naming the binary codemods-cli, not codeshift-cli, would be better, and
  3. combining both, it'd be best to have an npm package called codemods-cli, so that both 1. and 2. are utilised, and the end consumer can do npx codemods-cli - both short and intuitive.

so you'd need to somehow publish to another package, codemods-cli, and make the npx codemods-cli work out of the box.