@neuralinverse/ignore

Context-aware scanning intelligence for the NeuralInverse static analysis engine.

What it does

• Region detection — identifies comments, string literals, and doc regions so the engine never false-positives on // password example or "Enter your password:"
• Generated code detection — skips @generated, DO NOT EDIT, protobuf output, and 30+ other markers automatically
• Inline suppression — // ni-suppress rule-id, // ni-disable-next-line, // ni-disable blocks
• Default ignores — ships with sensible defaults for node_modules, vendor, dist, test files, lock files
• .niignore format — project-level ignore file with glob patterns and per-rule scoping
• Suggestions — heuristic engine that suggests what to ignore based on violation context

Installation

npm install @neuralinverse/ignore

Usage

import { buildIgnoreContext, parseNiignore, DEFAULT_IGNORES } from '@neuralinverse/ignore';

const filter = buildIgnoreContext({
  filePath: 'src/auth.ts',
  source: fileContents,
  ignoreRules: parseNiignore(niignoreFileContents),
});

// Before reporting a violation:
if (!filter.isIgnored(lineNumber, 'soc2-cc6-001')) {
  reportViolation(...);
}

// Check if entire file should be skipped:
if (filter.isFileIgnored()) {
  return; // skip scanning
}

Inline suppression syntax

const password = 'hardcoded'; // ni-suppress soc2-cc6-032

// ni-disable-next-line misra-c-2012-8.1
int x;

// ni-disable soc2-cc6-032
const testPassword = 'test123';
const anotherTestPw = 'abc';
// ni-enable soc2-cc6-032

Works in all supported languages: // (C/C++/JS/TS/Java/Go/Rust), # (Python/Shell/Ruby), -- (SQL/Lua), /* */ (C/C++).

.niignore format

# Ignore all vendor code
**/vendor/**

# Ignore generated protobuf
**/*.pb.go

# Only suppress credential rules in test files
[rule:soc2-cc6-032, soc2-cc6-033]
**/*.test.*
**/*.spec.*

Precedence

Highest to lowest:

1. // ni-suppress / // ni-disable-next-line (inline, same or previous line)
2. // ni-disable ... // ni-enable block
3. .niignore rules
4. Default ignores

License

Business Source License 1.1 — see LICENSE.

Change Date: 2029-01-01 | Change License: GPL v2.0