@healflow/classification 0.1.0 → 0.1.1

package/README.md

@@ -0,0 +1,78 @@
+# @healflow/classification
+
+Rule-based failure classification engine for Playwright and CI test failures.
+
+## Overview
+
+Classifies failures into 14 categories (selector, timing, overlay, iframe, product bug, etc.), computes confidence scores, fingerprints root causes, and clusters duplicate failures.
+
+**Published to npm** as a transitive dependency. Used by `@healflow/playwright` at runtime and `@healflow/ingestion` during report parsing.
+
+## Installation
+
+```bash
+npm install @healflow/classification
+```
+
+## Usage
+
+```typescript
+import { classifyFailure, fingerprintFailure, clusterFailures } from '@healflow/classification';
+import { FailureSource } from '@healflow/shared';
+
+const result = classifyFailure({
+  errorMessage: 'locator.click: Timeout 30000ms exceeded',
+  errorStack: '...',
+  testFile: 'tests/login.spec.ts',
+  testTitle: 'user can log in',
+  source: FailureSource.REPORT,
+});
+
+console.log(result.category);      // e.g. SELECTOR
+console.log(result.confidence);    // 0–1
+console.log(result.isAutomationFixable);
+```
+
+### Deduplication
+
+```typescript
+import { fingerprintFailure, clusterFailures } from '@healflow/classification';
+
+const fingerprint = fingerprintFailure(errorMessage, errorStack);
+const clusters = clusterFailures(failures);
+```
+
+### Flakiness scoring
+
+```typescript
+import { computeFlakinessScore } from '@healflow/classification';
+
+const score = computeFlakinessScore(history);
+```
+
+## API
+
+| Export | Description |
+| ------ | ----------- |
+| `classifyFailure` | Classify a single failure event |
+| `FailureClassifier` | Stateful classifier with custom rules |
+| `CLASSIFICATION_RULES` | Built-in rule definitions |
+| `fingerprintFailure` | Stable hash for root-cause grouping |
+| `clusterFailures` | Group failures by fingerprint |
+| `computeFlakinessScore` | Score flaky test history |
+
+## Development
+
+```bash
+pnpm --filter @healflow/classification build
+pnpm --filter @healflow/classification test
+```
+
+## Related packages
+
+- [`@healflow/shared`](../shared) — domain types and enums
+- [`@healflow/ingestion`](../ingestion) — parses reports then classifies
+
+## License
+
+MIT

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@healflow/classification",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "HealFlow failure classification engine",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "dependencies": {
-    "@healflow/shared": "^0.1.0"
+    "@healflow/shared": "^0.1.1"
   },
   "devDependencies": {
     "tsx": "^4.19.2",