Skip to main content

Tool behavior to rule map

Use this page to decide whether a finding should come from Secretlint itself or from this plugin's ESLint rules.

ConcernSource of truthESLint rule
Secret detection and masking behaviorSecretlintsecretlint/secretlint
Secretlint config filenameRepository policyrequire-secretlint-config-file-naming-convention
Top-level rules containerRepository policyrequire-secretlint-rules-array
Rule IDsRepository policyrequire-secretlint-rule-id
Duplicate rule IDsRepository policydisallow-secretlint-duplicate-rules
Empty rule IDsRepository policydisallow-secretlint-empty-rule-id
Relative rule pathsRepository policydisallow-secretlint-relative-rule-paths
Known rule object propertiesRepository policydisallow-secretlint-unknown-rule-properties
allowMessageIds shapeRepository policyprefer-secretlint-allow-message-ids-array
Nested rules shapeRepository policyprefer-secretlint-nested-rules-array
Installed rule packagesRepository environmentrequire-secretlint-rules-packages-installed

If the issue changes what is considered a secret, let Secretlint own it. If the issue makes the Secretlint config easier to review and reuse across repositories, enforce it with this plugin.