mirror of
https://github.com/aelve/guide.git
synced 2024-12-22 20:31:31 +03:00
Add a HLint settings file
This commit is contained in:
parent
3821eeb001
commit
c5b0e561e9
86
.hlint.yaml
Normal file
86
.hlint.yaml
Normal file
@ -0,0 +1,86 @@
|
||||
# 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: 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
|
||||
|
||||
# these are too annoying
|
||||
- ignore: {name: "Redundant do"}
|
||||
- ignore: {name: "Redundant bracket"}
|
||||
- ignore: {name: "Redundant lambda"}
|
||||
- ignore: {name: "Redundant $"}
|
||||
- ignore: {name: "Redundant flip"}
|
||||
- ignore: {name: "Move brackets to avoid $"}
|
||||
|
||||
# losing variable names can be not-nice
|
||||
- ignore: {name: "Eta reduce"}
|
||||
- ignore: {name: "Avoid lambda"}
|
||||
|
||||
# humans often know better
|
||||
- ignore: {name: "Use camelCase"}
|
||||
- ignore: {name: "Use const"}
|
||||
- ignore: {name: "Use section"}
|
||||
- ignore: {name: "Use if"}
|
||||
- ignore: {name: "Use maybe"}
|
||||
|
||||
# sometimes [Char] is okay (if it means "a set of characters")
|
||||
- ignore: {name: "Use String"}
|
||||
|
||||
# some 'data' records will be extended with more fields later, so they
|
||||
# shouldn't be replaced with 'newtype' blindly
|
||||
- ignore: {name: "Use newtype instead of data"}
|
||||
|
||||
|
||||
# Define some custom infix operators
|
||||
# - fixity: infixr 3 ~^#^~
|
||||
|
||||
|
||||
# To generate a suitable file for HLint do:
|
||||
# $ hlint --default > .hlint.yaml
|
Loading…
Reference in New Issue
Block a user