-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy path.yamllint.yaml
More file actions
57 lines (48 loc) · 1.88 KB
/
.yamllint.yaml
File metadata and controls
57 lines (48 loc) · 1.88 KB
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
# yamllint config for nyuchi/.github.
#
# Relaxed defaults that accommodate:
# - GitHub Actions workflows (which use `on:` — a YAML 1.1 boolean)
# - Long lines in shell heredocs and comment blocks inside workflows
# - Files without `---` document-start markers
#
# See https://yamllint.readthedocs.io/en/stable/configuration.html
extends: default
ignore: |
node_modules/
rules:
# 140-char limit. Workflow files have legitimately long shell URLs
# (the actionlint download script, action references) and issue-
# template `about:` strings render as a single line in the picker,
# so wrapping them would change user-visible behaviour. 140 is
# tight enough to flag truly excessive lines without forcing
# awkward breaks on URLs. Strict CI fails on any violation.
line-length:
max: 140
level: error
allow-non-breakable-words: true
allow-non-breakable-inline-mappings: true
# GitHub Actions uses `on:` as a key, which YAML 1.1 treats as a
# boolean. Disable the truthy check on keys to stop yamllint from
# rejecting every workflow.
truthy:
check-keys: false
level: error
# We don't prefix YAML files with `---`.
document-start: disable
# Be lenient about how many spaces follow `#` in comments.
comments:
min-spaces-from-content: 1
# Comments-indentation flags standalone comments that don't match the
# indent of surrounding content. Real-world configs use comments to
# delimit sections (long `# ----` separator banners) and to mark
# commented-out blocks at the level of the code they replace, neither
# of which fits the rule cleanly. Disabled.
comments-indentation: disable
# GitHub issue forms have deeply nested lists and mappings.
indentation:
spaces: 2
indent-sequences: consistent
# Stops a warning on the trailing-empty-line check for files that
# end cleanly with a single newline.
empty-lines:
max-end: 1