website/sider.yml at main · Wayfapper/website · GitHub

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
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
# This is a configuration file to customize code analysis by Sider.
#
# For more information, see the documentation:
# https://help.sider.review/getting-started/custom-configuration

# Customize each tool. If analyzes fail, try adjusting each option referencing the following example.
linter:
  code_sniffer:
    dir: [src/Controller, src/Repository, tests/]
    standard: [PSR2]
    extensions: [php, inc, lib]
    encoding: utf-8
    parallel: true

  misspell:
    exclude:
      - migrations
      - vendor
      - var
      - public/css/easy-button.css
      - public/css/leaflet.css
      - public/js/easy-button.js
      - public/js/leaflet.js
      - public/js/leaflet.js.map
    locale: US

  phpmd:
    target:
      - src/Controller
      - src/Repository
      - tests/
    rule:
      - codesize
      - unusedcode
      - cleancode
      - controversial
      - design
      - naming
    minimumpriority: 3
    suffixes: [php, phtml]
    strict: true

  remark_lint:
    target: ./
    ext: md,markdown
    use:
      - remark-lint-file-extension
      - remark-lint-no-heading-punctuation

  stylelint:
    target: "**/*.{css,scss}"
    syntax: css
    ignore-path: .gitignore
    ignore-disables: true
    report-needless-disables: true
    quiet: false

#   # PHP_CodeSniffer example. See https://help.sider.review/tools/php/code-sniffer
#   code_sniffer:
#     root_dir: project/
#     target: [app/, test/]
#     standard: [CakePHP, custom-ruleset.xml]
#     extensions: [php, inc]
#     encoding: utf-8
#     ignore:
#       - app/vendor/
#     parallel: true

#   # ESLint example. See https://help.sider.review/tools/javascript/eslint
#   eslint:
#     root_dir: project/
#     dependencies:
#       - my-eslint-plugin@2
#     npm_install: false
#     target:
#       - src/
#       - lib/
#     ext: [.js, .jsx]
#     config: config/.eslintrc.js
#     ignore-path: config/.eslintignore
#     ignore-pattern: "vendor/**"
#     no-ignore: true
#     global: ["require", "exports:true"]
#     quiet: true

#   # Misspell example. See https://help.sider.review/tools/others/misspell
#   misspell:
#     root_dir: project/
#     target: [src/, test/]
#     exclude: ["**/*.min.*"]
#     locale: UK
#     ignore: [center, behavior]

#   # PHPMD example. See https://help.sider.review/tools/php/phpmd
#   phpmd:
#     root_dir: project/
#     target: [src/, test/]
#     rule: [cleancode, codesize]
#     minimumpriority: 3
#     suffixes: [php, phtml]
#     exclude: [vendor/, "test/*.php"]
#     strict: true
#     custom_rule_path:
#       - Custom_PHPMD_Rule.php
#       - "custom/phpmd/rules/**/*.php"

#   # ShellCheck example. See https://help.sider.review/tools/shellscript/shellcheck
#   shellcheck:
#     root_dir: project/
#     target:
#       - "**/*.{sh,bash}"
#       - shebang: true
#     include: [SC2104, SC2105]
#     exclude: [SC1000, SC1118]
#     enable: all
#     shell: bash
#     severity: error
#     norc: true

#   # stylelint example. See https://help.sider.review/tools/css/stylelint
#   stylelint:
#     root_dir: project/
#     dependencies:
#       - my-stylelint-plugin@2
#     npm_install: false
#     config: config/.stylelintrc.yml
#     syntax: scss
#     ignore-path: config/.stylelintignore
#     ignore-disables: true
#     report-needless-disables: true
#     quiet: true
#     target: ["app/**/*.scss"]

# Ignore specific files. Example:
# ignore:
#   - "*.pdf"
#   - "*.mp4"
#   - "*.min.*"
#   - "images/**"

# Exclude specific branches. Example:
# branches:
#   exclude:
#     - master
#     - development
#     - /^release-.*$/