@outcomeeng/spx 0.1.0

package/dist/index.d.ts

@@ -0,0 +1,116 @@
+/**
+ * Core type definitions for spx
+ */
+/**
+ * Work item types in the spec hierarchy
+ */
+type WorkItemKind = "capability" | "feature" | "story";
+/**
+ * Ordered hierarchy of work item kinds (root to leaf)
+ *
+ * Used by both production code and tests to derive hierarchy structure.
+ * Per ADR-21: Never hardcode kind names - derive from this constant.
+ */
+declare const WORK_ITEM_KINDS: readonly WorkItemKind[];
+/**
+ * The leaf kind (actionable work items)
+ *
+ * Derived from WORK_ITEM_KINDS to ensure consistency if hierarchy changes.
+ */
+declare const LEAF_KIND: WorkItemKind;
+/**
+ * Parsed work item structure
+ */
+interface WorkItem {
+    /** The type of work item */
+    kind: WorkItemKind;
+    /** BSP number (0-indexed for capabilities, as-is for features/stories) */
+    number: number;
+    /** URL-safe slug identifier */
+    slug: string;
+    /** Full filesystem path to work item directory */
+    path: string;
+}
+/**
+ * Directory entry from filesystem traversal
+ */
+interface DirectoryEntry {
+    /** Directory name (basename) */
+    name: string;
+    /** Full absolute path */
+    path: string;
+    /** Whether this is a directory */
+    isDirectory: boolean;
+}
+/**
+ * Work item status
+ */
+type WorkItemStatus = "OPEN" | "IN_PROGRESS" | "DONE";
+/**
+ * Ordered list of work item statuses
+ *
+ * Used by both production code and tests to derive status values.
+ * Per ADR-21: Never hardcode status names - derive from this constant.
+ */
+declare const WORK_ITEM_STATUSES: readonly WorkItemStatus[];
+
+/**
+ * Pattern matching for work item directory names
+ */
+
+/**
+ * Parse a work item directory name into structured data
+ *
+ * @param dirName - Directory name to parse
+ * @returns Parsed work item with kind, number, and slug (path not included)
+ * @throws Error if the directory name doesn't match the pattern or BSP number is invalid
+ *
+ * @example
+ * ```typescript
+ * parseWorkItemName("capability-21_core-cli")
+ * // Returns: { kind: "capability", number: 20, slug: "core-cli" }
+ *
+ * parseWorkItemName("feature-21_pattern-matching")
+ * // Returns: { kind: "feature", number: 21, slug: "pattern-matching" }
+ * ```
+ */
+declare function parseWorkItemName(dirName: string): Omit<WorkItem, 'path'>;
+
+/**
+ * Validation functions for BSP (Behavior, Structure, Property) numbers
+ */
+/**
+ * BSP number range constants
+ */
+declare const MIN_BSP_NUMBER = 10;
+declare const MAX_BSP_NUMBER = 99;
+/**
+ * Check if a number is a valid BSP number
+ *
+ * @param n - Number to validate
+ * @returns true if n is in range [10, 99], false otherwise
+ *
+ * @example
+ * ```typescript
+ * isValidBSPNumber(20)  // true
+ * isValidBSPNumber(9)   // false
+ * isValidBSPNumber(100) // false
+ * ```
+ */
+declare function isValidBSPNumber(n: number): boolean;
+/**
+ * Validate a BSP number and throw if invalid
+ *
+ * @param n - Number to validate
+ * @returns The validated number
+ * @throws Error if the number is outside the valid range [10, 99]
+ *
+ * @example
+ * ```typescript
+ * validateBSPNumber(20)  // returns 20
+ * validateBSPNumber(5)   // throws Error: "BSP number must be between 10 and 99, got 5"
+ * ```
+ */
+declare function validateBSPNumber(n: number): number;
+
+export { type DirectoryEntry, LEAF_KIND, MAX_BSP_NUMBER, MIN_BSP_NUMBER, WORK_ITEM_KINDS, WORK_ITEM_STATUSES, type WorkItem, type WorkItemKind, type WorkItemStatus, isValidBSPNumber, parseWorkItemName, validateBSPNumber };

package/dist/index.js

@@ -0,0 +1,21 @@
+import {
+  LEAF_KIND,
+  MAX_BSP_NUMBER,
+  MIN_BSP_NUMBER,
+  WORK_ITEM_KINDS,
+  WORK_ITEM_STATUSES,
+  isValidBSPNumber,
+  parseWorkItemName,
+  validateBSPNumber
+} from "./chunk-5L7CHFBC.js";
+export {
+  LEAF_KIND,
+  MAX_BSP_NUMBER,
+  MIN_BSP_NUMBER,
+  WORK_ITEM_KINDS,
+  WORK_ITEM_STATUSES,
+  isValidBSPNumber,
+  parseWorkItemName,
+  validateBSPNumber
+};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/package.json

@@ -0,0 +1,77 @@
+{
+  "name": "@outcomeeng/spx",
+  "version": "0.1.0",
+  "description": "Developer CLI for code validation and session management",
+  "type": "module",
+  "bin": {
+    "spx": "./bin/spx.js"
+  },
+  "files": [
+    "dist",
+    "bin"
+  ],
+  "engines": {
+    "node": ">=18"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "keywords": [
+    "cli",
+    "validation",
+    "session",
+    "workflow"
+  ],
+  "author": "Outcome Engineering",
+  "license": "MIT",
+  "devDependencies": {
+    "@faker-js/faker": "^10.2.0",
+    "@types/eslint-config-prettier": "^6.11.3",
+    "@types/madge": "^5.0.3",
+    "@types/node": "^20.10.0",
+    "@vitest/coverage-v8": "^4.0.18",
+    "eslint": "^9.39.2",
+    "eslint-config-prettier": "^10.1.8",
+    "eslint-plugin-import": "^2.32.0",
+    "execa": "^9.6.1",
+    "fast-check": "^4.5.3",
+    "globals": "^17.0.0",
+    "husky": "^9.1.7",
+    "lefthook": "^1.10.10",
+    "jsonc-parser": "^3.3.1",
+    "knip": "^5.80.0",
+    "prettier": "^3.7.4",
+    "tsup": "^8.0.1",
+    "tsx": "^4.21.0",
+    "typescript": "^5.3.3",
+    "typescript-eslint": "^8.51.0",
+    "vitest": "^4.0.18"
+  },
+  "dependencies": {
+    "chalk": "^5.6.2",
+    "commander": "^11.1.0",
+    "madge": "^8.0.0",
+    "yaml": "^2.8.2"
+  },
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "test:unit": "vitest run tests/unit",
+    "test:integration": "vitest run tests/integration",
+    "test:e2e": "vitest run tests/e2e",
+    "test:coverage": "vitest run --coverage",
+    "typecheck": "node bin/spx.js validation typescript",
+    "typecheck:production": "node bin/spx.js validation typescript --scope production",
+    "lint": "node bin/spx.js validation lint",
+    "lint:fix": "node bin/spx.js validation lint --fix",
+    "lint:production": "node bin/spx.js validation lint --scope production",
+    "validate": "node bin/spx.js validation all",
+    "validate:production": "node bin/spx.js validation all --scope production",
+    "knip": "node bin/spx.js validation knip",
+    "circular": "node bin/spx.js validation circular",
+    "format": "prettier --write .",
+    "format:check": "prettier --check ."
+  }
+}