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

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

Open
kiprasmel opened this issue Dec 21, 2021 · 2 comments
Open

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

kiprasmel opened this issue Dec 21, 2021 · 2 comments
Labels
📚 docs Improvements or additions to documentation 📈 enhancement New feature or request 🤩 good first issue Good for newcomers

Comments

@kiprasmel
Copy link
Contributor

kiprasmel commented Dec 21, 2021

hey, the stuff you added in #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
Copy link
Contributor

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 danieldelcore added 📚 docs Improvements or additions to documentation 📈 enhancement New feature or request 🤩 good first issue Good for newcomers labels Dec 23, 2021
@kiprasmel
Copy link
Contributor Author

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📚 docs Improvements or additions to documentation 📈 enhancement New feature or request 🤩 good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants