Skip to content

Commit

Permalink
updated README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
uros-5 committed Apr 2, 2024
1 parent 5d834c2 commit 359df16
Show file tree
Hide file tree
Showing 14 changed files with 2,237 additions and 18 deletions.
Binary file added .github/completion2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .github/completion3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .github/diagnostics3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .github/document_symbols.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .github/hover2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .github/snippets.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
32 changes: 24 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<img src="https://github.com/uros-5/jinja-lsp/blob/main/.github/banner.png" alt="" />
<img src="https://raw.githubusercontent.com/uros-5/jinja-lsp/main/.github/banner.png" alt="" />

jinja-lsp enhances minijinja development experience by providing Helix/Nvim users with advanced features such as autocomplete, syntax highlighting, hover, goto definition, code actions and linting.

Expand All @@ -13,37 +13,52 @@ cargo install jinja-lsp

### Autocomplete

Intelligent suggestions for variables in current template, as well as variables and filters defined on backend side.
Intelligent suggestions for variables in current template, as well as variables, templates and filters defined on backend side.

<img src="https://github.com/uros-5/jinja-lsp/blob/main/.github/completion.png" alt="" />
<img src="https://raw.githubusercontent.com/uros-5/jinja-lsp/main/.github/completion.png" alt="" />

<img src="https://raw.githubusercontent.com/uros-5/jinja-lsp/main/.github/completion2.png" alt="" />

<img src="https://raw.githubusercontent.com/uros-5/jinja-lsp/main/.github/completion3.png" alt="" />

### Linting

Highlights errors and potential bugs in your jinja templates.

<img src="https://github.com/uros-5/jinja-lsp/blob/main/.github/diagnostics1.png" alt="" />
<img src="https://raw.githubusercontent.com/uros-5/jinja-lsp/main/.github/diagnostics1.png" alt="" />

<img src="https://github.com/uros-5/jinja-lsp/blob/main/.github/diagnostics2.png" alt="" />
<img src="https://raw.githubusercontent.com/uros-5/jinja-lsp/main/.github/diagnostics2.png" alt="" />

<img src="https://raw.githubusercontent.com/uros-5/jinja-lsp/main/.github/diagnostics3.png" alt="" />

### Hover Preview

See the complete filter description by hovering over it.
See the complete filter or variable description by hovering over it.

<img src="https://github.com/uros-5/jinja-lsp/blob/main/.github/hover.png" alt="" />
<img src="https://raw.githubusercontent.com/uros-5/jinja-lsp/main/.github/hover.png" alt="" />

<img src="https://raw.githubusercontent.com/uros-5/jinja-lsp/main/.github/hover2.png" alt="" />

### Code Actions

It's recommended to reset variables on server in case you rename/delete file.

<img src="https://github.com/uros-5/jinja-lsp/blob/main/.github/code_actions.png" alt="" />
<img src="https://raw.githubusercontent.com/uros-5/jinja-lsp/main/.github/code_actions.png" alt="" />

### Goto Definition

Quickly jump to definition. Works for Rust identifiers as well.

https://github.com/uros-5/jinja-lsp/assets/59397844/015e47b4-b6f6-47c0-8504-5ce79ebafb00

### Snippets

<img src="https://raw.githubusercontent.com/uros-5/jinja-lsp/main/.github/snippets.png" alt="" />

### Document symbols

<img src="https://raw.githubusercontent.com/uros-5/jinja-lsp/main/.github/document_symbols.png" alt="" />

## Configuration

Language server configuration
Expand All @@ -65,3 +80,4 @@ name = "jinja"
language-servers = ["jinja-lsp"]
```

[VSCode support](https://marketplace.visualstudio.com/search?term=jinja-lsp&target=VSCode&category=Other&sortBy=Relevance)
4 changes: 2 additions & 2 deletions editors/code/.vscodeignore
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
.vscode
node_modules
client/node_modules
out/
src/
tsconfig.json
webpack.config.js
client/**
target
target
21 changes: 21 additions & 0 deletions editors/code/LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2022 IWANABETHATGUY

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
1 change: 1 addition & 0 deletions editors/code/README.md
2 changes: 1 addition & 1 deletion editors/code/client/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"description": "VSCode part of a language server",
"author": "uros-5",
"license": "MIT",
"version": "0.1.61",
"version": "0.1.73",
"publisher": "uros",
"repository": {
"type": "git",
Expand Down
Binary file added editors/code/media/icon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 359df16

Please sign in to comment.