From f06d74273c080a5b3d475722a7c81e649149627a Mon Sep 17 00:00:00 2001 From: XeroOl Date: Wed, 3 May 2023 00:27:27 -0500 Subject: [PATCH] Description of Settings in the README --- README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/README.md b/README.md index 7b6a134..8fb6b55 100644 --- a/README.md +++ b/README.md @@ -39,6 +39,23 @@ Generally this involves somehow configuring this information: If you get it working in any other environments, I'd love to know! It would be great to have instructions on how to set up other editors! +# Default Settings + +fennel-ls can be configured over LSP. Any setting that's not provided will be filled in with the defaults, which means that `{}` will be a valid configuration with default settings. You can provide different settings in the same shape as the default settings in order to override the defaults. + +fennel-ls default settings: +```json +{ + "fennel-ls": { + "fennel-path": "./?.fnl;./?/init.fnl;src/?.fnl;src/?/init.fnl", + "macro-path": "./?.fnl;./?/init-macros.fnl;./?/init.fnl;src/?.fnl;src/?/init-macros.fnl;src/?/init.fnl", + "checks": { + "unused-definition": true + } + } +} +``` + ## License fennel-ls is licensed under the MIT license. See LICENSE for more info. This project also contains files from other projects: