Skip to main content

Ignoring Files and Rules

ZLint provides several ways to ignore files and specific rules, each with varying degrees of granularity.

Ignoring Whole Files​

ZLint respects .gitignore files by default; no files ignored by git will be linted.

To ignore additional files, provide a list of glob patterns in the ignore field of your zlint.json file:

  • patterns are anchored to your project root, so src/generated matches only that one folder
  • a **/ prefix matches at any depth, so **/generated also skips src/generated/
  • a /** suffix matches a folder's contents, so skipping everything in generated/ takes **/generated/**
zlint.json
{
  "ignore": ["src/test/**", "**/node_modules/**", "**/*.gen.zig"],
  "rules": {/* ... */}
}
note

Naming a folder does not skip what is inside it. **/generated matches the folder itself; pair it with **/generated/** to skip its contents too.

.gitignore entries are read with git's rules, not these, and translated to equivalent globs - a bare generated line in a .gitignore still applies at any depth.

Disabling Rules​

You can globally disable rules by setting their level to off in your configuration file.

zlint.json
{
  "rules": {
    "unused-decls": "off"
  }
}

Disabling Rules for a Single File​

You can use ESLint-style disable directives to disable one or more rules for a single file. Put a // zlint-disable comment at the top of your file to disable all rules, or add a list of rules to disable. You may put arbitrary text after -- to explain why you're disabling the rules if you want.

src/bad.zig
// zlint-disable unused-decls, unsafe-undefined -- this is an optional explanation

const std = @import("std");
const unused = @import("./foo.zig"); // would normally be reported by `unused-decls`

fn foo() u32 {
  var x: u32 = undefined; // would normally be reported by `unsafe-undefined`
  return x;
}
warning

Next-line disable directives are not yet supported. Track issue #184 for updates.