Skip to content

Commit

Permalink
docs: Clarify call for maintainers
Browse files Browse the repository at this point in the history
  • Loading branch information
Sidnioulz committed Jan 29, 2024
1 parent 1c401cc commit 0f38334
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,13 @@ This project couldn't exist without the prior work done by [vue-codemod](https:/

This project also takes inspiration from [vue-template-ast-to-template](https://github.com/CommanderXL/vue-template-ast-to-template), a Vue 2 template stringifier. `vue-sfcmod` was rewritten from scratch to target Vue 3 ASTs, however.

**Call for maintainers 🛟📣:** I'm looking for co-maintainers with expertise on the Vue compiler. The lack of documentation on the compiler prevents me from fully implementing an API and stringifier for Vue codemodding. I have to reverse engineer the AST and figure out what's expected, and I run into occasional limitations that I believe are due to the compiler not being written with codemodding in mind. I need help from someone with expertise in Vue's internal behaviour and with the ability to push for change within the Vue compiler ecosystem if needed. I remain committed to improving the CLI for this project to ensure it can conveniently be used for codemodding and static analysis, but I'm unlikely to keep improving the Vue API on my own as I do not need Vue support any more in my day job.
## Call for maintainers 🛟📣

**I'm looking for co-maintainers with expertise on the Vue.js compiler.** The lack of documentation on the compiler prevents me from fully implementing an API and stringifier for Vue codemodding. I have to reverse engineer the AST and figure out what's expected, and I run into occasional limitations that I believe are due to the compiler not being written with codemodding in mind.

**I need help from someone with expertise in Vue.js internals** and with the ability to push for change within the Vue compiler ecosystem if needed. There are limitations to what vue-sfcmod can do (described below in this README) that I can't work around without changes to the compiler to directly support rewriting an AST into source code. I am also stuck with codegen nodes, as part of their execution context is handled implicitly and they can't be passed to a JS codemodding engine as is without reconstructing the context (which I don't know how to do since the context isn't documented).

I can't justify the time it takes me to reverse engineer the AST to improve coverage, so I'm unlikely to keep improving the Vue API on my own. However, **I remain committed to improving the CLI to support both codemodding and static analysis** needs.

## Install

Expand Down

0 comments on commit 0f38334

Please sign in to comment.