.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
#
#
# included default-extensions from simulation/ouroboros-leios-sim.cabal
- arguments: [-XDisambiguateRecordFields, -XOverloadedRecordDot, -XScopedTypeVariables]

# 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:
    # Ensure that MonadDelay is imported from TimeCompat
    - name:
        - "Data.Time.**"
        - "Control.Monad.Class.MonadTime"
        - "Control.Monad.Class.MonadTime.SI"
        - "Control.Monad.Class.MonadTimer"
        - "Control.Monad.Class.MonadTimer.SI"
      within: "TimeCompat"
      message: "Use TimeCompat instead"
    # Ensure that MonadSTM is imported from STMCompat
    - name: "Control.Concurrent.Class.MonadSTM"
      within: "STMCompat"
      message: "Use STMCompat instead"
    # Ensure that Ouroboros.Network primitives are imported from PraosProtocol.Common hierarchy
    - name: "Ouroboros.Network.AnchoredFragment"
      within: "PraosProtocol.Common.AnchoredFragment"
      message: "Use PraosProtocol.Common.AnchoredFragment instead"
    - name: "Ouroboros.Network.Mock.Chain"
      within: "PraosProtocol.Common.Chain"
      message: "Use PraosProtocol.Common.Chain instead"
    - name: "Ouroboros.Network.Block"
      within: "PraosProtocol.Common.ConcreteBlock"
      message: "Use PraosProtocol.Common.ConcreteBlock instead"
    - name: "Ouroboros.Network.*"
      within:
        - "PraosProtocol.Common"
        - "PraosProtocol.Common.ConcreteBlock"
      message: "Use PraosProtocol.Common instead"
    # Ensure that PraosProtocol.Common hierarchy is only used from PraosProtocol
    - name: "PraosProtocol.Common"
      within:
        - "PraosProtocol.**"
        - "LeiosProtocol.Common"
# Add custom hints for this project
#
# Will suggest replacing "wibbleMany [myvar]" with "wibbleOne myvar"
# - error: {lhs: "wibbleMany [x]", rhs: wibbleOne x}

# The hints are named by the string they display in warning messages.
# For example, if you see a warning starting like
#
# Main.hs:116:51: Warning: Redundant ==
#
# You can refer to that hint with `{name: Redundant ==}` (see below).

# 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}
#
# Warn on use of partial functions
# - group: {name: partial, enabled: true}

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

# Ignores all builting hints.
- ignore: {}

# Re-enables the warning configured with `modules` above.
- warning: {name: "Avoid restricted module"}

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

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