Commit Graph

31 Commits

Author SHA1 Message Date
XeroOl
ea826576e3 clean up some documentation and code 2025-07-17 14:43:53 -05:00
XeroOl
c5f36ac813 clean up documentation strings 2025-07-14 01:14:31 -05:00
XeroOl
b0760a2aad stop tracking doc/lints.md 2025-07-13 13:05:50 -05:00
XeroOl
ff601e4c17 docs/lints.md is now a generated file. maybe I shouldn't keep it tracked anymore, lol 2025-07-12 21:40:44 -05:00
XeroOl
d219cfffcb clean up some lint documentation 2025-07-12 16:02:21 -05:00
XeroOl
772d59fff1 more changes to the linting system 2025-07-11 18:22:16 -05:00
XeroOl
6826c7584d maintenance of makefile and tools 2025-06-28 00:47:15 -05:00
Phil Hagelberg
ac2ce4d8f2 Fix linting example. 2025-06-27 14:02:38 -07:00
XeroOl
13415a97d3 minor edits to the lint descriptions
I hope these edits make the lint descriptions a bit clearer, but I'm not
sure
2025-06-02 22:41:53 -05:00
XeroOl
04fec49059 lint explanations
These are here mainly for when I get around to mirroring these over
to my website. Then we could link a user to an explanation.

https://xerool.net/fennel-ls/docs/lints.html#lint-name

The descriptions of these are inspired by the Rust Language's Clippy
lint descriptions. Check their page out for ways to deal with a large
number of lints.

https://rust-lang.github.io/rust-clippy/rust-1.86.0/index.html
2025-06-02 22:36:11 -05:00
Michele Campeotto
b0ba117232 Add instructions to use fennel-ls with Helix. 2025-03-22 12:11:04 -07:00
Phil Hagelberg
66bc08a616 Remove luarocks packaging files. 2025-03-09 12:34:15 -07:00
Phil Hagelberg
488add028f Remove nix packaging scripts.
You can get it from nixpkgs already.
2025-03-09 12:18:32 -07:00
Phil Hagelberg
e48aa8af89 Generate man page using pandoc.
Needs a few tweaks to make it usable but we can just append/prepend
them in the makefile target.
2025-03-04 09:19:36 -08:00
Phil Hagelberg
f2f661cc73 A few more documentation tweaks. 2025-03-04 08:56:49 -08:00
Michele Campeotto
c993f83595 Added a quick start section to the configuration manual
I received feedback that the info on setting up libraries is a little
buried in all the other details.

Pulling it up, it's likely going to be the first and most frequent
configuration people will want to change.
2025-03-04 08:44:19 -08:00
Phil Hagelberg
2c71c403d4 Remove outdated mentions to love2d and link to vs-code extension. 2025-03-02 08:41:37 -08:00
Michele Campeotto
1f123c6baa Add docsets information and some reorg 2025-03-02 08:31:20 -08:00
Phil Hagelberg
aaf30a99be Update TODOs and other associated docs. 2025-02-27 19:53:33 -08:00
Phil Hagelberg
d23d36a414 Support :union as lua-version setting. 2025-02-26 23:09:11 -08:00
Phil Hagelberg
98cd94d212 Add aliases for lua-versions.
Now you can specify "lua54" OR "lua5.4" and get what you need.
2025-02-26 01:38:58 -08:00
Phil Hagelberg
2edb9c4df5 Update to fennel 1.5.3 2025-02-16 17:20:32 -08:00
Phil Hagelberg
6cddd6a030 Explain that love2d support is opt-in for licensing reasons.
Booooooooo GFDL.

Also include a link to apt.technomancy.us.
2025-02-15 09:51:54 -08:00
XeroOl
bfc6d64237 docs: add a table for lspconfig to be happy 2025-01-16 20:55:30 -06:00
Phil Hagelberg
e5dc04764c Allow trailing underscores to bypass unused local warnings. 2025-01-05 12:40:25 -08:00
Matthew Lyon
e4e5054876 Add instructions for configuring Sublime Text 2024-10-10 19:56:30 -05:00
Phil Hagelberg
a27f42bfa4 Add match-should-case lint and fix action.
When a `match` call's patterns do not contain any symbols that reference
the outer scope, then there is no reason to use `match`; that call
should be replaced with `case`.

This allocates diagnostic code 308 to match-should-case.

In order to detect this, I had to add a loop over file.lexicals. This
is often a very large table, so it could adverse performance impact. I
believe it is necessary in order to distinguish between case vs match
since other means seem to only be applied after macroexpansion by
which time neither one exists.

I've updated docs/linting.md to mention the new loop and cleaned up a
few things in that file that were outdated.

I've added tests for the new lint to ensure it doesn't trigger when it
shouldn't.
2024-10-10 19:46:59 -05:00
Phil Hagelberg
1c6999ea3f Fix loading of globals from love2d generated documentation.
The first thing to change is to load the love2d docset inside a pcall,
because it's not included in the standard `make` build, so we need to
not crash if it's not present. Note that we are storing these under
libraries.love2d rather than libraries.love-2d, because even tho it's
inconsistent with tic-80; I've never seen them use the hyphenated
version, and now the name matches the module name.

Secondly, we extend the get-global function to work with anything in
the server.configuration.libraries table, not just hard-coded to
tic-80.

Finally, update the manual to reflect the removal of the love2d hypen.
2024-09-07 15:00:13 -07:00
Emma
f0c512575e Add Love2D API generation flag option to make docs target 2024-09-07 12:33:57 -04:00
Emma
0e0121825d WIP adding Love2D configuration 2024-09-07 11:12:32 -04:00
XeroOl
e493b0e21f Reorganize the readme files 2024-07-07 23:29:46 -05:00