workflow-preflight
Preflight Code Quality Checks
You are running a comprehensive preflight check on this codebase. This command discovers and runs configured quality checks including type checking, linting, and tests.
Arguments
--fix- Automatically attempt to fix issues without prompting--check-only- Only report issues, never prompt to fix--verbose- Show detailed output from all commands- No arguments - Interactive mode (default): prompt before fixing
User provided: $ARGUMENTS
Step 1: Discovery Phase
First, analyze the project to discover configured quality tools. Check for:
Package Manager & Config Files
package.json- Check for scripts:lint,typecheck,type-check,tsc,test,check,validatetsconfig.json/jsconfig.json- TypeScript/JavaScript configuration.eslintrc*,eslint.config.*- ESLint configurationbiome.json,biome.jsonc- Biome configuration.prettierrc*,prettier.config.*- Prettier configurationdeno.json/deno.jsonc- Deno configuration.stylelintrc*- Stylelint configuration
Python Projects
pyproject.toml- Check for ruff, mypy, pytest, black, isort configssetup.py/setup.cfg- Legacy Python configrequirements.txt/requirements-dev.txt- Dependenciesmypy.ini/.mypy.ini- MyPy configurationruff.toml/.ruff.toml- Ruff configurationpytest.ini/pyproject.toml [tool.pytest]- Pytest configurationtox.ini- Tox configuration
.NET Projects
*.csproj/*.fsproj/*.vbproj- .NET project files*.sln- Solution files.editorconfig- Editor configuration with .NET analyzersDirectory.Build.props- MSBuild properties
Go Projects
go.mod- Go module.golangci.yml/.golangci.yaml- GolangCI-Lint configuration
Rust Projects
Cargo.toml- Check for clippy, rustfmtrustfmt.toml/.rustfmt.toml- Rustfmt configurationclippy.toml/.clippy.toml- Clippy configuration
Security Scanning
pnpm-lock.yaml/package-lock.json/yarn.lock- Dependency audit support.semgreprc.yml/.semgrep.yml/semgrep.yml/.semgrep/- Semgrep configuration.github/workflows/*.yml- Check for semgrep CI jobs (extract config flags)eslint-plugin-securityin devDependencies - ESLint security rulespackage.jsonscripts containingauditorsemgrep- Custom security scriptsREADME.md/CONTRIBUTING.md- Check for documented security scanning commands
Other
Makefile/makefile- Check for lint/test/check targets.pre-commit-config.yaml- Pre-commit hooksjustfile- Just command runner
Step 2: Report Discovery
Present a summary of what was discovered:
Preflight Discovery Summary
Project Type: [Node.js / Python / .NET / Go / Rust / Multi-language]
Type Checking: [tool name] via [config file]
Linting: [tool name] via [config file]
Testing: [tool name] via [config file]
Formatting: [tool name] via [config file]
Security Scanning: [tool name(s)] via [config file/method]
Not configured: [any missing categories]
Ready to run checks?
Step 3: Execute Checks
Run the discovered checks in this order:
- Type checking (fastest feedback on type errors)
- Linting (code quality issues)
- Formatting check (style consistency - check only, don't auto-fix yet)
- Security scanning - MANDATORY if any security tools detected:
- Dependency audit (npm audit, pnpm audit, etc.)
- Semgrep SAST - MUST run if detected in CI workflows or config files
- Tests (run last as they take longest)
CRITICAL: If Semgrep was detected in discovery (CI workflows, config files, or README), you MUST run it. Do NOT skip Semgrep and report "All checks passed" without running it.
For each check, report:
- Pass - no issues found
- Warnings - non-blocking issues
- Fail - blocking issues found
Common Commands by Ecosystem
Node.js/TypeScript:
- TypeScript:
npx tsc --noEmitornpm run typecheck - ESLint:
npx eslint . --max-warnings=0ornpm run lint - Biome:
npx biome check . - Tests:
npm testornpx jestornpx vitest run
Python:
- MyPy:
mypy .ormypy src/ - Ruff:
ruff check . - Pytest:
pytestorpython -m pytest - Black check:
black --check .
.NET:
- Build with warnings:
dotnet build --warnaserror - Format check:
dotnet format --verify-no-changes - Tests:
dotnet test
Go:
- Type check:
go build ./... - Lint:
golangci-lint run - Tests:
go test ./...
Rust:
- Check:
cargo check - Clippy:
cargo clippy -- -D warnings - Tests:
cargo test - Format check:
cargo fmt --check
Security Scanning Commands
Dependency Audits (run based on detected package manager):
- pnpm:
pnpm auditorpnpm audit:check(if script exists in package.json) - npm:
npm audit - yarn:
yarn audit - pip:
pip-audit(if installed) orsafety check(if installed) - cargo:
cargo audit(if installed)
Semgrep (static analysis - MUST run if detected in CI or config):
IMPORTANT: If Semgrep is detected in CI workflows or config files, you MUST run it as part of preflight checks. Do not skip it.
Detection order:
- Check for custom script in package.json (e.g.,
pnpm run semgrepornpm run semgrep) - Check for semgrep config files:
.semgreprc.yml,.semgrep.yml,semgrep.yml, or.semgrep/directory - Check
.github/workflows/*.ymlfor semgrep jobs - extract--configflags used in CI - Check
README.mdfor documented semgrep commands - ALWAYS check this before trying generic Docker commands, as projects often document the exact command needed for their setup - Check if
semgrepCLI is available locally:semgrep --version - Check if Docker is available:
docker --version - If Docker available but no semgrep CLI, use Docker (see platform-specific commands below)
Semgrep execution:
- With config file:
semgrep scan --config .semgreprc.yml(or detected config) - Without config (auto rules):
semgrep scan --config auto - With language-specific rules:
semgrep scan --config auto --config p/javascript --config p/typescript
Docker execution (AUTOMATIC PLATFORM DETECTION):
CRITICAL: You MUST detect the platform and use the correct command automatically. Check the platform from the environment context.
-
If platform is
win32(Windows): ALWAYS useMSYS_NO_PATHCONV=1prefix for Docker commands:MSYS_NO_PATHCONV=1 docker run --rm -v "$(pwd):/src" semgrep/semgrep semgrep scan --config auto /src -
If platform is
darwin(macOS) orlinux: Use standard Docker command:docker run --rm -v "$(pwd):/src" semgrep/semgrep semgrep scan --config auto /src
Why this matters on Windows: Git Bash/MSYS2 performs automatic POSIX-to-Windows path conversion. Without MSYS_NO_PATHCONV=1, the Docker volume mount /src gets incorrectly converted to C:/Program Files/Git/src, causing Semgrep to fail with "Invalid scanning root" error.
DO NOT try the command without the prefix first on Windows - use the correct platform-specific command immediately.
ESLint Security Plugin:
- If
eslint-plugin-securityis detected in devDependencies, security rules are already included in the linting step - No separate command needed, but note in discovery output that security linting is active
Step 4: Results Summary
Present results in a clear summary:
Preflight Results
Type Checking Passed
Linting 3 errors, 2 warnings
Formatting 5 files need formatting
Security Audit 2 vulnerabilities found
Security SAST Passed (semgrep)
Tests 42 passed, 0 failed
Overall: Issues found
Step 5: Fix Prompt (Interactive Mode)
If issues were found AND user didn't pass --check-only:
If --fix was passed: Proceed directly to fixing without prompting.
Otherwise, ask:
Would you like me to attempt fixes?
[1] Fix all auto-fixable issues (lint --fix, format, etc.)
[2] Fix only linting issues
[3] Fix only formatting issues
[4] Show me the specific issues first
[5] Skip fixes - I'll handle it manually
Enter choice (1-5):
Wait for user input before proceeding.
Step 6: Apply Fixes (if requested)
When fixing:
- Run auto-fix commands (e.g.,
eslint --fix,ruff --fix,prettier --write) - Re-run the checks to verify fixes
- Report what was fixed and what still needs manual attention
Fix Results
Auto-fixed:
3 linting errors resolved
5 files formatted
Still needs attention:
1 type error in src/utils.ts:42
Property 'foo' does not exist on type 'Bar'
Important Guidelines
- Never run fix commands without user consent unless
--fixwas explicitly passed - Preserve user's working state - don't modify files unexpectedly
- Respect existing configuration - use project's own scripts when available (e.g.,
npm run lintover raweslint) - Handle missing tools gracefully - if a tool isn't installed, note it and continue
- Provide actionable feedback - include file paths and line numbers for manual fixes
- Consider CI alignment - mention if checks match CI configuration
Error Handling
If a tool fails to run:
Could not run [tool]: [error message]
Suggestion: [how to install or configure]
If no quality tools are configured:
No quality tools detected in this project.
Would you like me to help set up:
[1] TypeScript type checking
[2] ESLint for linting
[3] Prettier for formatting
[4] A testing framework
[5] Skip setup
Preflight Code Quality Checks
This skill provides comprehensive guidance for discovering and running code quality checks across different project types.
Overview
Preflight checks are the quality gates that verify code before commits, PRs, or deployments. They typically include:
- Type Checking - Static type verification (TypeScript, MyPy, etc.)
- Linting - Code quality and style enforcement
- Formatting - Consistent code style
- Security Scanning - Dependency audits and static analysis (SAST)
- Testing - Unit, integration, and e2e tests
Quick Reference
Node.js / TypeScript Projects
| Check | Command | Auto-fix |
|---|---|---|
| TypeScript | npx tsc --noEmit |
N/A (manual) |
| ESLint | npx eslint . |
npx eslint . --fix |
| Biome | npx biome check . |
npx biome check . --write |
| Prettier | npx prettier --check . |
npx prettier --write . |
| Jest | npx jest |
N/A |
| Vitest | npx vitest run |
N/A |
Prefer npm scripts when available:
# Check package.json scripts first
npm run lint # if exists
npm run typecheck # if exists
npm run test # if exists
npm run check # often runs all checks
Python Projects
| Check | Command | Auto-fix |
|---|---|---|
| MyPy | mypy . |
N/A (manual) |
| Ruff lint | ruff check . |
ruff check . --fix |
| Ruff format | ruff format --check . |
ruff format . |
| Black | black --check . |
black . |
| isort | isort --check . |
isort . |
| Pytest | pytest |
N/A |
With pyproject.toml (modern Python):
# Check for [tool.X] sections
ruff check . && ruff format --check . # Ruff (fast, recommended)
mypy src/ # Type checking
pytest # Tests
.NET Projects
| Check | Command | Auto-fix |
|---|---|---|
| Build | dotnet build |
N/A |
| Build strict | dotnet build --warnaserror |
N/A |
| Format check | dotnet format --verify-no-changes |
dotnet format |
| Tests | dotnet test |
N/A |
| Analyzers | Configured in .editorconfig |
N/A |
.NET specific considerations:
- Warnings as errors: Add
<TreatWarningsAsErrors>true</TreatWarningsAsErrors>to.csproj - Enable nullable:
<Nullable>enable</Nullable>for null safety - Analyzers run during build automatically
Go Projects
| Check | Command | Auto-fix |
|---|---|---|
| Build | go build ./... |
N/A |
| Vet | go vet ./... |
N/A |
| golangci-lint | golangci-lint run |
golangci-lint run --fix |
| gofmt | gofmt -l . |
gofmt -w . |
| Tests | go test ./... |
N/A |
Rust Projects
| Check | Command | Auto-fix |
|---|---|---|
| Check | cargo check |
N/A |
| Clippy | cargo clippy -- -D warnings |
cargo clippy --fix |
| Format | cargo fmt --check |
cargo fmt |
| Tests | cargo test |
N/A |
Security Scanning (Cross-Platform)
| Tool | Purpose | Command |
|---|---|---|
| pnpm audit | Dependency CVE scan | pnpm audit or pnpm audit:check |
| npm audit | Dependency CVE scan | npm audit |
| yarn audit | Dependency CVE scan | yarn audit |
| eslint-plugin-security | JS/TS security patterns | Runs with ESLint |
| Semgrep | SAST scanning | semgrep scan --config auto |
| Semgrep (Docker) | SAST scanning | See platform-specific commands below |
| pip-audit | Python dependency scan | pip-audit |
| cargo-audit | Rust dependency scan | cargo audit |
IMPORTANT: If Semgrep is detected in CI workflows or config files, you MUST run it as part of preflight checks. Do not skip it.
Semgrep Detection Priority:
- Package.json scripts (e.g.,
pnpm run semgrep) - Config files:
.semgreprc.yml,.semgrep.yml,semgrep.yml,.semgrep/ - CI workflows:
.github/workflows/*.yml(extract--configflags) - README.md documentation - ALWAYS check this before trying generic Docker commands
- Local CLI:
semgrep --version - Docker fallback (see platform-specific commands below)
Semgrep Docker Commands (AUTOMATIC PLATFORM DETECTION):
CRITICAL: Detect the platform from environment context and use the correct command automatically.
- Windows (
win32): ALWAYS useMSYS_NO_PATHCONV=1prefix:MSYS_NO_PATHCONV=1 docker run --rm -v "$(pwd):/src" semgrep/semgrep semgrep scan --config auto /src - macOS (
darwin) / Linux: Standard command:docker run --rm -v "$(pwd):/src" semgrep/semgrep semgrep scan --config auto /src
Why MSYS_NO_PATHCONV=1 is required on Windows: Git Bash/MSYS2 auto-converts POSIX paths to Windows paths. Without this prefix, /src becomes C:/Program Files/Git/src, causing "Invalid scanning root" error. DO NOT try without the prefix first on Windows.
Discovery Strategy
Step 1: Identify Project Type(s)
Check for presence of key files:
# JavaScript/TypeScript
package.json, tsconfig.json, deno.json
# Python
pyproject.toml, setup.py, requirements.txt, Pipfile
# .NET
*.csproj, *.sln, *.fsproj
# Go
go.mod
# Rust
Cargo.toml
Step 2: Check for Configured Scripts/Tasks
package.json scripts (Node.js):
{
"scripts": {
"lint": "eslint .",
"typecheck": "tsc --noEmit",
"test": "vitest",
"check": "npm run lint && npm run typecheck && npm run test"
}
}
pyproject.toml (Python):
[tool.ruff]
line-length = 100
[tool.mypy]
strict = true
[tool.pytest.ini_options]
testpaths = ["tests"]
Makefile targets:
lint:
ruff check .
test:
pytest
check: lint test
Step 3: Detect CI Configuration
Check for CI files to align local checks with CI:
.github/workflows/*.yml- GitHub Actions (also check for semgrep jobs).gitlab-ci.yml- GitLab CIazure-pipelines.yml- Azure DevOpsJenkinsfile- Jenkins.circleci/config.yml- CircleCI
Step 4: Detect Security Tools
Check for security scanning configuration:
package.jsondevDependencies foreslint-plugin-securitypackage.jsonscripts containingauditorsemgrep- Semgrep config files:
.semgreprc.yml,.semgrep.yml,semgrep.yml - CI workflows for semgrep jobs (extract
--configflags for local replication) README.mdfor documented security commands (often in Security sections)- Lock files (
pnpm-lock.yaml,package-lock.json,yarn.lock) for audit support
Best Practices
Execution Order
Run checks in order of speed and feedback value:
- Format check (fastest, catches style issues)
- Type checking (fast, catches type errors)
- Linting (medium, catches quality issues)
- Security scanning (medium, catches vulnerabilities)
- Tests (slowest, catches logic errors)
This order provides fastest feedback on failures.
Handling Monorepos
For monorepos, check for workspace configuration:
pnpm-workspace.yamllerna.jsonpackage.jsonwithworkspacesfieldCargo.tomlwith[workspace]
Run checks at workspace root or iterate through packages.
CI Alignment
Ensure local preflight matches CI:
# Good: Use same commands as CI
npm run lint # Same as CI step
# Avoid: Different commands locally vs CI
eslint . --max-warnings=0 # If CI uses npm run lint
Exit Codes
Respect exit codes for CI integration:
0- Success, no issues1- Failure, issues found2- Configuration error
Caching
For faster subsequent runs:
- ESLint: Uses
.eslintcachewith--cacheflag - TypeScript: Uses
tsconfig.tsbuildinfowithincremental: true - Pytest: Uses
.pytest_cache - Rust: Uses
target/directory
Error Messages Reference
TypeScript Common Errors
TS2339: Property 'x' does not exist on type 'Y'
-> Add property to interface or use type assertion
TS2322: Type 'X' is not assignable to type 'Y'
-> Check type definitions, may need union type
TS7006: Parameter 'x' implicitly has an 'any' type
-> Add explicit type annotation
ESLint Common Errors
@typescript-eslint/no-unused-vars
-> Remove unused variable or prefix with _
@typescript-eslint/no-explicit-any
-> Replace 'any' with specific type
import/order
-> Auto-fixable: eslint --fix
Python Common Errors
mypy: Incompatible return value type
-> Check return type annotation matches actual return
ruff: E501 Line too long
-> Auto-fixable or configure line-length
ruff: F401 Module imported but unused
-> Remove unused import
Integration with Pre-commit Hooks
Preflight checks can be configured as pre-commit hooks:
.pre-commit-config.yaml:
repos:
- repo: local
hooks:
- id: preflight
name: Preflight Checks
entry: npm run check
language: system
pass_filenames: false
Husky (Node.js):
# .husky/pre-commit
npm run lint
npm run typecheck
When to Skip Checks
Some scenarios where partial checks are acceptable:
--no-verifyfor emergency fixes (use sparingly)- WIP commits on feature branches
- Exploratory/spike work
Always run full preflight before:
- Opening PRs
- Merging to main/master
- Deploying to production