-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | GHC plugin for hlint
--   
--   This package provides a GHC plugin that runs <a>hlint</a> on the
--   compiled module. The main advantages of doing this are: (A) better
--   integration with GHC tooling, (B) only linting modules that change,
--   and (C) only parsing the module once. . Note that this package will
--   only build if you build the <tt>hlint</tt> dependency with
--   <tt>-f-ghc-lib</tt> and build the <tt>ghc-lib-parser-ex</tt>
--   dependency with <tt>-fno-ghc-lib</tt>
@package hlint-plugin
@version 1.0.2


-- | This module is inspired by:
--   
--   
--   <a>https://github.com/tfausak/splint/blob/9028a8b631568dc5d16a74153b1a9b6e3cde0fe6/src/lib/Splint/Settings.hs</a>
--   
--   … in order to work around this issue (just like <tt>splint</tt> does):
--   
--   <a>https://gitlab.haskell.org/ghc/ghc/issues/18261</a>
--   
--   Without this workaround the GHC plugin will fail with something like
--   this error message:
--   
--   <pre>
--   ghc-9.6.2(82937,0x16e83b000) malloc: *** error for object 0x600000a4d5c0: pointer being freed was not allocated
--   ghc-9.6.2(82937,0x16e83b000) malloc: *** set a breakpoint in malloc_error_break to debug
--   </pre>
module HLint.Plugin.Settings

-- | This is a drop-in replacement for
--   <a>Language.Haskell.HLint</a>.<a>argsSettings</a>, except that this is
--   safe to run in parallel.
argsSettings :: [String] -> IO (ParseFlags, [Classify], Hint)


-- | This module provides a GHC plugin that you can use to run HLint on a
--   module
--   
--   To do so, add this <tt>hlint-plugin</tt> package as a build dependency
--   of your Haskell package and then add the GHC options <tt>-fplugin
--   HLint.Plugin</tt> To use this plugin, add this package as a build
--   dependency and then enable the following GHC options (typically in the
--   <tt>ghc-options:</tt> field of your <tt>.cabal</tt> file):
--   
--   <pre>
--   -fplugin HLint.Plugin
--   </pre>
--   
--   You can pass command-line options to <tt>hlint</tt> using
--   <tt>-fplugin-opt</tt>, like this:
--   
--   <pre>
--   -fplugin HLint.Plugin -fplugin-opt='HLint.Plugin:--ignore=Redundant guard'
--   </pre>
module HLint.Plugin

-- | GHC plugin that runs HLint on a Haskell module after parsing the
--   module
plugin :: Plugin