@critiq/rules
v0.4.0
Published
Public OSS Critiq rule catalog with catalog metadata, shipped rule YAML files, and preset membership.
Readme
@critiq/rules is the default rule catalog for Critiq — deterministic static analysis rules for security, correctness, performance, and code quality across TypeScript, JavaScript, Go, Java, Python, PHP, Ruby, Rust, and CloudFormation.
Currently shipping 1243 rules across 21 categories.
Use it with @critiq/cli:
npm install -D @critiq/cli @critiq/rules
npx critiq check .Run against a diff:
npx critiq check . --base origin/main --head HEADGitHub Actions
Use critiq-dev/critiq-action to run Critiq in CI and post inline review comments on pull requests:
name: Critiq Review
on:
pull_request:
permissions:
contents: read
pull-requests: write
jobs:
critiq:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v6
with:
fetch-depth: 0
- uses: critiq-dev/critiq-action@v1
with:
fail-on-severity: offSee the action README for monorepo paths, reusable workflows, and all available inputs.
Where to find more
- docs.critiq.dev — full documentation and rule reference
- docs.critiq.dev/rules — browse every rule with descriptions, severity, and language coverage
- docs.critiq.dev/cli — CLI install, configuration, presets, and output formats
- critiq-core — CLI, adapter, and engine source
License
@critiq/rules is licensed under Apache 2.0. See the package LICENSE.
