You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+13-1Lines changed: 13 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -52,6 +52,9 @@ scanner scan .
52
52
# Emit aggregate JSON
53
53
scanner scan . --json
54
54
55
+
# Exclude well-known test files and test directories
56
+
scanner scan . --exclude-tests
57
+
55
58
# Detect languages and module roots
56
59
scanner detect .
57
60
@@ -92,6 +95,14 @@ code-signal detects and analyzes these languages with built-in lexical/parser ch
92
95
93
96
Detection uses extensions, shebangs, and common manifests such as `go.mod`, `package.json`, `pyproject.toml`, `Cargo.toml`, `pom.xml`, Gradle files, `.csproj`, `.sln`, `composer.json`, `Gemfile`, `Dockerfile`, `Containerfile`, and `*.dockerfile`.
94
97
98
+
## Ignore files, test exclusion, and skip policy
99
+
100
+
Working-tree scans parse `.gitignore`, `.ignore`, and `.git/info/exclude` using gitignore-style rules before reading candidate files.
101
+
102
+
Pass `--exclude-tests` to `scan` or `diff` to skip well-known test-case paths from aggregate analysis. The built-in defaults cover common Go (`*_test.go`, `testdata`), Java (`src/test/**`, `*Test.java`, `*Tests.java`, `*IT.java`), Python (`tests/**`, `test_*.py`, `*_test.py`, `conftest.py`), TypeScript/JavaScript (`__tests__/**`, `*.test.*`, `*.spec.*`, `cypress/**`, `playwright/**`, `e2e/**`), and Rust (`tests/**`, `benches/**`, `*_test.rs`) conventions.
103
+
104
+
Built-in skips still apply for common dependency, generated, build, coverage, and minified paths such as `node_modules`, `vendor`, `target`, `dist`, `build`, `.next`, `coverage`, `third_party`, `generated`, `gen`, `*.min.js`, `*.min.css`, `*.pb.go`, and `*_generated.go`.
105
+
95
106
## Configuration
96
107
97
108
Configuration is optional. If present, `scanner.json` is loaded from the scanned repository root or from `--config`.
@@ -102,7 +113,8 @@ Configuration is optional. If present, `scanner.json` is loaded from the scanned
0 commit comments