aboutsummaryrefslogtreecommitdiff
path: root/.hlint.yaml
blob: 4e3dc95a725415b40c9d50451350186ed19ad24d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
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=auto, --cpp-ansi]


# 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
# - ignore: {name: "Use section"}
# - ignore: {name: "Use camelCase"}
# - ignore: {name: "Use list comprehension"}
# - ignore: {name: "Redundant if"}
- ignore: {name: "Avoid lambda"}
- ignore: {name: "Eta reduce"}
- ignore: {name: "Evaluate"}
- ignore: {name: "Monad law, left identity", module: "Text.Pandoc.App.OutputSettings"}
- ignore: {name: "Reduce duplication", module: "Text.Pandoc.Readers.Markdown"}
- ignore: {name: "Use &&&"}
- ignore: {name: "Use String"}
- ignore: {name: "Use fmap"}  # specific for GHC 7.8 compat
- ignore: {name: "Use forM_", module: "Text.Pandoc.Readers.DocBook"}
- ignore: {name: "Use isDigit"}
- ignore: {name: "Use tuple-section", module: "Text.Pandoc.Readers.EPUB"}
- ignore: {name: "Use uncurry", module: "Text.Pandoc.Readers.Docx.Combine"}
- ignore:
    name: "Use <$>"
    within:
      - Text.Pandoc.Readers.LaTeX
      - Text.Pandoc.Readers.Markdown
- ignore:
    name: "Use camelCase"
    within:
      - Tests.Writers.Docbook
      - Tests.Writers.Native
      - Text.Pandoc.Extensions
      - Text.Pandoc.Lua.Marshaling.Version
      - Text.Pandoc.Lua.Module.Utils
      - Text.Pandoc.Readers.Odt.ContentReader
      - Text.Pandoc.Readers.Odt.Namespaces

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