HomeLab/.editorconfig-checker.json at main · Gerrrt/HomeLab · 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
{
  "_comment": [
    "IndentSize is off because this checker cannot tell indentation from",
    "alignment, and everything it flagged here was alignment. Two shapes, both",
    "deliberate and both wanted: a continuation line aligned under the pipeline",
    "it belongs to (scripts/seed-validation-env.sh:47, scripts/validate.sh:166),",
    "and the three-space continuation of a numbered list item in Markdown",
    "(docs/adr/*.md). The second is not a matter of taste \u2014 markdownlint",
    "requires those three spaces, so .editorconfig's indent_size of 2 and",
    "markdownlint-cli2 cannot both be satisfied, and markdownlint is the one",
    "that is right about Markdown. 77 findings, no defects among them.",
    "",
    "Nothing else is disabled, and three vendored paths are excluded (below).",
    "Trailing whitespace, final newline, charset, line",
    "endings and indent_style (tabs in the Makefile and *.alloy, spaces",
    "elsewhere) are all still enforced, which is the part that catches real",
    "damage. Verified: adding a trailing space to a script fails this checker.",
    "",
    "This file is new because the checker had never actually run. CI's",
    "EditorConfig step was editorconfig-checker/action-editorconfig-checker@v2,",
    "which downloads the binary and adds it to PATH and never invokes it \u2014 a",
    "green step that checked nothing, for as long as it has been there. See #68.",
    "",
    "stacks/sensor/zeek/ja4/ is EXCLUDED. It is",
    "FoxIO's ja4-zeek-scripts vendored byte-for-byte (ADR-0069): upstream has",
    "trailing spaces and missing final newlines, and editing them would make",
    "every re-vendor's diff partly ours and break scripts/vendor-ja4.sh --check,",
    "which compares the directory to upstream exactly. Our own files in it",
    "(NOTICE, VENDORED) are plain text the checker would pass anyway.",
    "",
    "ansible/roles/sysmon/files/sysmonconfig.xml is EXCLUDED for the same reason:",
    "sysmon-modular's config vendored byte-for-byte (ADR-0080), with CRs, tabs and",
    "trailing spaces upstream. ansible/verify.yml compares each guest's Sysmon",
    "ConfigHash with its sha256, so a whitespace fix would fail every guest.",
    "",
    "stacks/soc/wazuh/certs-tool/wazuh-certs-tool.sh is EXCLUDED for the same",
    "reason: Wazuh's cert tool vendored byte-for-byte (ADR-0094), with trailing",
    "spaces upstream. scripts/wazuh-certs-mint.sh refuses to run it unless its",
    "sha256 is the one VENDORED pins, so a whitespace fix would refuse every mint."
  ],
  "Disable": {
    "IndentSize": true
  },
  "Exclude": [
    "^stacks/sensor/zeek/ja4/",
    "^ansible/roles/sysmon/files/sysmonconfig\\.xml$",
    "^stacks/soc/wazuh/certs-tool/wazuh-certs-tool\\.sh$"
  ]
}