auto-cr

Category: Development & Coding | Uploader: wangweiwei | Downloads: 0 | Version: v1.0（Latest）

Use this skill when you need to run auto-cr on JavaScript/TypeScript code or explain how to configure it.

Changelog: Source: GitHub https://github.com/wangweiwei/auto-cr

Directory Structure

Current level: tree/main/

📁 .githooks/
- 📄 pre-push 164 B
📁 .github/
- 📁 ISSUE_TEMPLATE/
  - 📄 bug_report.md 834 B
  - 📄 feature_request.md 595 B
- 📁 workflows/
  - 📄 npm-publish.yml 1.8 KB
  - 📄 osv-scanner.yml 1.5 KB
- 📄 dependabot.yml 315 B
📁 assets/
- 📁 images/
  - 📄 logo.png 11.0 KB
📁 docs/
- 📄 config.md 2.6 KB
- 📄 no-blocking-api-in-hot-path.md 2.8 KB
- 📄 no-cross-package-private-imports.md 2.7 KB
- 📄 no-deep-relative-imports.md 2.0 KB
- 📄 no-swallowed-errors.md 2.1 KB
📁 examples/
- 📁 custom-rules/
  - 📁 demo/
    
    📁 consts/
    
    📄 index.ts 33 B
    
    📄 test.ts 145 B
  - 📁 rules/
    
    📄 no-index-import.js 564 B
- 📁 noBlockingApiInHotPath/
  - 📄 index.ts 946 B
- 📁 noCatastrophicRegex/
  - 📄 index.ts 401 B
- 📁 noCircularDependencies/
  - 📄 a.ts 79 B
  - 📄 b.ts 79 B
  - 📄 c.ts 79 B
- 📁 noCrossPackagePrivateImports/
  - 📁 packages/
    
    📁 app/
    
    📁 src/
    
    📄 index.ts 311 B
    
    📄 package.json 45 B
    
    📁 shared/
    
    📁 src/
    
    📄 index.ts 36 B
    
    📄 internal.ts 38 B
    
    📄 public.ts 36 B
    
    📄 package.json 110 B
  - 📄 pnpm-workspace.yaml 25 B
- 📁 noDeepCloneInLoop/
  - 📄 index.ts 423 B
- 📁 noDeepRelativeImports/
  - 📁 app/
    
    📁 features/
    
    📁 admin/
    
    📁 pages/
    
    📄 dashboard.ts 328 B
    
    📁 consts/
    
    📄 index.ts 33 B
  - 📁 shared/
    
    📁 deep/
    
    📄 utils.ts 88 B
- 📁 noN2ArrayLookup/
  - 📄 index.ts 493 B
- 📁 noSwallowedErrors/
  - 📄 violations.ts 562 B
📁 packages/
- 📁 auto-cr-cmd/
  - 📁 src/
    
    📁 config/
    
    📄 autocrrc.ts 5.4 KB
    
    📄 ignore.ts 4.1 KB
    
    📁 i18n/
    
    📄 index.ts 9.2 KB
    
    📁 report/
    
    📄 index.ts 10.8 KB
    
    📁 rules/
    
    📄 loader.ts 3.1 KB
    
    📁 scan/
    
    📄 analyzeFile.ts 8.8 KB
    
    📄 runtime.ts 1.1 KB
    
    📄 types.ts 780 B
    
    📄 worker.ts 2.9 KB
    
    📄 workerPool.ts 3.9 KB
    
    📄 workerTypes.ts 1.1 KB
    
    📁 utils/
    
    📄 file.ts 1.6 KB
    
    📄 path.ts 2.3 KB
    
    📄 stdin.ts 1.8 KB
    
    📄 config.ts 4.9 KB
    
    📄 index.ts 24.9 KB
  - 📄 package.json 1.9 KB
  - 📄 tsconfig.json 415 B
- 📁 auto-cr-rules/
  - 📁 src/
    
    📁 rules/
    
    📁 utils/
    
    📄 hotPath.ts 5.3 KB
    
    📄 workspace.ts 10.9 KB
    
    📄 index.ts 1023 B
    
    📄 noBlockingApiInHotPath.ts 18.7 KB
    
    📄 noCatastrophicRegex.ts 6.7 KB
    
    📄 noCircularDependencies.ts 33.9 KB
    
    📄 noCrossPackagePrivateImports.ts 4.4 KB
    
    📄 noDeepCloneInLoop.ts 3.5 KB
    
    📄 noDeepRelativeImports.ts 2.8 KB
    
    📄 noN2ArrayLookup.ts 2.3 KB
    
    📄 noSwallowedErrors.ts 3.2 KB
    
    📄 analysis.ts 10.4 KB
    
    📄 imports.ts 3.4 KB
    
    📄 index.ts 779 B
    
    📄 messages.ts 2.8 KB
    
    📄 runtime.ts 3.0 KB
    
    📄 sourceIndex.ts 2.8 KB
    
    📄 types.ts 5.8 KB
  - 📄 package.json 1.3 KB
  - 📄 tsconfig.json 298 B
📁 scripts/
- 📄 bump-version.mjs 3.4 KB
- 📄 check-lockfile-specifiers.mjs 4.7 KB
- 📄 readme-sync.mjs 2.3 KB
- 📄 setup-git-hooks.mjs 403 B
📄 .gitignore 384 B
📄 .prettierrc.js 203 B
📄 AGENTS.md 2.6 KB
📄 AGENTS.zh-CN.md 2.7 KB
📄 CODE_OF_CONDUCT.md 5.1 KB
📄 CONTRIBUTING.md 3.6 KB
📄 LICENSE 1.0 KB
📄 package.json 785 B
📄 pnpm-lock.yaml 40.6 KB
📄 pnpm-workspace.yaml 68 B
📄 README.md 10.2 KB
📄 README.zh-CN.md 10.4 KB
📄 SECURITY.md 1.1 KB
📄 SKILL.md 1.8 KB
📄 SKILL.zh-CN.md 1.8 KB
📄 tsconfig.base.json 287 B
📄 tsconfig.json 126 B

SKILL.md

# SKILL: auto-cr-cli

Use this skill when you need to run auto-cr on JavaScript/TypeScript code or explain how to configure it.

## Inputs

- Paths to scan (files or directories).
- Optional config: `.autocrrc.json` / `.autocrrc.js`.
- Optional ignore: `.autocrignore.json` / `.autocrignore.js`.
- Optional custom rules directory: `--rule-dir`.
- Optional output format: `--output text|json`.
- Optional language: `--language zh|en`.
- Optional tsconfig override: `--tsconfig <path>`.
- Optional stdin mode: `--stdin` to read paths from STDIN.

## Steps

1. Run a scan:
   `npx auto-cr-cmd --language en <path>`
2. JSON output for CI or scripts:
   `npx auto-cr-cmd --output json <path>`
3. Custom rules:
   `npx auto-cr-cmd --rule-dir <dir> <path>`
4. Config and ignore files:
   `npx auto-cr-cmd --config .autocrrc.json --ignore-path .autocrignore.json <path>`
5. Read paths from STDIN (newline or NUL separated):
   `git diff --name-only -z | npx auto-cr-cmd --stdin --output json`

## Output (JSON quick reference)

- `summary.scannedFiles`, `summary.filesWithErrors`, `summary.filesWithWarnings`, `summary.filesWithOptimizing`
- `summary.violationTotals` (counts by severity)
- `files[].filePath`, `files[].severityCounts`, `files[].totalViolations`, `files[].errorViolations`
- `files[].violations[]` with `tag`, `ruleName`, `severity`, `message`, optional `line`, optional `code`, and `suggestions`
- `notifications[]`

Exit code is `1` when errors are found, otherwise `0`.

## Notes

- Scans `.ts` / `.tsx` / `.js` / `.jsx`; `.d.ts` is skipped.
- Directory scans skip `node_modules` by default.
- Text output goes to `stderr`; JSON output goes to `stdout`.
- STDIN is read automatically when piped (use `--stdin` to force).
- Use `AUTO_CR_WORKERS=0|1|N` to control parallelism.

## References

- `README.md`
- `docs/config.md`
- `examples/` for rule demos and custom rules layout

Comments 0

Latest | Hot

Please login before commenting.

Loading comments...

auto-cr

Directory Structure

SKILL.md

Report

Notice