speckeeper 0.1.0

package/dist/templates/init/design/_models/term.ts

@@ -0,0 +1,58 @@
+/**
+ * Term Model Definition
+ */
+import { z } from 'zod';
+import { Model, RelationSchema } from 'speckeeper';
+import type { LintRule, Exporter, ModelLevel } from 'speckeeper';
+
+// =============================================================================
+// Schema Definition
+// =============================================================================
+
+export const TermSchema = z.object({
+  id: z.string(),
+  term: z.string(),
+  definition: z.string(),
+  category: z.enum(['business', 'technical', 'acronym', 'process', 'role']),
+  abbreviation: z.string().optional(),
+  expandedForm: z.string().optional(),
+  relations: z.array(RelationSchema).optional(),
+});
+
+// =============================================================================
+// Type Export
+// =============================================================================
+
+export type Term = z.input<typeof TermSchema>;
+
+// =============================================================================
+// Model Class
+// =============================================================================
+
+class TermModel extends Model<typeof TermSchema> {
+  readonly id = 'term';
+  readonly name = 'Term';
+  readonly idPrefix = 'TERM';
+  readonly schema = TermSchema;
+  readonly description = 'Defines terms (glossary)';
+  protected modelLevel: ModelLevel = 'L0';
+
+  protected lintRules: LintRule<Term>[] = [
+    {
+      id: 'term-has-definition',
+      severity: 'error',
+      message: 'Term must have a definition',
+      check: (spec) => !spec.definition || spec.definition.trim() === '',
+    },
+    {
+      id: 'term-acronym-has-expanded-form',
+      severity: 'warning',
+      message: 'Acronym terms should have an expanded form',
+      check: (spec) => spec.category === 'acronym' && !spec.expandedForm,
+    },
+  ];
+
+  protected exporters: Exporter<Term>[] = [];
+}
+
+export { TermModel };

package/dist/templates/init/design/_models/usecase.ts

@@ -0,0 +1,99 @@
+/**
+ * UseCase Model Definition
+ */
+import { z } from 'zod';
+import { Model, RelationSchema } from 'speckeeper';
+import type { LintRule, Exporter, ModelLevel } from 'speckeeper';
+
+// =============================================================================
+// Schema Definition
+// =============================================================================
+
+export const ActorSchema = z.object({
+  id: z.string(),
+  name: z.string(),
+  description: z.string().optional(),
+  type: z.enum(['human', 'system', 'external']),
+  relations: z.array(RelationSchema).optional(),
+});
+
+export const UseCaseStepSchema = z.object({
+  stepNumber: z.number(),
+  type: z.enum(['user_action', 'system_response', 'alternative']),
+  description: z.string(),
+});
+
+export const UseCaseSchema = z.object({
+  id: z.string(),
+  name: z.string(),
+  description: z.string(),
+  actor: z.string(),
+  preconditions: z.array(z.string()).optional().default([]),
+  postconditions: z.array(z.string()).optional().default([]),
+  mainFlow: z.array(UseCaseStepSchema),
+  relations: z.array(RelationSchema).optional(),
+});
+
+// =============================================================================
+// Type Export
+// =============================================================================
+
+export type Actor = z.input<typeof ActorSchema>;
+export type UseCaseStep = z.infer<typeof UseCaseStepSchema>;
+export type UseCase = z.input<typeof UseCaseSchema>;
+
+// =============================================================================
+// Actor Model Class
+// =============================================================================
+
+class ActorModel extends Model<typeof ActorSchema> {
+  readonly id = 'actor';
+  readonly name = 'Actor';
+  readonly idPrefix = 'ACT';
+  readonly schema = ActorSchema;
+  readonly description = 'Defines actors';
+  protected modelLevel: ModelLevel = 'L0';
+
+  protected lintRules: LintRule<Actor>[] = [
+    {
+      id: 'actor-has-description',
+      severity: 'warning',
+      message: 'Actor should have a description',
+      check: (spec) => !spec.description || spec.description.trim() === '',
+    },
+  ];
+
+  protected exporters: Exporter<Actor>[] = [];
+}
+
+// =============================================================================
+// UseCase Model Class
+// =============================================================================
+
+class UseCaseModel extends Model<typeof UseCaseSchema> {
+  readonly id = 'usecase';
+  readonly name = 'UseCase';
+  readonly idPrefix = 'UC';
+  readonly schema = UseCaseSchema;
+  readonly description = 'Defines use cases (business flows)';
+  protected modelLevel: ModelLevel = 'L0';
+
+  protected lintRules: LintRule<UseCase>[] = [
+    {
+      id: 'usecase-has-main-flow',
+      severity: 'error',
+      message: 'UseCase must have a main flow',
+      check: (spec) => !spec.mainFlow || spec.mainFlow.length === 0,
+    },
+    {
+      id: 'usecase-has-actor',
+      severity: 'error',
+      message: 'UseCase must have an actor',
+      check: (spec) => !spec.actor || spec.actor.trim() === '',
+    },
+  ];
+
+  protected exporters: Exporter<UseCase>[] = [];
+}
+
+export { ActorModel, UseCaseModel };

package/dist/templates/init/design/index.ts

@@ -0,0 +1,8 @@
+/**
+ * Design specifications index
+ */
+
+// Requirements
+export { requirements } from './requirements.ts';
+
+console.log('Design specifications loaded!');

package/dist/templates/init/design/requirements.ts

@@ -0,0 +1,20 @@
+/**
+ * Requirements
+ */
+import type { Requirement } from './_models/requirement.ts';
+
+export const requirements: Requirement[] = [
+  {
+    id: 'FR-001',
+    name: 'User Authentication',
+    type: 'functional',
+    priority: 'must',
+    description: 'Users can authenticate using email and password',
+    acceptanceCriteria: [
+      { id: 'FR-001-01', description: 'Valid credentials grant access', verificationMethod: 'test' },
+      { id: 'FR-001-02', description: 'Invalid credentials show error message', verificationMethod: 'test' },
+    ],
+  },
+];
+
+console.log(`Requirements loaded: ${requirements.length} items`);

package/dist/templates/init/package.json.template

@@ -0,0 +1,17 @@
+{
+  "name": "{{PROJECT_NAME}}",
+  "version": "1.0.0",
+  "type": "module",
+  "scripts": {
+    "typecheck": "tsc --noEmit",
+    "lint": "speckeeper lint",
+    "check": "speckeeper check"
+  },
+  "dependencies": {
+    "speckeeper": "^0.1.0",
+    "zod": "^3.22.4"
+  },
+  "devDependencies": {
+    "typescript": "^5.3.0"
+  }
+}

package/dist/templates/init/speckeeper.config.ts

@@ -0,0 +1,11 @@
+/**
+ * speckeeper configuration file
+ */
+import { defineConfig } from 'speckeeper';
+import { allModels } from './design/_models/index';
+
+export default defineConfig({
+  projectName: 'my-project',
+  version: '1.0.0',
+  models: allModels,
+});

package/dist/templates/init/tsconfig.json

@@ -0,0 +1,14 @@
+{
+  "compilerOptions": {
+    "target": "ES2022",
+    "module": "ESNext",
+    "moduleResolution": "bundler",
+    "allowImportingTsExtensions": true,
+    "noEmit": true,
+    "strict": true,
+    "skipLibCheck": true,
+    "esModuleInterop": true,
+    "forceConsistentCasingInFileNames": true
+  },
+  "include": ["design/**/*", "speckeeper.config.ts"]
+}

package/package.json

@@ -0,0 +1,80 @@
+{
+  "name": "speckeeper",
+  "version": "0.1.0",
+  "description": "TypeScript-first specification validation framework with external SSOT integration",
+  "type": "module",
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    },
+    "./dsl": {
+      "import": "./dist/dsl/index.js",
+      "types": "./dist/dsl/index.d.ts"
+    }
+  },
+  "bin": {
+    "speckeeper": "./bin/speckeeper.js"
+  },
+  "engines": {
+    "node": ">=20.0.0"
+  },
+  "files": [
+    "dist",
+    "bin"
+  ],
+  "scripts": {
+    "build": "tsup",
+    "build:docs": "npm run build && embedoc build",
+    "dev": "tsup --watch",
+    "lint": "eslint",
+    "lint:design": "eslint design/",
+    "test": "vitest",
+    "test:run": "vitest run",
+    "typecheck": "tsc --noEmit",
+    "prepublishOnly": "npm run build",
+    "docs": "embedoc build",
+    "docs:watch": "embedoc watch",
+    "ci": "npm run ci:validate && npm run ci:generate && npm run ci:verify",
+    "ci:validate": "npm run typecheck && npm run lint && npm run lint:design && npm run build && npx speckeeper lint && npm run test:run",
+    "ci:generate": "embedoc build",
+    "ci:verify": "npx speckeeper check external-ssot && npx speckeeper check test && npx speckeeper check test --coverage"
+  },
+  "keywords": [
+    "requirements",
+    "design",
+    "documentation",
+    "markdown",
+    "mermaid",
+    "typescript",
+    "dsl",
+    "architecture",
+    "c4-model"
+  ],
+  "author": "",
+  "license": "MIT",
+  "dependencies": {
+    "chalk": "^5.3.0",
+    "commander": "^12.1.0",
+    "embedoc": "^0.10.1",
+    "glob": "^10.3.10",
+    "tsx": "^4.21.0",
+    "yaml": "^2.3.4",
+    "zod": "^3.22.4"
+  },
+  "devDependencies": {
+    "@eslint/js": "^9.39.2",
+    "@types/node": "^20.11.0",
+    "@typescript-eslint/eslint-plugin": "^8.54.0",
+    "@typescript-eslint/parser": "^8.54.0",
+    "@vitest/coverage-v8": "^1.6.1",
+    "eslint": "^9.39.2",
+    "tsup": "^8.0.1",
+    "typescript": "^5.3.3",
+    "typescript-eslint": "^8.54.0",
+    "vitest": "^1.2.0"
+  }
+}