# HLint configuration file
# https://github.com/ndmitchell/hlint
##########################

# This file contains a template configuration file, which is typically
# placed as .hlint.yaml in the root of your project


# Warnings currently triggered by your code
- suggest: {name: "Unused LANGUAGE pragma"}
- suggest: {name: "Eta reduce"}

# Warnings currently ignored
- ignore: {name: "Use list literal pattern"}
- ignore: {name: "Use tuple-section"} # requires GHC extension
- ignore: {name: "Use fromMaybe"} # may want to use this suggestion, but it didn't match the common idiom of the library
- ignore: {name: "Use unless"} # low power-to-weight
- ignore: {name: "Reduce duplication"}
- ignore: {name: "Use <>"}
- ignore: {name: "Use fewer imports"}
- ignore: {name: "Use camelCase"}
- ignore: {name: "Use <$>"}
- ignore: {name: "Use uncurry"}
- ignore: {name: "Redundant $!"}
- ignore: {name: "Use fmap"}
- ignore: {name: "Use ++"}
- ignore: {name: "Replace case with maybe"} # case is more readable
- ignore: {name: "Use mapMaybe"} # does not make any difference

# Warnings ignored in specific places
- ignore: {name: "Use mapM", within: Stream.Transform}
- ignore: {name: "Use traverse", within: Stream.Transform}
- ignore: {name: "Redundant <*", within: Stream.Expand}
- ignore: {name: "Redundant bracket", within: Stream.Split}
- ignore: {name: "Use isDigit", within: Streamly.Internal.Unicode.Parser}

# Specify additional command line arguments
#
- arguments:
    [ --cpp-include=src
    , --cpp-include=src/Streamly/Internal/Data/Stream
    , --cpp-include=core/src/Streamly/Internal/Data/Array
    , --cpp-include=test
    , --cpp-define=CABAL_OS_LINUX
    , --cpp-define=linux_HOST_OS
    ]


# Control which extensions/flags/modules/functions can be used
#
# - extensions:
#   - default: false # all extension are banned by default
#   - name: [PatternGuards, ViewPatterns] # only these listed extensions can be used
#   - {name: CPP, within: CrossPlatform} # CPP can only be used in a given module
#
# - flags:
#   - {name: -w, within: []} # -w is allowed nowhere
#
# - modules:
#   - {name: [Data.Set, Data.HashSet], as: Set} # if you import Data.Set qualified, it must be as 'Set'
#   - {name: Control.Arrow, within: []} # Certain modules are banned entirely
#
# - functions:
#   - {name: unsafePerformIO, within: []} # unsafePerformIO can only appear in no modules


# Add custom hints for this project
#
# Will suggest replacing "wibbleMany [myvar]" with "wibbleOne myvar"
# - error: {lhs: "wibbleMany [x]", rhs: wibbleOne x}


# Turn on hints that are off by default
#
# Ban "module X(module X) where", to require a real export list
- warn: {name: Use explicit module export list}
#
# Replace a $ b $ c with a . b $ c
# - group: {name: dollar, enabled: true}
#
# Generalise map to fmap, ++ to <>
- group: {name: generalise, enabled: true}


# Ignore some builtin hints
# - ignore: {name: Use let}
# - ignore: {name: Use const, within: SpecialModule} # Only within certain modules


# Define some custom infix operators
# - fixity: infixr 3 ~^#^~


# To generate a suitable file for HLint do:
# $ hlint --default > .hlint.yaml