Configuration

How to configure Pulsar with pulsar.toml

Pulsar uses a TOML config file named pulsar.toml. It is auto-detected in the current directory, or you can specify a custom path with --config.

Minimal config

pulsar.toml
[settings]
rules = []

An empty rules array means all rules are enabled. To disable a rule, list it with a - prefix:

[settings]
rules = ["-no-select-star", "-no-missing-limit"]

To run only a specific set of rules, list them explicitly:

[settings]
rules = ["no-select-star", "no-unbounded-find"]

Rule IDs with - prefix are disabled. Rule IDs without prefix are enabled. You cannot mix enable and disable in the same list.

Ignoring files

[settings]
ignore = ["node_modules", "dist", ".test.ts"]

Entries are compared against the file or directory name, not the full path. The pattern .test.ts matches any file or directory named .test.ts.

Database schema (schema-aware rules)

To enable the three schema-aware rules, point Pulsar at your Prisma schema:

[database]
schema = "./prisma/schema.prisma"

When set, Pulsar loads the schema and cross-references your queries against it. Without this section, schema-aware rules are silently skipped.

Full example

pulsar.toml
[settings]
rules = ["-no-select-star"]
ignore = ["node_modules", "dist", ".test.ts"]

[database]
schema = "./prisma/schema.prisma"

Last updated on

On this page