@dommaker/harness 0.1.0 → 0.1.2

package/README.md

@@ -10,9 +10,10 @@
 
 | 功能 | 说明 |
 |------|------|
-| **铁律系统** | 定义和检查强制规则，违规则阻止操作 |
+| **铁律系统** | 13 条内置铁律，违规则阻止操作 |
 | **检查点验证** | 验证工作流步骤的结果是否符合预期 |
 | **测试门控** | 禁止自评通过，必须通过真实测试 |
+| **Session 管理** | 启动检查点 + 结束状态管理 |
 | **预设系统** | 提供 strict/standard/relaxed 三种预设 |
 | **CLI 工具** | 命令行工具执行检查 |
 
@@ -31,46 +32,35 @@ npx harness init --preset standard
 ```
 
 这会创建：
-- `.harness/presets.yml` - 预设配置
-- `.github/workflows/harness-check.yml` - CI 检查
+- `.harness/config.yml` - 预设配置
+- `.harness/checkpoints.yml` - 示例检查点
+- `CAPABILITIES.md` - 功能清单模板
+- `.git/hooks/pre-commit` - Git 钩子（可选）
+- `.github/workflows/harness-check.yml` - CI 检查（可选）
 
-### 2. 配置铁律
-
-创建 `.harness/iron-laws.yml`：
-
-```yaml
-iron_laws:
-  - id: no_self_approval
-    rule: "禁止自评通过"
-    message: "任务必须通过测试验证，不能自评完成"
-    severity: error
-  
-  - id: test_required
-    rule: "代码变更必须有测试"
-    message: "修改代码时必须添加或更新测试"
-    severity: warning
-```
-
-### 3. CLI 命令
+### 2. CLI 命令
 
 ```bash
+# 初始化项目配置
+harness init --preset standard
+
 # 检查铁律
 harness check
 
+# 列出所有铁律
+harness check --list
+
 # 验证检查点
 harness validate
 
 # 测试门控
 harness passes-gate
 
-# 初始化项目
-harness init --preset strict
-
 # 生成报告
-harness report --output html
+harness report
 ```
 
-### 4. 在 CI 中使用
+### 3. 在 CI 中使用
 
 ```yaml
 # .github/workflows/ci.yml
@@ -84,50 +74,75 @@ jobs:
       - run: npx harness passes-gate
 ```
 
-### 5. 在代码中使用
+### 4. 在代码中使用
 
 ```typescript
-import { IronLawChecker, CheckpointValidator, PassesGate } from '@dommaker/harness';
+import { 
+  IronLawChecker, 
+  CheckpointValidator, 
+  PassesGate,
+  SessionStartup,
+  CleanStateManager 
+} from '@dommaker/harness';
 
 // 检查铁律
-const violations = await IronLawChecker.check(context);
-if (violations.length > 0) {
-  console.error('Iron law violated:', violations[0].message);
-}
+const checker = IronLawChecker.getInstance();
+const results = await checker.checkAll(context);
 
 // 验证检查点
-const checkpoint = await CheckpointValidator.validate({
-  id: 'pre-commit',
-  checks: ['test_pass', 'lint_pass'],
-});
+const validator = new CheckpointValidator();
+const result = await validator.validate(checkpoints, context);
 
 // 测试门控
 const gate = new PassesGate({ requireEvidence: true });
-const result = await gate.verify();
-if (!result.passed) {
-  throw new Error('Passes gate failed');
-}
+const testResult = await gate.setPasses(taskId, true, workDir);
+
+// Session 启动检查
+const startup = new SessionStartup(workDir, checkpoints);
+const { success, results } = await startup.run();
+
+// Session 结束清理
+const cleaner = new CleanStateManager();
+const cleanResult = await cleaner.onSessionEnd(workDir, sessionInfo);
 ```
 
+## 内置铁律（13 条）
+
+| ID | 规则 | 严重性 |
+|---|------|:------:|
+| `no_simplification_without_approval` | 不能擅自简化逻辑 | 🔴 error |
+| `no_fix_without_root_cause` | 修复前必须找到根因 | 🔴 error |
+| `no_completion_without_verification` | 完成必须有验证证据 | 🔴 error |
+| `no_skill_without_test` | 创建技能前必须有测试 | 🟡 warning |
+| `no_code_without_test` | 写代码前必须有测试 | 🔴 error |
+| `no_creation_without_reuse_check` | 创建前必须检查可复用 | 🟡 warning |
+| `capability_sync` | 代码变更必须更新 CAPABILITIES.md | 🟡 warning |
+| `no_any_type` | 禁止使用 any 类型 | 🟡 warning |
+| `no_bypass_checkpoint` | 禁止跳过检查点 | 🔴 error |
+| `test_coverage_required` | 测试覆盖率必须达标 | 🟡 warning |
+| `no_self_approval` | 禁止自评通过 | 🔴 error |
+| `doc_required_for_public_api` | 公共 API 必须有文档 | 🟡 warning |
+| `readme_required` | 新模块必须有 README | 🔵 info |
+
 ## 预设系统
 
 | 预设 | 说明 |
 |------|------|
-| `strict` | 严格模式，所有检查都是 error 级别 |
+| `strict` | 严格模式，所有检查启用 |
 | `standard` | 标准模式，推荐使用 |
-| `relaxed` | 宽松模式，适合原型开发 |
+| `relaxed` | 宽松模式，警告不阻止 |
 
 ## 项目模板
 
-提供多种项目模板，预置 harness 配置：
+提供多种项目模板：
 
 - `node-api` - Node.js API 项目
 - `nextjs-app` - Next.js 应用
 - `python-api` - Python API 项目
 
 ```bash
-# 从模板创建项目
-harness init --template node-api
+# 指定项目类型
+harness init --type node-api
 ```
 
 ## API 文档
@@ -135,35 +150,53 @@ harness init --template node-api
 ### IronLawChecker
 
 ```typescript
-interface IronLawChecker {
-  // 检查铁律
-  static check(context: IronLawContext): Promise<IronLawViolation[]>;
+class IronLawChecker {
+  static getInstance(): IronLawChecker;
   
-  // 加载配置
-  static loadConfig(path: string): Promise<IronLawConfig>;
+  checkAll(context: IronLawContext): Promise<IronLawResult[]>;
+  beforeExecution(context: IronLawContext): Promise<void>;
+  checkIronLaw(lawId: string, context: IronLawContext): Promise<IronLawResult>;
 }
 ```
 
 ### CheckpointValidator
 
 ```typescript
-interface CheckpointValidator {
-  // 验证检查点
-  static validate(checkpoint: CheckpointInput): Promise<CheckpointResult>;
-  
-  // 注册检查器
-  static register(type: string, handler: CheckHandler): void;
+class CheckpointValidator {
+  validate(checkpoints: Checkpoint[], context: CheckpointContext): Promise<CheckpointResult>;
 }
 ```
 
 ### PassesGate
 
 ```typescript
-interface PassesGate {
+class PassesGate {
   constructor(config: PassesGateConfig);
   
-  // 验证是否通过
-  verify(): Promise<PassesGateResult>;
+  setPasses(taskId: string, value: boolean, workDir: string): Promise<PassesGateResult>;
+  runTests(): Promise<TestResult>;
+}
+```
+
+### SessionStartup
+
+```typescript
+class SessionStartup {
+  constructor(workDir: string, checkpoints: StartupCheckpoints);
+  
+  run(): Promise<{ success: boolean; results: StartupCheckpointResult[] }>;
+  getCurrentTask(): Promise<{ task: any; index: number } | null>;
+  generateReport(results: StartupCheckpointResult[]): string;
+}
+```
+
+### CleanStateManager
+
+```typescript
+class CleanStateManager {
+  constructor(config: CleanStateConfig);
+  
+  onSessionEnd(workDir: string, sessionInfo: SessionInfo): Promise<CleanStateResult>;
 }
 ```
 
@@ -178,11 +211,8 @@ npm run build
 
 # 测试
 npm test
-
-# 监听模式
-npm run dev
 ```
 
 ## 许可证
 
-MIT © kww
+MIT © dommaker

package/dist/core/validators/index.d.ts

@@ -2,7 +2,7 @@
  * 验证器导出
  */
 export { CheckpointValidator } from './checkpoint';
-export { PassesGate } from './passes-gate';
+export { PassesGate, createPassesGate } from './passes-gate';
 export { CSOValidator, type CSOValidationResult, type CSOIssue } from './cso';
 export type { Checkpoint, CheckpointCheck, CheckpointResult, CheckResult, CheckpointContext, CheckType, CheckConfig, } from '../../types/checkpoint';
 export type { PassesGateConfig, PassesGateResult, TaskTestResult, DynamicTask, } from '../../types/passes-gate';

package/dist/core/validators/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/core/validators/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,mBAAmB,EAAE,MAAM,cAAc,CAAC;AACnD,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAC3C,OAAO,EAAE,YAAY,EAAE,KAAK,mBAAmB,EAAE,KAAK,QAAQ,EAAE,MAAM,OAAO,CAAC;AAG9E,YAAY,EACV,UAAU,EACV,eAAe,EACf,gBAAgB,EAChB,WAAW,EACX,iBAAiB,EACjB,SAAS,EACT,WAAW,GACZ,MAAM,wBAAwB,CAAC;AAEhC,YAAY,EACV,gBAAgB,EAChB,gBAAgB,EAChB,cAAc,EACd,WAAW,GACZ,MAAM,yBAAyB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/core/validators/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,mBAAmB,EAAE,MAAM,cAAc,CAAC;AACnD,OAAO,EAAE,UAAU,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAC;AAC7D,OAAO,EAAE,YAAY,EAAE,KAAK,mBAAmB,EAAE,KAAK,QAAQ,EAAE,MAAM,OAAO,CAAC;AAG9E,YAAY,EACV,UAAU,EACV,eAAe,EACf,gBAAgB,EAChB,WAAW,EACX,iBAAiB,EACjB,SAAS,EACT,WAAW,GACZ,MAAM,wBAAwB,CAAC;AAEhC,YAAY,EACV,gBAAgB,EAChB,gBAAgB,EAChB,cAAc,EACd,WAAW,GACZ,MAAM,yBAAyB,CAAC"}

package/dist/core/validators/index.js

@@ -3,11 +3,12 @@
  * 验证器导出
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.CSOValidator = exports.PassesGate = exports.CheckpointValidator = void 0;
+exports.CSOValidator = exports.createPassesGate = exports.PassesGate = exports.CheckpointValidator = void 0;
 var checkpoint_1 = require("./checkpoint");
 Object.defineProperty(exports, "CheckpointValidator", { enumerable: true, get: function () { return checkpoint_1.CheckpointValidator; } });
 var passes_gate_1 = require("./passes-gate");
 Object.defineProperty(exports, "PassesGate", { enumerable: true, get: function () { return passes_gate_1.PassesGate; } });
+Object.defineProperty(exports, "createPassesGate", { enumerable: true, get: function () { return passes_gate_1.createPassesGate; } });
 var cso_1 = require("./cso");
 Object.defineProperty(exports, "CSOValidator", { enumerable: true, get: function () { return cso_1.CSOValidator; } });
 //# sourceMappingURL=index.js.map

package/dist/core/validators/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/core/validators/index.ts"],"names":[],"mappings":";AAAA;;GAEG;;;AAEH,2CAAmD;AAA1C,iHAAA,mBAAmB,OAAA;AAC5B,6CAA2C;AAAlC,yGAAA,UAAU,OAAA;AACnB,6BAA8E;AAArE,mGAAA,YAAY,OAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/core/validators/index.ts"],"names":[],"mappings":";AAAA;;GAEG;;;AAEH,2CAAmD;AAA1C,iHAAA,mBAAmB,OAAA;AAC5B,6CAA6D;AAApD,yGAAA,UAAU,OAAA;AAAE,+GAAA,gBAAgB,OAAA;AACrC,6BAA8E;AAArE,mGAAA,YAAY,OAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dommaker/harness",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "通用工程约束框架 - 铁律系统、检查点验证、测试门控",
   "keywords": [
     "harness",
@@ -71,4 +71,4 @@
     "url": "https://github.com/kww/harness/issues"
   },
   "homepage": "https://github.com/kww/harness#readme"
-}
+}