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

move documentation check to later

Browse Source
This commit is contained in:
XeroOl 2025-07-14 22:56:49 -05:00
parent 20b9381eda
commit c0a740461b
3 changed files with 25 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
src/fennel-ls/lint.fnl
View File

@ -22,10 +22,6 @@ the `file.diagnostics` field, filling it with diagnostics."
(local all-lints []) (local all-lints [])
(fn add-lint [name lint ...] (fn add-lint [name lint ...]
(when (not= (type lint.what-it-does) "string") (error (.. name " needs a description of what it does in :what-it-does")))
(when (not= (type lint.why-care?) "string") (error (.. name " needs a description of why the linted pattern is bad in :why-care?")))
(when (not= (type lint.example) "string") (error (.. name " needs an example of broken and fixed code in :example")))
(when (not= (type lint.since) "string") (error (.. name " needs version: :since " (view utils.version))))
(when (= nil lint.type) (error (.. name " needs a type. available types: " (view (icollect [k (pairs lints)] k))))) (when (= nil lint.type) (error (.. name " needs a type. available types: " (view (icollect [k (pairs lints)] k)))))
;; lint.limitations is optional ;; lint.limitations is optional
@ -635,8 +631,8 @@ the `file.diagnostics` field, filling it with diagnostics."
(let [number-of-args (- (length ast) (let [number-of-args (- (length ast)
(if (and (sym? (. ast 1)) (if (and (sym? (. ast 1))
(string.find (tostring (. ast 1)) ".:")) (string.find (tostring (. ast 1)) ".:"))
0 0 ; method call; the head counts as an argument
1)) 1)) ; function call; the head doesn't count as an argument
passes-extra-args (and (not= 1 (length ast)) passes-extra-args (and (not= 1 (length ast))
(possibly-multival? (. ast (length ast)))) (possibly-multival? (. ast (length ast))))
(min-params infinite-params?) (faccumulate [(last-required-argument vararg) nil (min-params infinite-params?) (faccumulate [(last-required-argument vararg) nil
@ -693,8 +689,8 @@ the `file.diagnostics` field, filling it with diagnostics."
{:name \"Bob\" {:name \"Bob\"
:age 25} :age 25}
```" ```"
:since "0.2.0"
:type :other :type :other
:since :0.2.2-dev
:impl (fn [server file] :impl (fn [server file]
(let [seen []] (let [seen []]
(each [ast (pairs file.lexical)] (each [ast (pairs file.lexical)]
@ -708,7 +704,7 @@ the `file.diagnostics` field, filling it with diagnostics."
(+ i 1)))] (+ i 1)))]
(when (. keys dkey) (when (. keys dkey)
(coroutine.yield (coroutine.yield
{:code :duplicate-table-keys {:code :duplicate-table-keys ; TODO we should fix `other` type lints so the code isn't necessary
:range (message.ast->range server file ast) :range (message.ast->range server file ast)
:message (.. "key " (tostring (. keys dkey)) " appears more than once") :message (.. "key " (tostring (. keys dkey)) " appears more than once")
:severity message.severity.WARN})) :severity message.severity.WARN}))

3
test/init.fnl
View File

@ -27,4 +27,5 @@
:test.code-action :test.code-action
:test.rename :test.rename
:test.misc :test.misc
:test.cli])) :test.cli
:test.meta]))

19
test/meta.fnl Normal file
View File

@ -0,0 +1,19 @@
(local {: view} (require :fennel))
(local lint (require :fennel-ls.lint))
(local utils (require :fennel-ls.utils))
(fn test-lints-are-documented []
(each [_ lint (ipairs lint.list)]
(let [name lint.name]
(when (not= (type lint.what-it-does) "string") (error (.. name " needs a description of what it does in :what-it-does")))
(when (not= (type lint.why-care?) "string") (error (.. name " needs a description of why the linted pattern is bad in :why-care?")))
(when (not= (type lint.example) "string") (error (.. name " needs an example of broken and fixed code in :example")))
(when (not= (type lint.since) "string") (error (.. name " needs version: :since " (view utils.version)))))))
;; other ideas:
;; selflint
;; docs on top of each file
;; makefile covers
{: test-lints-are-documented}