.hlint.yaml

# 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


# Specify additional command line arguments
#
# - arguments: [--color, --cpp-simple, -XQuasiQuotes]
- arguments: [-XTypeApplications]


# 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

- modules:
  - {name: [Data.Map], within: []}


# 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

# This warning should apply to Control.Exception.evaluate, but is mistakenly
# applied to Kore.Step.SMT.Evaluator.evaluate.
- ignore: {name: "Redundant evaluate"}

# Corporate style
- ignore: {name: "Use tuple-section"}
- ignore: {name: "Use record patterns"}
- ignore: {name: "Use String"}
- ignore: {name: "Redundant id"}

# Ignore suggestions that may affect readability
- ignore: {name: "Eta reduce"}
- ignore: {name: "Avoid lambda using `infix`"}
- ignore: {name: "Use infix"}
- ignore: {name: "Use section"}
- ignore: {name: "Use <$>"}
- ignore: {name: "Redundant flip"}
- ignore: {name: "Monad law, left identity"}
- ignore: {name: "Monoid law, left identity"}
- ignore: {name: "Replace case with maybe"}
- ignore: {name: "Hoist not"}

# Permit existing duplication in tests.
# Please reflect before adding new modules to this list.
- ignore:
    name: Reduce duplication
    within:
      - Test.Kore
      - Test.Kore.AllPath
      - Test.Kore.ASTVerifier.DefinitionVerifier.Imports
      - Test.Kore.Builtin.Definition
      - Test.Kore.Builtin.InternalBytes
      - Test.Kore.Builtin.List
      - Test.Kore.Builtin.Map
      - Test.Kore.Builtin.Set
      - Test.Kore.Exec
      - Test.Kore.Internal.TermLike
      - Test.Kore.Parser.Parser
      - Test.Kore.Repl.Interpreter
      - Test.Kore.Step.EquationalStep
      - Test.Kore.Step.RewriteStep
      - Test.Kore.Step.Rule.Combine
      - Test.Kore.Step.Step
      - Test.Kore.Step.Substitution
      - Test.Kore.Strategies.AllPath.AllPath

# The placement of lambdas affects inlining.
- ignore: {name: Redundant lambda}

# Testing class laws
- ignore: {name: Functor law, within: [Test.Data.Sup, Test.ListT]}
- ignore: {name: Use /=, within: [Test.Data.Sup]}
- ignore: {name: "Alternative law, left identity", within: [Test.ListT]}
- ignore: {name: "Alternative law, right identity", within: [Test.ListT]}
- ignore: {name: "Monad law, right identity", within: [Test.ListT]}
- ignore: {name: "Use >=>", within: [Test.ListT]}
- ignore: {name: "Redundant id", within: [Test.ListT]}

- ignore:
    name: Use camelCase
    within:
      - Test.Terse
      - Test.Kore.Step.Axiom.Evaluate
      - Test.Kore.Step.Axiom.Matcher
      - Test.Kore.Step.Simplification.Overloading


# Unsuitable suggestions
- ignore:
    name: "Reduce duplication"
    within:
      - Kore.Builtin.Builtin
      - Kore.Builtin.List
      - Kore.Builtin.Symbols
      - Kore.Domain.Builtin
      - Kore.Exec
      - Kore.Internal.Conditional
      - Kore.Step.Axiom.Matcher
      - Kore.Step.Simplification.AndTerms
      - Kore.Parser.Parser
      - Main
- ignore:
    name: "Use fmap"
    within:
      - Kore.Step.Step
      - SQL.SOP
- ignore: {name: "Avoid lambda", within: [Kore.Step.Function.Memo]}
- ignore:
    name: "Redundant bracket"
    within:
      - Kore.Internal.TermLike.TermLike


# Haskell names match K names
- ignore:
    name: "Use camelCase"
    within:
      - Kore.Builtin.Map.Map
      - Kore.Builtin.MapSymbols
      - Kore.Debug

- ignore: {name: "Use newtype instead of data", within: [GlobalMain]}

- ignore: {name: "Redundant compare", within: [Kore.Syntax.Id]}


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


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