Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dmmulroy/ts-error-translator.nvim
https://github.com/dmmulroy/ts-error-translator.nvim
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/dmmulroy/ts-error-translator.nvim
- Owner: dmmulroy
- License: mit
- Created: 2023-10-09T02:29:13.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2024-02-27T16:17:29.000Z (3 months ago)
- Last Synced: 2024-02-27T18:51:12.301Z (3 months ago)
- Language: Lua
- Size: 41 KB
- Stars: 90
- Watchers: 3
- Forks: 2
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Lists
- awesome-neovim - dmmulroy/ts-error-translator.nvim - A port of Matt Pocock's ts-error-translator for VSCode for turning messy and confusing TypeScript errors into plain English. (Programming Languages Support / (requires Neovim 0.5))
- trackawesomelist - dmmulroy/ts-error-translator.nvim (⭐39) - A port of Matt Pocock's ts-error-translator for VSCode for turning messy and confusing TypeScript errors into plain English. (Recently Updated / [Feb 27, 2024](/content/2024/02/27/README.md))
README
# ts-error-translator.nvim
A Neovim port of [Matt Pocock's ts-error-translator for VSCode](https://github.com/mattpocock/ts-error-translator) for turning messy and confusing TypeScript errors into plain English.
## Installation
To install the plugin, use your preferred Neovim plugin manager.
### lazy.nvim
To install the plugin using lazy.nvim, add the following to your plugin configuration:
```lua
{ 'dmmulroy/ts-error-translator.nvim' }
```
### Packer
To install the plugin using packer.nvim, add the following to your plugin configuration:
```lua
use('dmmulroy/ts-error-translator.nvim',)
```
### Vim-Plug
To install the plugin using vim-plug, add the following to your plugin configuration:
```vim
Plug 'dmmulroy/ts-error-translator.nvim'
```
Then run `:PlugInstall` to install the plugin.
## Setup
To set up the plugin, add the following line to where you manage your plugins:
```lua
require("ts-error-translator").setup()
```
## Configuration
By default, `ts-error-translator.nvim` will attach itself to your `tsserver`
lsp and automatically start translating errors for you. The following is the
default configuration for the plugin:
```lua
{
auto_override_publish_diagnostics = true,
}
```
If you want to override `tsserver`'s `textDocument/publishDiagnostics` handler
`manually, ts-error-translator.nvim` exports a function,
`require('ts-error-translator').translate_diagnostics`, that you can
then use to override your lsp handlers. Here is example usage:
```lua
vim.lsp.handlers["textDocument/publishDiagnostics"] = function(err, result, ctx, config)
require("ts-error-translator").translate_diagnostics(err, result, ctx, config)
vim.lsp.diagnostic.on_publish_diagnostics(err, result, ctx, config)
end
```
## Related
If you like this plugin and find it useful, you might also like my plugin, [tsc.nvim](https://github.com/dmmulroy/tsc.nvim), a Neovim plugin for seamless, asynchronous project-wide TypeScript type-checking using the TypeScript compiler (tsc)
## Contributing
Feel free to open issues or submit pull requests if you encounter any bugs or have suggestions for improvements. Your contributions are welcome!
## License
This plugin is released under the MIT License. See the [LICENSE](LICENSE) file for details.
## Acknowledgements
A special thanks to [Matt Pocock](https://github.com/mattpocock) for creating the `ts-error-translator`, providing the foundation for this project.