Possible to pass options to HLint?

[tfausak]

I have my HLint config in a non-standard location. Is it possible to pass --hint my-hlint-config.yaml through to HLint? Without it I get only the default hints.

[jneira]

Hi, i've transferred the issue to haskell-language-server, as it is the responsive for hlint integration (concretely the hls-hlint-plugin).

Actually there is no way to pass that option to hlint plugin but i think it could be a nice addition, the code that loads the hlint config is here:

haskell-language-server/plugins/hls-hlint-plugin/src/Ide/Plugin/Hlint.hs

Lines 261 to 266 in 1b245ca

	getHlintSettingsRule :: HlintUsage -> Rules ()
	getHlintSettingsRule usage =
	defineNoFile $ \GetHlintSettings ->
	liftIO $ case usage of
	HlintEnabled cmdArgs -> argsSettings cmdArgs
	HlintDisabled -> fail "hlint configuration unspecified"

And it would need to add a config option in a still missing specific section for hlint, like tactics has done here:

• getting the config

haskell-language-server/plugins/hls-tactics-plugin/src/Ide/Plugin/Tactic/LanguageServer.hs

Lines 86 to 91 in 1b245ca

	getTacticConfig :: MonadLsp Plugin.Config m => ShakeExtras -> m Config
	getTacticConfig extras = do
	pcfg <- getPluginConfig extras "tactics"
	pure $ case fromJSON $ Object $ plcConfig pcfg of
	Success cfg -> cfg
	Error _ -> emptyConfig

• with type
  

  haskell-language-server/plugins/hls-tactics-plugin/src/Ide/Plugin/Tactic/Types.hs

  Lines 86 to 90 in db72348

  	-- | Plugin configuration for tactics
  	data Config = Config
  	{ cfg_feature_set :: FeatureSet
  	, cfg_max_use_ctor_actions :: Int
  	}

[rmehri01]

Hi, I'd like to help out with this if possible!

[jneira]

@rmehri01 nice! tha main steps are sketched in the above comment. The configuration structure has changed so it does the way to deal with it, i will update this with the relevant code sites

[rmehri01]

I think I got the basic idea of what to do since I got it compiling but when I was testing to see if it works, I ran into this FIXME for argsSettings, which getHlintSettingsRule calls. Does this mean --hint will not work with it?

Edit: looks like this issue might be related but for everything instead of just --hint.

[jneira]

@rmehri01 many thanks for continue working on this, sorry but i had no time to update links to actual code

Edit: looks like this issue might be related but for everything instead of just --hint.

Not sure about that one, i can see (parseFlags, _, _) <- argsSettings [ "-XQuasiQuotes" ] works in that issue (so it works at least for lang exts args)

I ran into this FIXME for argsSettings, which getHlintSettingsRule calls. Does this mean --hint will not work with it?

It is possible (maybe @ndmitchell could help us confirming it). However, i would continue working on this, we could improve hlint support threrafter.

[ndmitchell]

I suspect that FIXME isn't relevant. However, the issues in ndmitchell/hlint#1232 might well be relevant. It looks like the HLint configuration stuff as currently exposed has some weird issues.

[rmehri01]

Ah I see, getHlintSettingsRule only seems to be called with getHlintSettingsRule (HlintEnabled []), so I changed to using a modified version of autoSettings instead and now passing the custom config works!

The only thing is that autoSettings doesn't seem to support other settings like argsSettings does, so do we still want to be able to add other settings too?

[jneira]

Ah I see, getHlintSettingsRule only seems to be called with getHlintSettingsRule (HlintEnabled []), so I changed to using autoSettings instead and now passing the custom config works!

mmm, not sure without taking a look to actual code but my idea was change getHlintSettingsRule (HlintEnabled []) for
getHlintSettingsRule (HlintEnabled listOfArgsFromLspConfig), so we could continue using argsSettings, which would use the list of args supplied in the config

[rmehri01]

mmm, not sure without taking a look to actual code but my idea was change getHlintSettingsRule (HlintEnabled [])
for getHlintSettingsRule (HlintEnabled listOfArgsFromLspConfig), so we could continue using argsSettings, which would use the list of args supplied in the config

Yeah this would definitely be easier and it was what I was trying at first, but I keep running into this error when using argsSettings with --hint, which is why I thought the FIXME was initially relevant:

*Ide.Plugin.Hlint Language.Haskell.HLint> argsSettings ["-h my-hlint-config.yaml"]
*** Exception: user error (Failed to find requested hint files:
   my-hlint-config.yaml
)

I tried using different file paths to make sure too. I might be doing something wrong though, I'm not sure.

However, i would continue working on this, we could improve hlint support threrafter.

So to clarify, you think it is better to do it this way for now, even though --hint might not work and then it can be improved in the future?