Add codeActionsOnSave to docs #3938
Conversation
|
|
| @@ -213,6 +213,58 @@ Organize imports can also be automatically when you save a JavaScript file by se | |||
| "source.organizeImports": true | |||
| } | |||
| ``` | |||
| ## Code Actions on Save | |||
|
|
|||
| The `editor.codeActionsOnSave` setting lets you configure a set of Code Actions that are run when a file is saved. For example, you can enable organize imports on save by setting: | |||
There was a problem hiding this comment.
The content looks good but let's try to tighten it up. These documents quick overviews of features available for js/ts so we try to keep each section fairly small.
I’d say keep the first example and the list of available code actions. You can link to documentation on language specific settings and other more advanced features
docs/languages/typescript.md
Outdated
| "source.fixAll" | ||
| ] | ||
| ``` | ||
| Note: `editor.codeActionsOnSave` supports both object and array configs in settings. |
There was a problem hiding this comment.
For me, the documentation explaining the difference between array vs. object was important to understand... So the part above where you say that the array is used to execute in a specific order is the most important part. It seems that the explanation is redundant below (maybe‽)
docs/languages/javascript.md
Outdated
|
|
||
| The TSLint extension already uses `source.fixAll` Code Action kind to implement fix all and auto fix on save. | ||
|
|
||
| You can also set `editor.codeActionsOnSave` to an array of Code Actions to execute in order. You can use this to guarantee that a specific Code Action is always run before or after another one that may conflict with it. |
There was a problem hiding this comment.
If you remove some parts, please make sure, if possible, to keep this one where you explain the reason why one would prefer to choose the array vs. the object syntax (to execute in order) I think this is important to understand...
docs/languages/typescript.md
Outdated
| Here are some source actions: | ||
|
|
||
| * `"organizeImports"` - Enables organize imports on save. | ||
| * `"fixAll"` - Auto Fix on Save computes all possible fixes in one round (for all providers including ESLint). | ||
| * `"fixAll.eslint"` - Auto Fix only for ESLint. | ||
| * `"addMissingImports"` - Adds all missing imports on save. | ||
|
|
||
| The TSLint extension already uses `source.fixAll` Code Action kind to implement fix all and auto fix on save. | ||
|
|
||
| You can also set `editor.codeActionsOnSave` to an array of Code Actions to execute in order. You can use this to guarantee that a specific Code Action is always run before or after another one that may conflict with it. |
There was a problem hiding this comment.
Do you guys think it is possible to retain the part where you explain the reason why one should prefer using an array over an object ??
You can also set
editor.codeActionsOnSaveto an array of Code Actions to execute in order. You can use this to guarantee that a specific Code Action is always run before or after another one that may conflict with it.
The followingeditor.codeActionsOnSavewill always run Organize Imports followed by Fix All once organize imports finishes:
"editor.codeActionsOnSave": [
"source.organizeImports",
"source.fixAll"
]
docs/languages/javascript.md
Outdated
|
|
||
| You can also set `editor.codeActionsOnSave` to an array of Code Actions to execute in order. You can use this to guarantee that a specific Code Action is always run before or after another one that may conflict with it. |
There was a problem hiding this comment.
Can you keep this part (with or without the example‽) :
You can also set editor.codeActionsOnSave to an array of Code Actions to execute in order. You can use this to guarantee that a specific Code Action is always run before or after another one that may conflict with it.
|
Hey, I added array part back. Can you please confirm if it looks good ? |
| ] | ||
| ``` | ||
| Note: `editor.codeActionsOnSave` supports both object and array configs in settings. | ||
| See [TypeScript](/docs/typescript/typescript-tutorial) for more information. |
There was a problem hiding this comment.
I don't know if you prefer to link to a subsection instead but I found the subsection links just in case:
https://code.visualstudio.com/docs/getstarted/settings#_language-specific-editor-settings
For organizeImports specifically in TypeScript:
https://code.visualstudio.com/docs/languages/typescript#_organize-imports
| Here are some source actions: | ||
|
|
||
| * `"organizeImports"` - Enables organize imports on save. | ||
| * `"fixAll"` - Auto Fix on Save computes all possible fixes in one round (for all providers including ESLint). | ||
| * `"fixAll.eslint"` - Auto Fix only for ESLint. | ||
| * `"addMissingImports"` - Adds all missing imports on save. | ||
|
|
||
| The TSLint extension already uses `source.fixAll` Code Action kind to implement fix all and auto fix on save. | ||
| See [Node.js/JavaScript](/docs/nodejs/working-with-javascript) for more information. |
There was a problem hiding this comment.
I don't know if you prefer to link to a subsection instead but I found the subsection links just in case:
https://code.visualstudio.com/docs/getstarted/settings#_language-specific-editor-settings
For organizeImports specifically in Node.js/JavaScript:
https://code.visualstudio.com/docs/languages/javascript#_organize-imports
Fixes microsoft/vscode#104219