Skip to content

Add missing config options in documentation #2203

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 14 commits into from
Sep 20, 2021
Merged

Add missing config options in documentation #2203

Changes from 1 commit
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
6963a49
Add missing config options
jneira Sep 17, 2021
6d7e5f3
Section about generic plugin configuration
jneira Sep 17, 2021
4c64727
Add plugin specific config
jneira Sep 17, 2021
022080e
Mark haskell.completionSnippetsOn as deprecated
jneira Sep 17, 2021
2fb2ba9
Merge branch 'master' into doc-config
jneira Sep 17, 2021
8e77cbb
Remove unused diagnosticsDebounceDuration
jneira Sep 17, 2021
8035f3e
Correct typos
jneira Sep 17, 2021
c731c96
Change tone of using hie.yaml suggestion
jneira Sep 17, 2021
477e9d0
Update exclude list precommit hook
jneira Sep 17, 2021
676d0ff
Remove diagnosticsDebounceDuration from source code
jneira Sep 17, 2021
1fd1379
Correct typo
jneira Sep 18, 2021
fbd51d4
Merge branch 'master' into doc-config
mergify[bot] Sep 18, 2021
b06318b
Merge branch 'master' into doc-config
jneira Sep 19, 2021
8563167
Merge branch 'master' into doc-config
mergify[bot] Sep 19, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 9 additions & 6 deletions docs/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,13 +40,16 @@ This option obviously would not make sense for language servers for other langua

Here is a list of the additional settings currently supported by `haskell-language-server`, along with their setting key (you may not need to know this) and default:

- Formatting provider (`haskell.formattingProvider`, default `ormolu`): what formatter to use; one of `floskell`, `ormolu`, `fourmolu`, `stylish-haskell`, or `brittany` (if compiled with the brittany plugin)
- Format on imports (`haskell.formatOnImportOn`, default true): whether to format after adding an import
- Diagnostics on change (`haskell.diagnosticsOnChange`, default true): (currently unused)
- Completion snippets (`haskell.completionSnippetsOn`, default true): whether to support completion snippets
- Liquid Haskell (`haskell.liquidOn`, default false): whether to enable Liquid Haskell support (currently unused until the Liquid Haskell support is functional again)
- Hlint (`haskell.hlintOn`, default true): whether to enable Hlint support
- Formatting provider (`haskell.formattingProvider`, default `ormolu`): what formatter to use; one of `floskell`, `ormolu`, `fourmolu`, `stylish-haskell`, or `brittany` (if compiled with the brittany plugin).
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think these might be better as tables?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yeah, it will look cleaner

- Format on imports (`haskell.formatOnImportOn`, default true): whether to format after adding an import.
- Diagnostics on change (`haskell.diagnosticsOnChange`, default true): (currently unused).
- Diagnostics debounce duration (`haskell.diagnosticsDebounceDuration`, default 350000 milliseconds).
- Completion snippets (`haskell.completionSnippetsOn`, default true): whether to support completion snippets.
- Liquid Haskell (`haskell.liquidOn`, default false): whether to enable Liquid Haskell support (currently unused until the Liquid Haskell support is functional again, see <https://github.com/haskell/haskell-language-server/issues/367>).
- Hlint (`haskell.hlintOn`, default true): whether to enable Hlint support.
- Max completions (`haskell.maxCompletions`, default 40): maximum number of completions sent to the LSP client.
- Check project (`haskell.checkProject`, default true): whether to typecheck the entire project on load. AS it is activate by default could drive to bad perfomance in large projects.
- Check parents (`haskell.checkParents`, default `CheckOnSaveAndClose`): when to typecheck reverse dependencies of a file; one of `NeverCheck`, `CheckOnClose`, `CheckOnSaveAndClose`, or `AlwaysCheck`.
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If it can affect performance it should be noted how


Settings like this are typically provided by the language-specific LSP client support for your editor, for example in Emacs by `lsp-haskell`.

Expand Down