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

Take a look at codemod-cli #25

Open
danielo515 opened this issue Jun 14, 2021 · 3 comments
Open

Take a look at codemod-cli #25

danielo515 opened this issue Jun 14, 2021 · 3 comments
Labels
💬 discussion Ideas that need further discussion

Comments

@danielo515
Copy link
Contributor

Scanning npm for packages about codemods I have found codemod-cli:
https://www.npmjs.com/package/codemod-cli

It looks like a tool to create and manage collections of codemods. It takes care of:

  • creating a new project, which includes a CLI to easily execute the codemods as a standalone CLI tool
  • adding new codemods to the project, having an specific folder structure (that I find interesting)
  • testing the codemods
  • updating the documentation. Not sure how it does it, but I am pretty sure it picks the input and output fixtures to generate the examples

Maybe you should consider contacting the author and talk him about the codeshift community, or at least add it to the resources section?

@danieldelcore
Copy link
Contributor

This is great, this is actually exactly what I'm hoping to do with the CLI!

Most of that stuff is already built and working for codemods in the community folder, but not yet available for use externally via the CLI. That's what i'm planning to do next!

@danielo515
Copy link
Contributor Author

danielo515 commented Jun 17, 2021 via email

@danieldelcore
Copy link
Contributor

Yeah absolutely, I actually made a bit of a start on this by generating some simple docs for the community folder here: https://www.codeshiftcommunity.com/docs/atlaskit__avatar

I wanted to extend that with a script that parses the tests/fixtures and renders them on the docs page as well.
Not sure how that would look external to the repo, but it's definitely something worth investing in!

@danieldelcore danieldelcore added the 💬 discussion Ideas that need further discussion label Dec 24, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
💬 discussion Ideas that need further discussion
Projects
None yet
Development

No branches or pull requests

2 participants