hypermod-community icon indicating copy to clipboard operation
hypermod-community copied to clipboard

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

Open kiprasmel opened this issue 3 years ago • 2 comments

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.

kiprasmel avatar Dec 21 '21 11:12 kiprasmel

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!

danieldelcore avatar Dec 23 '21 22:12 danieldelcore

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.

kiprasmel avatar Jan 04 '22 13:01 kiprasmel