Document the affinity performance setting, closes #7606 (#8424)

This commit is contained in:
Paul "Joey" Clark 2023-09-10 08:05:39 +08:00 committed by GitHub
parent f03ac2a2f5
commit 764e95a683
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -113,6 +113,11 @@ Below is an example of a [settings.json](https://code.visualstudio.com/Docs/cust
"vim.handleKeys": {
"<C-a>": false,
"<C-f>": false
},
"// To improve performance",
"extensions.experimental.affinity": {
"vscodevim.vim": 1
}
}
```
@ -847,6 +852,18 @@ VS Code has a lot of nifty tricks and we try to preserve some of them:
This is a [known issue in VS Code](https://github.com/microsoft/vscode/issues/23991), as a workaround you can set `"keyboard.dispatch": "keyCode"` and restart VS Code.
- VSCodeVim is too slow!
You can try adding the following [setting](https://github.com/microsoft/vscode/issues/75627#issuecomment-1078827311), and reload/restart VSCode:
```json
"extensions.experimental.affinity": {
"vscodevim.vim": 1
}
```
**Caveats:** One issue with using the affinity setting is that each time you update your settings file, the Vim plugin will reload, which can take a few seconds.
## ❤️ Contributing
This project is maintained by a group of awesome [people](https://github.com/VSCodeVim/Vim/graphs/contributors) and contributions are extremely welcome :heart:. For a quick tutorial on how you can help, see our [contributing guide](/.github/CONTRIBUTING.md).