mirror of
https://github.com/swarm-game/swarm.git
synced 2024-08-17 18:41:02 +03:00
Towards #1494. Replaced/restricted uses of `Prelude.tail` and `Prelude.!!`. Quarantined `undefined`. Introduced a new function `listEnumsNonempty` that is guaranteed safe.
76 lines
2.4 KiB
YAML
76 lines
2.4 KiB
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]
|
|
|
|
# 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: Data.List.head, within: []}
|
|
- {name: Prelude.head, within: []}
|
|
- {name: Data.List.NonEmpty.fromList, within: [Swarm.Util]}
|
|
- {name: Prelude.tail, within: []}
|
|
- {name: Prelude.!!, within: [Swarm.Util.indexWrapNonEmpty, TestEval]}
|
|
- {name: undefined, within: [Swarm.Language.Key, TestUtil]}
|
|
- {name: fromJust, within: []}
|
|
# - {name: Data.Map.!, within: []} # TODO: #1494
|
|
# - {name: error, within: []} # TODO: #1494
|
|
|
|
# Add custom hints for this project
|
|
#
|
|
# Will suggest replacing "wibbleMany [myvar]" with "wibbleOne myvar"
|
|
# - error: {lhs: "wibbleMany [x]", rhs: wibbleOne x}
|
|
|
|
- warn: {lhs: a $ b $ c $ d, rhs: a . b . c $ d}
|
|
|
|
# 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}
|
|
|
|
|
|
# Ignore some builtin hints
|
|
# - ignore: {name: Use let}
|
|
# - ignore: {name: Use const, within: SpecialModule} # Only within certain modules
|
|
|
|
- ignore: {name: Use if}
|
|
|
|
# Define some custom infix operators
|
|
# - fixity: infixr 3 ~^#^~
|
|
|
|
|
|
# To generate a suitable file for HLint do:
|
|
# $ hlint --default > .hlint.yaml
|