facebook / jscodeshift

A JavaScript codemod toolkit.
https://jscodeshift.com
MIT License
9.22k stars 477 forks source link

jsdoc can't be upgraded past version 3.7 #502

Open ElonVolo opened 2 years ago

ElonVolo commented 2 years ago

jsdoc can't be bumped up any higher than 3.7 because 3.8 and onwards makes use of a version of the klaw library that doesn't run on node versions less than 14 (which breaks jscodeshift's node 12 builds).

Revisit bumping up the jsdoc version to higher than 3.7 once node versions 13 and below are no longer supported by jscodeshift.

Daniel15 commented 2 years ago

I wonder if we should move the jsdoc to a Docusaurus site and have a separate build process for it (e.g. on Netlify).

ElonVolo commented 2 years ago

The biggest issue with the docs, IMHO, is a lack of information on how to debug codemods using the VSCode debugger. Which I did correct (albeit somewhat inelegantly) in evcodeshift’s docs, after spending way too much time hunting down the few rare examples of it on the Internet.

I’ve considered copy-pasting what’s in the evcodeshift docs into some part of the jscodeshift docs as a first attempt at taking on this problem. VSCode in-IDE codemod debugging would have saved me so much time and frustration when I first started out writing codemods.

(

Sent from my iPhone

On Apr 12, 2022, at 13:49, Daniel Lo Nigro @.***> wrote:

 I wonder if we should move the jsdoc to a Docusaurus site and have a separate build process for it (e.g. on Netlify).

— Reply to this email directly, view it on GitHub, or unsubscribe. You are receiving this because you authored the thread.