stopslop 0.1.2 → 1.0.0

package/docs/thresholds.md

@@ -0,0 +1,105 @@
+# Threshold calibration
+
+Two lenses on the same corpus:
+
+- **Count percentiles** — each entity counts once. "pXX = N" means XX% of
+  entities score ≤ N. This is what we use for defaults: a god finding should be
+  the worst ~1–5% of entities.
+- **LOC-weighted percentiles** — the Alves/Ypma/Visser (ICSM 2010) methodology:
+  each entity weighted by LOC, so "pXX = N" means XX% of *code volume* sits in
+  entities ≤ N. Kept for reference; it skews high because large entities are
+  both more complex and hold more volume.
+
+Corpus: 22 TypeScript repositories, 65,817 analyzed files (tests, fixtures,
+generated and bundled code excluded). The per-repository counts are listed
+below.
+
+## Count percentiles (basis for defaults)
+
+### Function
+| metric | n | p50 | p75 | p90 | p95 | p99 |
+|---|---|---|---|---|---|---|
+| cognitive complexity | 108102 | 0 | 2 | 7 | 13 | 38 |
+
+### Class (≥3 methods)
+| metric | n | p50 | p75 | p90 | p95 | p99 |
+|---|---|---|---|---|---|---|
+| methods | 2940 | 6 | 12 | 23 | 32 | 64 |
+| responsibility groups (≥2) | 2940 | 1 | 1 | 2 | 2 | 4 |
+| Σ cognitive complexity | 2940 | 8 | 24 | 58 | 93 | 207 |
+
+### Module (≥5 top-level fns)
+| metric | n | p50 | p75 | p90 | p95 | p99 |
+|---|---|---|---|---|---|---|
+| top-level definitions | 2819 | 8 | 11 | 16 | 22 | 37 |
+| responsibility groups (≥2) | 2819 | 1 | 1 | 2 | 2 | 3 |
+| Σ cognitive complexity | 2819 | 21 | 54 | 109 | 167 | 354 |
+
+## LOC-weighted percentiles (Alves, reference)
+
+### Function
+| metric | n | p50 | p75 | p90 | p95 | p99 |
+|---|---|---|---|---|---|---|
+| cognitive complexity | 108102 | 4 | 16 | 45 | 95 | 309 |
+
+### Class (≥3 methods)
+| metric | n | p50 | p75 | p90 | p95 | p99 |
+|---|---|---|---|---|---|---|
+| methods | 2940 | 15 | 30 | 57 | 74 | 111 |
+| responsibility groups (≥2) | 2940 | 1 | 1 | 2 | 3 | 5 |
+| Σ cognitive complexity | 2940 | 41 | 104 | 205 | 341 | 825 |
+
+### Module (≥5 top-level fns)
+| metric | n | p50 | p75 | p90 | p95 | p99 |
+|---|---|---|---|---|---|---|
+| top-level definitions | 2819 | 10 | 17 | 29 | 38 | 72 |
+| responsibility groups (≥2) | 2819 | 1 | 1 | 2 | 2 | 4 |
+| Σ cognitive complexity | 2819 | 51 | 128 | 280 | 455 | 1175 |
+
+## Final defaults
+
+A god finding is rare by construction, but the detector does not compare each
+metric with an independent p95 cutoff. It has two alternative axes:
+
+- **dispersion** requires members **and** responsibility groups **and** total
+  complexity together, so its member floor can stay sensitive;
+- **size/WMC** requires both a high member count and high total complexity, even
+  when the unit is cohesive.
+
+| gate | members | groups | Σ complexity | final setting |
+|---|---:|---:|---:|---|
+| cognitive complexity | — | — | 15 | `cognitiveComplexity: 15` |
+| class dispersion | 12 | 3 | 90 | `godClass: 12 / 3 / 90` |
+| class size/WMC | 30 | — | 200 | `godClass: 30 / 200` |
+| module dispersion | 15 | 3 | 150 | `godModule: 15 / 3 / 150` |
+| module size/WMC | 37 | — | 350 | `godModule: 37 / 350` |
+
+The size thresholds sit near the count p95–p99 tail. On the dispersion axis,
+three substantive groups are already rare (between class p95 and p99; module
+p99), and the conjunction with complexity supplies the precision. Raising the
+member floor itself to p95 would make the conjunction unnecessarily blind to
+smaller units that clearly contain three unrelated responsibilities.
+
+## Per-repo file counts
+- angular: 1971 files
+- angular-components: 1971 files
+- chakra-ui: 2359 files
+- create-react-app: 122 files
+- gatsby: 3086 files
+- ionic-framework: 508 files
+- material-ui: 26447 files
+- nest: 1306 files
+- nextjs: 4498 files
+- ng-bootstrap: 527 files
+- ng-bootstrap-fresh: 527 files
+- nx: 3330 files
+- playwright: 788 files
+- primeng: 2743 files
+- react: 1711 files
+- react-bootstrap: 440 files
+- remix: 805 files
+- shadcn-ui: 3473 files
+- storybook: 2617 files
+- svelte: 2299 files
+- taiga-ui: 2770 files
+- tanstack-table: 1519 files

package/llms.txt

@@ -0,0 +1,25 @@
+# StopSlop
+
+> Static analysis and CI gating for structural AI code slop in JavaScript and TypeScript. StopSlop finds cognitive complexity, god classes and modules, duplicate code, dead code, orphan features, and responsibility boundaries. It reports code patterns, not authorship.
+
+Run without installing: `npx stopslop .`. Exit codes are `0` for a clear gate, `1` for detected findings, and `2` for an analysis error. Requires Node.js 20.19+ or 22.12+.
+
+## Start here
+
+- [Overview, installation, CLI and badge](https://raw.githubusercontent.com/BaryshevRS/stopslop/main/README.md)
+- [Configuration reference](https://raw.githubusercontent.com/BaryshevRS/stopslop/main/docs/configuration.md)
+- [CI baselines, Git comparison, SARIF and agent reports](https://raw.githubusercontent.com/BaryshevRS/stopslop/main/docs/ci-and-automation.md)
+- [Typed Node.js API](https://raw.githubusercontent.com/BaryshevRS/stopslop/main/docs/node-api.md)
+
+## How it works
+
+- [Score formula and interpretation](https://raw.githubusercontent.com/BaryshevRS/stopslop/main/docs/score.md)
+- [Default thresholds and calibration](https://raw.githubusercontent.com/BaryshevRS/stopslop/main/docs/thresholds.md)
+- [Architecture and methodology](https://raw.githubusercontent.com/BaryshevRS/stopslop/main/ARCH.md)
+- [Compatibility policy](https://raw.githubusercontent.com/BaryshevRS/stopslop/main/COMPATIBILITY.md)
+
+## Package
+
+- [npm package](https://www.npmjs.com/package/stopslop)
+- [JSON Schema](https://unpkg.com/stopslop/schema.json)
+- [GitHub repository](https://github.com/BaryshevRS/stopslop)

package/package.json

@@ -1,9 +1,11 @@
 {
   "name": "stopslop",
-  "version": "0.1.2",
-  "description": "Detects AI-agent slop that linters miss: over-complex functions, god modules/classes, dumped responsibilities.",
+  "version": "1.0.0",
+  "description": "Static analysis for AI-generated JavaScript and TypeScript: find cognitive complexity, god classes/modules, duplicate code, dead code and orphan features.",
   "type": "module",
   "license": "MIT",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/BaryshevRS/stopslop.git"
@@ -18,12 +20,20 @@
   "exports": {
     ".": {
       "types": "./dist/index.d.ts",
-      "import": "./dist/index.js"
+      "import": "./dist/index.js",
+      "default": "./dist/index.js"
     },
-    "./schema.json": "./schema.json"
+    "./schema.json": "./schema.json",
+    "./package.json": "./package.json"
   },
   "files": [
-    "dist",
+    "dist/**/*",
+    "docs/**/*.md",
+    "README.md",
+    "COMPATIBILITY.md",
+    "LICENSE",
+    "llms.txt",
+    "context7.json",
     "schema.json"
   ],
   "engines": {
@@ -40,14 +50,20 @@
     "test": "vitest run",
     "test:watch": "vitest",
     "test:package": "node scripts/package-smoke.mjs",
+    "check:clones": "clone-alert --minimum-tokens 100 --files src --format text --fail-on-violation",
     "audit:prod": "pnpm audit --prod",
-    "ci:check": "pnpm test && pnpm typecheck && pnpm build",
+    "ci:check": "pnpm test && pnpm typecheck && pnpm check:clones && pnpm build",
     "release:check": "pnpm ci:check && pnpm audit:prod && pnpm test:package",
     "prepublishOnly": "pnpm release:check",
     "calibrate": "tsx scripts/calibrate.ts",
     "typecheck": "tsc --noEmit",
     "schema:generate": "tsx scripts/generate-config-schema.ts",
-    "schema:check": "tsx scripts/generate-config-schema.ts --check"
+    "schema:check": "tsx scripts/generate-config-schema.ts --check",
+    "commitlint": "commitlint",
+    "prepare": "simple-git-hooks 1>&2"
+  },
+  "simple-git-hooks": {
+    "commit-msg": "pnpm exec commitlint --edit \"$1\""
   },
   "dependencies": {
     "clone-alert": "^1.1.3",
@@ -57,8 +73,11 @@
   },
   "devDependencies": {
     "@arethetypeswrong/core": "^0.18.1",
+    "@commitlint/cli": "^21.1.0",
+    "@commitlint/config-conventional": "^21.1.0",
     "@types/node": "^22.10.0",
     "publint": "^0.3.8",
+    "simple-git-hooks": "^2.13.1",
     "tsdown": "^0.21.10",
     "tsx": "^4.19.0",
     "typescript": "^5.7.0",
@@ -66,12 +85,41 @@
   },
   "keywords": [
     "ai",
+    "ai-code",
+    "ai-generated-code",
+    "ai-code-quality",
+    "ai-slop",
     "slop",
+    "slop-detector",
+    "vibe-coding",
+    "static-analysis",
+    "code-analysis",
+    "code-quality",
     "code-smell",
+    "technical-debt",
+    "javascript",
+    "typescript",
+    "jsx",
+    "tsx",
+    "cli",
+    "lint",
+    "ci",
+    "quality-gate",
+    "code-scanning",
+    "github-actions",
+    "sarif",
+    "baseline",
     "god-class",
     "god-module",
     "cognitive-complexity",
     "lcom",
-    "static-analysis"
+    "cohesion",
+    "duplicate-code",
+    "copy-paste-detector",
+    "dead-code",
+    "unused-code",
+    "orphan-code",
+    "monorepo",
+    "code-review"
   ]
 }