Generic codemodding engine for Vue 3 - looking for co-maintainers

[Sidnioulz]

Hi folks,

Last year, I wrote https://github.com/Sidnioulz/vue-sfcmod as I needed to codemod Vue files, including HTML template sections. This project is a fork (and ~80% rewrite) of the original vue-codemod from the Vue core team, and I've added code to stringify HTML template ASTs and to edit template attributes for my personal needs.

vue-sfcmod has served me well, but I'm running into limitations in what I can do (at least with the amount of time I can devote to this project), and I would greatly appreciate involvement from someone who is more familiar with the Vue compiler's internals, and ideally someone who can help me overcome some of the limitations I'm encountering.

In other words: I'm looking for co-maintainers! This project can serve as a basis for codemodding Vue files, but also for people to run their own static analyses (design system coverage, QA metrics, presence of anti-patterns, whatever you like), so I'd love for it to live a long healthy life!

My roadmap for this project is roughly:

• To change how APIs are exposed so folks can write codemods that can find and edit patterns in HTML/JS/CSS at the same time
• To allow folks to use their own JS codemodding engine if they don't like jscodeshift
• To add a default CSS codemodding engine
• To support a run mode where instead of editing source files, vue-sfcmod produces reports, aka static analysis mode

[josh-hemphill]

Hi, have you found a way to add elements/components to the templates ast? I looked at vue-sfcmod, and I'm still not sure. I've been trying to track down how to do it reading through compiler-core, but haven't found anything obvious to do it.

[Sidnioulz]

Hi Josh,

I have added API endpoints to handle adding and editing attributes. It's possible I've forgotten to merge the branch 😆 but it's here: Sidnioulz/vue-sfcmod#49.

I haven't worked on adding components yet. I regret using the Vue compiler because the resulting AST is rather unique. I have started rewriting the AST to make it more predictable but I'm still a long shot from making it compliant with formats/libraries like https://github.com/syntax-tree/unist.

I don't work on Vue these days and I have quite a bit of work in the coming months so I don't plan on working on vue-sfcmod in the near future, hence the call for maintainers!

[josh-hemphill]

I wonder if I can do a partial parse on strings to insert, have you had any luck with expression parsing, vs whole file? I mean AST is supposed get away from string manipulation, but I can do it just for creating new sub-ASTs, then maybe it'll be fine.

[Sidnioulz]

The problem you'd face with this is know where to insert. You can't jump between the AST and string representations without compiling and stringifying, and you can't place strings in the middle of an AST (unless of course you patch the stringify algorithm to handle such strings ;) ).

The code has a fairly good test framework, and with a TDD based approach you could easily add API endpoints to create new nodes (hint hint ;) I welcome PRs ;) ).