@signaltree/guardrails 4.0.15 → 4.0.16

package/CHANGELOG.md

@@ -0,0 +1,15 @@
+# @signaltree/guardrails Changelog
+
+## 1.1.0 (2025-11-12)
+
+- Added recomputation tracking, percentile reporting, and diff ratio analysis
+- Implemented memory-leak heuristics, hot-path sampling, and guardrails disposal API
+- Introduced factory helpers (`createFeatureTree`, `createPerformanceTree`, etc.)
+- Integrated guardrails into release automation, bundle analysis, and coverage scripts
+- Published comprehensive documentation set (migration guide, troubleshooting, limitations)
+
+## 1.0.0 (2025-10-??)
+
+- Initial release with core budgets, hot-path detection, and custom rule engine
+- Dev-only exports to guarantee zero production overhead
+

package/README.md

@@ -0,0 +1,51 @@
+# @signaltree/guardrails
+
+> Development-only performance monitoring and anti-pattern detection for SignalTree
+
+## Features
+
+- ✅ **Zero production cost** - Dev-only via conditional exports
+- ✅ **Performance budgets** - Update time, memory, recomputations
+- ✅ **Hot path analysis** - Automatic detection with heat scores
+- ✅ **Memory leak detection** - Retention and growth tracking
+- ✅ **Custom rules engine** - Team-specific policies
+- ✅ **Intent-aware suppression** - Smart noise reduction
+- ✅ **Percentile reporting** - P50/P95/P99 metrics
+
+## Installation
+
+```bash
+npm install --save-dev @signaltree/guardrails
+```
+
+## Quick Start
+
+```typescript
+import { signalTree } from '@signaltree/core';
+import { withGuardrails } from '@signaltree/guardrails';
+
+const tree = signalTree({ count: 0 }).with(withGuardrails({
+  budgets: { maxUpdateTime: 16 },
+  hotPaths: { threshold: 10 },
+}));
+```
+
+## Using Factories
+
+```typescript
+import { signalTree } from '@signaltree/core';
+import { createFeatureTree } from '@signaltree/guardrails/factories';
+
+const tree = createFeatureTree(signalTree, { data: [] }, {
+  name: 'dashboard',
+  guardrails: true,
+});
+```
+
+## Configuration
+
+See [docs/guardrails](../../docs/guardrails) for complete documentation.
+
+## License
+
+MIT