Skip to content
QangLang Docs

Qang Check

The qang check command runs static analysis on QangLang code without executing it. This is useful for catching errors early in development and validating code before running tests or deploying.

Usage

Section titled “Usage”
Terminal window
qang check <path> [options]

Arguments

Section titled “Arguments”
  • <path> - Path to a QangLang file or directory to check (required)
    • If a directory is provided, all .ql files will be checked recursively

Options

Section titled “Options”
  • --eformat / -e - Error message format (default: verbose)
    • minimal - Shows minimal error information
    • compact - Shows compact error messages
    • verbose - Shows detailed error messages with full context

Examples

Section titled “Examples”

Check a Single File

Section titled “Check a Single File”
Terminal window
qang check src/main.ql

Check an Entire Directory

Section titled “Check an Entire Directory”
Terminal window
qang check src/

Check with Ignore Patterns

Section titled “Check with Ignore Patterns”

Ignore specific files or directories:

Terminal window
qang check src/ --ignore "test_*.ql" --ignore "examples/"

Use Minimal Error Format

Section titled “Use Minimal Error Format”
Terminal window
qang check src/ --eformat minimal

Exit Codes

Section titled “Exit Codes”
  • 0 - All checks passed successfully
  • 1 - One or more checks failed