Skip to content

Configuration ​

Mjölnir is zero-config. An optional mjolnir.config.json (or .mjolnir.json) at the repo root tunes severity, gating and scope — it never changes detection semantics.

KeyTypeEffect
excludestring[]Extra ignore globs (gitignore subset), on top of the built-in defaults
gate"advisory" | "error" | "warning"Which severities exit non-zero (default error; advisory never blocks)
severityOverrides{ "<RULE-ID>": severity }Re-rank a rule's findings for your repo
ignoreIgnoreEntry[]Suppress findings — reason is required; only an explicit expires date (YYYY-MM-DD) is bounded
plugins(string | { "package": string })[]Third-party rule packages
json
{
  "gate": "error",
  "exclude": ["legacy/**"],
  "severityOverrides": { "QA-PW-004": "warning" },
  "ignore": [
    {
      "ruleId": "QA-TEST-004",
      "files": ["e2e/legacy-login.spec.ts"],
      "reason": "Third-party widget needs a settle delay; tracked in JIRA-4821",
      "expires": "2026-12-31"
    }
  ]
}
  • .mjolnirignore — a plain gitignore-style file for path exclusions, same dialect as exclude.
  • CLI overrides — --include-warn (include WARN-tier rules), --width <cols> and --ascii / --no-ascii (terminal rendering), --tone blunt (blunter messages), --max-duration <sec> (bounded partial scan).
  • Rule suppression and deprecation lifecycle: Rule lifecycle.

ignore entries also power the standalone mjolnir scan --suppressions command, which lists what's currently suppressed and when each entry expires.

Released under the MIT License.