errata-ai / vale-vscode

A Visual Studio Code extension for the Vale CLI.
https://marketplace.visualstudio.com/items?itemName=errata-ai.vale-server
MIT License
53 stars 18 forks source link

Need documentation on actions #109

Open ChrisChinchilla opened 2 years ago

ChrisChinchilla commented 2 years ago

Now that adding an action is part of Vale CLI, docs need instructions on how to add them to a rule

jdkato commented 1 year ago

The old docs are at the end of this page: https://github.com/errata-ai/docs/blob/main/website/docs/vale-server/concepts/styles.mdx

jdillard commented 1 year ago

Do the replace, remove, convert, and edit action types currently work with VSCode, they just aren't documented? suggest doesn't seem to be supported in VSCode, as the README says "Spelling errors are currently not supported", but it doesn't mention that the other's aren't supported.

I was using VSCode to test the functionality of actions and I can get replace and remove to work, but haven't been able to get convert or edit to work.

ChrisChinchilla commented 1 year ago

@jdillard It's basically all up to implementation. As part of the spelling feature I wam currently nearly done with, there will be a fair bit of refactoring anyway. So watch this space. Basically, it just responds to whatever action is set in a rule. We have various we encourage people to use, but really, you could use whatever you wanted and if an extension reacts to it, it will work…