Skip to main content

Guide overview

eslint-plugin-secretlint is a bridge plugin. It lets ESLint run Secretlint and report secret-detection findings through the normal ESLint formatter, while separate rules cover the shape and maintainability of Secretlint config files.

Use the guides in this orderโ€‹

  1. Start with Getting started to add the recommended preset.
  2. Read Secretlint bridge when you need to understand what the bridge rule delegates to upstream Secretlint.
  3. Read Config authoring before enabling the configuration preset on .secretlintrc files.
  4. Use Tool behavior to rule map when deciding whether a finding should come from Secretlint or from this plugin's ESLint rules.

Boundaryโ€‹

This plugin should not become a second Secretlint implementation. If a setting changes what is treated as a secret, keep it in Secretlint config. If a rule enforces repository consistency around that config file, it belongs in the configuration preset.