Take a look at codemod-cli

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

132 stars 18 forks source link

Take a look at codemod-cli #25

Open danielo515 opened 3 years ago

danielo515 commented 3 years ago

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 commented 3 years ago

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 commented 3 years ago

One that I find particularly interesting is the documentation generation. Many codemod repositories lack good documentation (specially examples) so having them automatically is a big plus. If you don't have it planned I can take a look

El jue., 17 jun. 2021 1:41, Daniel Del Core @.***> escribió:

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!

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub https://github.com/CodeshiftCommunity/CodeshiftCommunity/issues/25#issuecomment-862803294, or unsubscribe https://github.com/notifications/unsubscribe-auth/AARKJWNXG6LJY2EHMFIQUEDTTEZCFANCNFSM46UTJTMQ .

danieldelcore commented 3 years ago

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!