Skip to content

Commit

Permalink
Merge pull request chipsalliance#1084 from hzeller/update-readme-poin…
Browse files Browse the repository at this point in the history
…t-to-ls

Update toplevel README to point to language server.
  • Loading branch information
hzeller authored Nov 4, 2021
2 parents 5dc8b11 + f96cb5b commit f49690d
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 1 deletion.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -147,6 +147,15 @@ TODO(fangism): a demo GIF animation here.
See https://github.com/chipsalliance/verible/issues/528
-->

### Language Server

The [`verible-verilog-ls`](./verilog/tools/ls) is a language server that
provides the functionalities that come with the Verible command line tools
also directly in your edtior.

It implements the standardized [language server protocol] that is supported
by a myriad of editors and IDEs.

### Lexical Diff

[`verible-verilog-diff`](./verilog/tools/diff) compares two input files for
Expand Down Expand Up @@ -202,3 +211,4 @@ abstract syntax tree (AST). If you are interested in collaborating, contact us.
[lint-rule-list_line-length]: https://chipsalliance.github.io/verible/lint.html#line-length
[lint-rule-list_no-tabs]: https://chipsalliance.github.io/verible/lint.html#no-tabs
[binary releases]: https://github.com/chipsalliance/verible/releases
[language server protocol]: https://microsoft.github.io/language-server-protocol/
2 changes: 1 addition & 1 deletion verilog/tools/ls/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ progress
- [x] Publish diagnostics for syntax errors and lint rules
- [ ] Use lint configuration from `.rules.verible_lint` instead of all enabled
- [x] Provide code actions for autofixes provided by lint rules
- [ ] Generate file symbol outline ('navigation tree')
- [x] Generate file symbol outline ('navigation tree')
- [ ] Provide formatting.
- [ ] Highlight all the symbols that are the same as current under cursor.
- [ ] Find definition of symbol even if in another file.
Expand Down

0 comments on commit f49690d

Please sign in to comment.