facebook / jscodeshift

A JavaScript codemod toolkit.

Home Page:https://jscodeshift.com

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

can I access docs online?

sibelius opened this issue · comments

There's no docs online at the moment, but maybe we should publish the autogenerated API docs to GitHub Pages...

There's this, but it's not much better than reading the source:

https://npmdoc.github.io/node-npmdoc-jscodeshift/build/apidoc.html

We should migrate docs do docusuarus

Hey! I'm currently learning the tool to do some migrations at work and it's been quite hard to do things with it. I would like to help with the docs and maybe put some specific examples of how to use the API. Would need some mentoring though with the API from time to time. How can we move forward with this?

I'm one of the jscodeshift maintainers and even I end up referring back to tutorials if I haven't written a codemod in months. Doing anything with ast-types (a separate project that's the real business end up jscodeshift) is a bear but that is the library you have to learn to make maximal use of jscodeshift.

At this, my go-to is starting to be ChatGPT. Most of the code that gets generated has some mistakes, but it largely gets the ast-types constructor calls mostly right.

Hi @ElonVolo! thanks for replying. That's helpful! I probably need more AI in my life haha

Aside from that, I guess you're not interested in building a docs website, am I correct? 🤔