Replies: 6 comments 90 replies
-
Use case: FormatterDo you think Biome's formatter should support plugins? If so, what kind of things you want to use it for? Please keep in mind we cannot format anything we cannot parse. Does that mean our parser should support plugins too? Speak your mind! |
Beta Was this translation helpful? Give feedback.
-
|
I would like to see if we could use a plugin from prettier like this https://github.com/trivago/prettier-plugin-sort-imports or biome could support by config (e.g: below is example config from avencera/rustywind#48) {
"exec": {
"associations": "**/*.{jsx,tsx,html}",
"commands": [{
"command": "rustywind --stdin",
"exts": ["jsx", "tsx", "html"],
}],
},
"excludes": [
"**/node_modules",
"**/*-lock.json",
],
"plugins": [
"https://plugins.dprint.dev/exec-0.4.4.json@c207bf9b9a4ee1f0ecb75c594f774924baf62e8e53a2ce9d873816a408cecbf7",
],
} |
Beta Was this translation helpful? Give feedback.
-
|
For HTML Formatter I'd like to see next options:
|
Beta Was this translation helpful? Give feedback.
-
|
If an alternate ternary formatting for types is not considered, a formatter plugin would offer an escape hatch for what I otherwise find a big issue for readability (see #2388). |
Beta Was this translation helpful? Give feedback.
This comment was marked as off-topic.
This comment was marked as off-topic.
This comment was marked as off-topic.
This comment was marked as off-topic.
-
Use case: LinterDo you think Biome's linter should support plugins? If so, do you have specific rules in mind? What kind of API do you think we could use to report diagnostics? How would we support fixers? Let us know! |
Beta Was this translation helpful? Give feedback.
-
|
The fact that there are so many of these things is how I'm sure that these sorts of query languages are one piece of the overall puzzle. It would be a pleasure for many of them to have implementations written for my VM. |
Beta Was this translation helpful? Give feedback.
-
|
One major theme I notice with the alternatives being mentioned, is that most seem to do querying only? Whereas Grit seems to be querying + transformation. Are there others that do transformation as well? |
Beta Was this translation helpful? Give feedback.
-
|
@morgante If I'm not mistaken, grit currently doesn't work with embedded script tags (vue/svelte/astro files). |
Beta Was this translation helpful? Give feedback.
-
|
Parsing embedded scripts is fine - Biome just needs to choose which code regions to analyze. |
Beta Was this translation helpful? Give feedback.
This comment was marked as off-topic.
This comment was marked as off-topic.
-
Use case: TransformerDo you think Biome's upcoming transformer functionality (see roadmap) should support plugins? Or maybe it should even be built around plugins from the ground up? Your ideas are appreciated! |
Beta Was this translation helpful? Give feedback.
-
|
The second problem with a non-pure AST is that you don't really know if it's printable. Whenever you make up a program out of an AST to be safe you really need to print it and then parse what you printed, because many printers if not most printers will gladly emit illegal syntax when confronted with subtly incorrect object trees. After all, if they handled all those edge cases, they would just be parsers! |
Beta Was this translation helpful? Give feedback.
-
|
Also how would you know what to disallow? Some code may need to be formatted using unicode escapes in identifiers due to limitations in textual encoding scheme, for example. You can't rely on being able to make a hard and fast rule against unicode escapes, which will occur in more normal places like strings too. |
Beta Was this translation helpful? Give feedback.
-
|
transformation will be very helpful for custom usage (say transforming i18n, custom jsx syntax, or special decorators) if (node.name === 'longlongname') node.name = 'short'Exposing CST details may make the transformation conflict with the formatter. CST can be stored somewhere in the data structure since biome needs it for later formatting, but exposing it to plugin users seems to be more complicated and slower than not. |
Beta Was this translation helpful? Give feedback.
-
|
@HerringtonDarkholme How are you suggesting that would be implemented? Would |
Beta Was this translation helpful? Give feedback.
-
I would argue it should be a facade (probably a JS proxy) wrapping Rust data structure. Serializing/deserializing a whole tree will be very expensive. A facade can avoid the cost and only deserialize sub-tree. Also see similar issue in oxc-project/oxc#1680
Yes |
Beta Was this translation helpful? Give feedback.
-
Use case: Query engineLinter and Formatter are too task-specific. What underlies each of them is querying, and querying is a desirable ability even in the absence of the need to change formatting or detect known mistakes. If Biome is the thing tasked with understanding conceptual overlays on your code, I would definitely hope that I respond to queries without requiring me to define a lint rule or a formatter plugin. |
Beta Was this translation helpful? Give feedback.
-
|
even if the plugin is wasm? |
Beta Was this translation helpful? Give feedback.
-
|
@DaniGuardiola Yeah, unfortunately I don't think WASM will have that much of an advantage over JS/TS here, since we would still need to serialize a codebase-wide traversal from Rust to the plugin. |
Beta Was this translation helpful? Give feedback.
-
|
@arendjr You say you'd need to serialize the traversal from Rust to the plugin, but remember that you might only be doing that work once for the entire set of plugins running in the scripting environment |
Beta Was this translation helpful? Give feedback.
-
|
My point is that whether that cost is too high to pay (or even has much impact on perf at all) depends greatly on what benefit you derive from it. |
Beta Was this translation helpful? Give feedback.
-
|
@arendjr @DaniGuardiola Feel free to hit me up and talk about Knip, happy to chat about it. |
Beta Was this translation helpful? Give feedback.
-
Use case: Codemodhttps://github.com/facebookarchive/codemod Codemods can be used to help migrate codebases or adopt new patterns. |
Beta Was this translation helpful? Give feedback.
-
|
I like it. I suspect if we have transformer plugins, it should be relatively straightforward to offer codemod functionality too, no? It’s maybe a tough question to answer since we don’t have transforms yet, or do you see something particular that stands out? |
Beta Was this translation helpful? Give feedback.
-
|
Codemods are definitely dependent on transforms, but they're one-off operations so I'm not sure you would configure them as part of something like biome's |
Beta Was this translation helpful? Give feedback.
-
|
or npm package |
Beta Was this translation helpful? Give feedback.
-
|
If Biome provides codemod functionality, I think its advantages are unclear. There may be people who want the performance benefits that come with Biome. However, since codemods are typically used only once, I don't think performance is a important factor. |
Beta Was this translation helpful? Give feedback.
-
|
whether codemod should be a separate topic from transformation mainly depends on the transformation API. |
Beta Was this translation helpful? Give feedback.
This comment has been hidden.
This comment has been hidden.
This comment has been hidden.
This comment has been hidden.
This comment has been hidden.
This comment has been hidden.
and others
-
Update: A follow-up RFC, based on the results and discussions here, has been presented: #1762
As many of you are aware, Biome's roadmap for 2024 includes the goal to develop a plugin system. But as the post mentioned, we don't yet know what those plugins will look like, what use cases they will cover and/or what technology we will use to implement them. What we do know, is there are plenty of ideas out there :)
So rather than proposing a specific solution, this RFC is intended to gather your input: What functionality do you miss in Biome, and do you think a plugin might help to cover it? What are you looking forward to in plugins the most? What will make or break our plugin system in your mind? This is the place to speak up!
I have attached a poll to take people's votes on preferred technology choices, and I will also create a few threads to help guide the discussion around various use cases. If you think anything is missing, feel free to create your own! You can also upvote use cases you think should be prioritized.
350 votes ·
Beta Was this translation helpful? Give feedback.
All reactions