fey.naomi/fennel-ls
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Small changes to the lint instructions

Browse Source
This commit is contained in:
XeroOl 2024-02-18 16:16:18 -06:00
parent 5c19cb3a83
commit 130f96a4ca
1 changed files with 14 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
Adding-a-Lint-Rule.md
View File

@ -26,12 +26,13 @@ functions.
* `self` is the table that represents the language server. It carries metadata * `self` is the table that represents the language server. It carries metadata
and stuff around. You probably don't need to use it directly. and stuff around. You probably don't need to use it directly.
* `file` is an object that represents a .fnl file. It has some useful fields. * `file` is an object that represents a .fnl file. It has some useful fields.
Check out what fields it has by looking at the end of `compiler.fnl`. The Check out what fields it has by looking at the end of `compiler.fnl`.
most important one for lints is probably `lexical`. `file.lexical` stores the
value `true` for every single list, table, or symbol that appears in the `file.lexical` stores the value `true` for every single list, table, or symbo
original file AST. If your lint is supposed to apply to hand written code, that appears in the original file AST, and `nil` for things generated via
but doesn't really apply to generated code, you should make sure that the AST macroexpansion. Make sure that the AST you're checking is inside of
you're checking is inside of file.lexical. `file.lexical`; otherwise, your lint may not be actionable or relevant, because
the user won't be able to see or edit the code your lint is warning about.
The next arguments depend on which loop the lint is in: The next arguments depend on which loop the lint is in:
### If your lint is linting definitions: ### If your lint is linting definitions:
@ -60,18 +61,20 @@ the definitions will be:
{:definition `(my-expression) {:definition `(my-expression)
:binding `x :binding `x
:multival 1 :multival 1
:referenced-by {:symbol `x.field :target @1 :ref-type "read"}} :referenced-by {:symbol `x.myfield :target @1 :ref-type "read"}}
;; for y ;; for y
{:definition `(my-expression) :binding `y :multival 2 :keys [:foo :bar]} {:definition `(my-expression) :binding `y :multival 2 :keys [:foo :bar]}
``` ```
### If your lint is linting calls (to functions or specials, not macros) ### If your lint is linting calls (to functions or specials, not macros)
`head` is the symbol that is being called. It is the same as `(. call 1)`. * `head` is the symbol that is being called. It is the same as `(. call 1)`.
`call` is the list that represents the call. * `call` is the list that represents the call.
## Output: ## Output:
Return `nil` if there's nothing to report, return a diagnostic object with your Your lint function should return `nil` if there's nothing to report, or
lint. The return value should have these fields: return a diagnostic object representing your lint message.
The return value should have these fields:
* `range`: make these with `message.ast->range` to get the range for a list or * `range`: make these with `message.ast->range` to get the range for a list or
symbol or table, or with `message.multisym->range` to get the range of a symbol or table, or with `message.multisym->range` to get the range of a