Repository navigation
Expand file tree
/
Copy pathvgi-lint.toml
More file actions
37 lines (31 loc) · 2.15 KB
/
Copy pathvgi-lint.toml
File metadata and controls
37 lines (31 loc) · 2.15 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
# vgi-lint settings for this worker: https://github.com/Query-farm/vgi-lint-check
# `make lint-explain`, `vgi-lint lint` in this directory, and CI's metadata job all
# read this file. Look up a rule with `vgi-lint explain VGI123`; print the metadata tag
# contract with `vgi-lint spec`.
# The worker to attach, relative to this directory. Build it first with `make build`.
location = "bin/vgi-cloudquery-worker --plugins fixture=bin/cq-source-fixture --cache-dir .tools/plugin-cache"
# Fail on warnings while you build. Raise this to "info" before you publish the worker.
fail_on = "info"
# Waive a finding only with a kind and a reason, so the waiver can be audited:
# domain-exemption permanent and legitimate for this worker
# deferred a real defect you will fix; add expires = "YYYY-MM-DD"
# timing slow or flaky because of the environment, not the metadata
# tooling-bug the linter is wrong; report it upstream
ignore = [
# { code = "VGI146", kind = "domain-exemption", reason = "every entry point needs a key" },
]
# Adopting the gate on a worker that already has findings? Record them once with
# vgi-lint lint --baseline vgi-lint-baseline --update-baseline
# and uncomment the next line. Only new findings fail after that.
# baseline = "vgi-lint-baseline"
# Plugin schemas are generated per ATTACH from whatever the plugin reports (the fixture
# plugin's tables stand in for every plugin here). CloudQuery plugins declare primary keys
# (listed in main.plugin_table.primary_key_columns), but the worker passes a sync's rows
# through without deduplicating them, so it cannot attest an ENFORCED key; likewise
# _cq_parent_id -> _cq_id is CloudQuery's relation convention, documented on every child
# table, not a constraint the worker can enforce across separate syncs.
[per_object."cloudquery.fixture.*"]
ignore = [
{ code = "VGI807", kind = "domain-exemption", reason = "plugin primary keys are not deduplicated by the worker, so no ENFORCED key can be attested" },
{ code = "VGI809", kind = "domain-exemption", reason = "_cq_id/_cq_parent_id are CloudQuery's relation convention, documented per child table; not an enforceable foreign key" },
]