static-code-analysis

Original：🇺🇸 English
Translated

Selects, configures, and integrates a static analysis tool for the project's language. Covers tool selection, rule configuration, CI integration, fixing existing violations, and pre-commit hook setup. Invoked when the user asks to add linting, set up static analysis, or configure a code quality tool.

1installs
Sourcesoulcodex/agentic
Added on

NPX Install

npx skill4agent add soulcodex/agentic static-code-analysis

Tags

Translated version includes tags in frontmatter
static-code-analysislinting-toolsci-integrationpre-commit-hookscode-quality

SKILL.md Content

View Translation Comparison →

Static Code Analysis Skill

Step 1 — Detect Language and Choose Tool

LanguageRecommended toolConfig file
TypeScript / JavaScriptESLint + typescript-eslint (+ eslint-plugin-import if using 
import/*
rules)
eslint.config.ts
Gogolangci-lint
.golangci.yml
PythonRuff
ruff.toml
or 
pyproject.toml
PHPPHPStan
phpstan.neon
RustClippy (built-in)
clippy.toml
If a tool is already present, audit its configuration before making changes.

Step 2 — Configure Rules

Apply a strict baseline. If you use 
import/*
rules, ensure 
eslint-plugin-import
is installed and configured.
TypeScript (ESLint)
json
{
  "rules": {
    "@typescript-eslint/no-explicit-any": "error",
    "@typescript-eslint/no-unused-vars": "error",
    "import/no-commonjs": "error",
    "no-console": "warn",
    "eqeqeq": ["error", "always"]
  }
}
Go (golangci-lint)
yaml
linters:
  enable:
    - errcheck
    - gosimple
    - govet
    - ineffassign
    - staticcheck
    - unused
linters-settings:
  govet:
    enable-all: true
Python (Ruff)
toml
[tool.ruff]
select = ["E", "F", "I", "N", "UP", "S", "B"]
ignore = []
line-length = 100

Step 3 — Integrate with CI

Add a lint job that runs before tests and fails on any error (exit code 1):
yaml
# .github/workflows/ci.yml
lint:
  runs-on: ubuntu-latest
  steps:
    - uses: actions/checkout@v4
    - name: Run linter
      run: <lint-command>   # e.g., pnpm lint, golangci-lint run, ruff check .
Do not suppress errors with 
continue-on-error: true
— violations must be fixed.

Step 4 — Fix Existing Violations

Run the auto-fixer first to resolve stylistic issues without manual effort:
bash
# TypeScript
pnpm eslint . --fix

# Python
ruff check . --fix

# Go (no auto-fix in golangci-lint; use gofmt + goimports)
gofmt -w .
goimports -w .
Then address remaining violations manually. Prioritise 
error
-level findings. Document any intentional rule suppression inline with a comment explaining why:
ts
// eslint-disable-next-line @typescript-eslint/no-explicit-any -- legacy API response type
const response: any = await legacyClient.fetch()

Step 5 — Pre-commit Hook

Install a pre-commit hook so violations are caught before 
git push
:
Using Husky + lint-staged (JS/TS)
bash
pnpm add -D husky lint-staged
npx husky init
json
// package.json
"lint-staged": { "*.{ts,tsx}": "eslint --fix" }
Using pre-commit (Python/Go)
yaml
# .pre-commit-config.yaml
repos:
  - repo: https://github.com/astral-sh/ruff-pre-commit
    rev: v0.4.0
    hooks:
      - id: ruff
        args: [--fix]

Step 6 — Verify

  • <lint-command>
    exits 0 with no output.
  • CI lint job passes on a clean branch.
  • Pre-commit hook blocks a commit that introduces a lint error.
  • No blanket 
    eslint-disable
    or 
    #noqa
    without explanatory comments.