This repository was archived by the owner on Oct 7, 2020. It is now read-only.

haskell/haskell-ide-enginePublic archive

NotificationsYou must be signed in to change notification settings
Fork205
Star2.4k

Added support for user configuration#1079

Open

colbyn wants to merge5 commits intohaskell:master

base:master

Choose a base branch

fromcolbyn:new-hie-yaml-config

Open

Added support for user configuration#1079

colbyn wants to merge5 commits intohaskell:masterfromcolbyn:new-hie-yaml-config

Conversation

Copy link

colbyn commentedFeb 5, 2019

This is something I added a little while ago and thought others may find this useful (includes a doc file./docs/hie-yaml-file.md).

The primary feature is to just simply disable interactive (as you type) analysis, as mentioned in the./docs/hie-yaml-file.md file. For a reference the RLS project has a similar option calledbuild_on_save (https://github.com/rust-lang/rls#configuration).

colbyn added2 commits

February 5, 2019 13:10

Added support for feature overrides via a configuration file called ‘…

6f58e0b

…hie.yaml’. See ‘./docs/hie-yaml-file.md’ for details.

Whoops, forgot to add module to cabal file.

ad95c12

Anrock requested review fromlukel97 andalanz

February 6, 2019 13:27

lukel97 reviewed

Feb 6, 2019

View reviewed changes

Copy link

Collaborator

lukel97 left a comment

Choose a reason for hiding this comment

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

Could these options be added to the LSP configuration settings, instead of creating a new file/format?

haskell-ide-engine/hie-plugin-api/Haskell/Ide/Engine/Config.hs

Lines 21 to 29 in7dd6fd7

	dataConfig=
	Config
	{hlintOn::Bool
	,maxNumberOfProblems::Int
	,diagnosticsDebounceDuration::Int
	,liquidOn::Bool
	,completionSnippetsOn::Bool
	,formatOnImportOn::Bool
	}deriving (Show,Eq)

colbyn added3 commits

February 23, 2019 15:15

Use preexisting config format.

5c0b947

Updated test file.

7c89ef5

Small changes to work with an older prelude.

c1f1468

Copy link

Author

colbyn commentedFeb 23, 2019

Certainly.

I’ve just implemented the necessary changes for using the preexisting settings format, and updated theREADME.md file. I’m not sure how it’s supposed to work in general. Perhaps it’s editor specific, yet for the life of me I couldn’t figure out how the json value/file is exchanged (from looking at thegetConfigFromNotification function)…

So as a workaround if the value isn’t available it defaults to checking for asettings.json file that then defaults to theDefault instance, i.e.configVal (onSaveOnly configFile) onSaveOnly >>= \case.

I suppose the name of this branch doesn’t make any sense now. I wasn’t sure what to rename it to so I left it as is.

Copy link

Collaborator

alanz commentedFeb 24, 2019

@colbyn

Thesettings.json format is described so that LSP clients can know what options to provide when sending the configuration message through. So strictly speaking managing settings is a client issue, not a server issue.

It is also not clear to my whether theonSaveOnly mechanism is the right one to use for this, the flag makes sense, but I am not sure whether it should rather be implemented via theTextDocumentSyncKind setting forTextDocumentSyncOptions from the server, to switch it from incremental to full.

Copy link

Collaborator

lukel97 commentedFeb 25, 2019

@colbyn The settings.json location depends on the client, for LanguageClient-neovim it should be in.vim/settings.json. For VS Code you need to expose it via the extension, which is done in javascript.I recently created a PR to add a new option to it here