ai-spector 0.1.1

package/assets/workflow/templates/srs/7-quality-attributes.md

@@ -0,0 +1,74 @@
+## 7. Non-Functional Requirements (Quality Attributes)
+
+> This section specifies the non-functional requirements that define the quality attributes, constraints, and performance characteristics of the system. These requirements describe how the system should behave rather than what functions it should perform.
+
+### 7.1 Usability
+
+> Specify any requirements regarding characteristics that will make the software appear to be "user-friendly."
+
+**Requirements:**
+- **Ease of Use:** <Requirement>
+- **Ease of Learning:** <Requirement>
+- **Accessibility:** <Requirement>
+- **Error Handling:** <Requirement>
+
+**UI Design Standards:**
+- <Standard 1>
+- <Standard 2>
+
+### 7.2 Performance
+
+> State specific performance requirements for various system operations.
+
+| Operation | Response Time Requirement |
+|-----------|---------------------------|
+| <Operation 1> | <Time requirement> |
+| <Operation 2> | <Time requirement> |
+
+**Throughput Requirements:**
+- <Requirement 1>
+- <Requirement 2>
+
+### 7.3 Security
+
+> Specify any requirements regarding security or privacy issues.
+
+**Requirements:**
+- **Access Control:** <Requirement>
+- **Authentication:** <Requirement>
+- **Authorization:** <Requirement>
+- **Data Security:** <Requirement>
+- **Privacy:** <Requirement>
+
+**Compliance:**
+- <Compliance requirement 1>
+- <Compliance requirement 2>
+
+### 7.4 Safety
+
+> Specify requirements that are concerned with possible loss, damage, or harm.
+
+**Requirements:**
+- <Requirement 1>
+- <Requirement 2>
+
+**Safeguards:**
+- <Safeguard 1>
+- <Safeguard 2>
+
+### 7.5 Others as relevant
+
+> Create a separate section for each additional product quality attribute.
+
+**Availability:**
+- <Requirement 1>
+- <Requirement 2>
+
+**Reliability:**
+- <Requirement 1>
+- <Requirement 2>
+
+**Maintainability:**
+- <Requirement 1>
+- <Requirement 2>
+

package/assets/workflow/templates/srs/8-internationalization.md

@@ -0,0 +1,36 @@
+## 8. Internationalization and Localization Requirements
+
+> Internationalization and localization requirements ensure that the product will be suitable for use in nations, cultures, and geographic locations other than those in which it was created.
+
+**Supported Languages:**
+
+- <Language 1>
+- <Language 2>
+
+**Supported Locales:**
+
+- <Locale 1>
+- <Locale 2>
+
+**Formatting Requirements:**
+
+- **Currency:** 
+- **Date/Time:** 
+- **Numbers:** 
+- **Addresses:** 
+
+**Character Sets:**
+
+- <Requirement 1>
+- <Requirement 2>
+
+**Cultural Considerations:**
+
+- <Consideration 1>
+- <Consideration 2>
+
+**Regulatory Compliance:**
+
+- <Regulation 1>
+- <Regulation 2>
+

package/assets/workflow/templates/srs/9-other-requirements.md

@@ -0,0 +1,46 @@
+## 9. Other Requirements
+
+> Examples are: legal, regulatory or financial compliance, and standards requirements; requirements for product installation, configuration, startup, and shutdown; and logging, monitoring and audit trail requirements.
+
+### 9.1 Legal and Regulatory Compliance
+
+**Legal Requirements:**
+- <Requirement 1>
+- <Requirement 2>
+
+**Regulatory Compliance:**
+- <Compliance requirement 1>
+- <Compliance requirement 2>
+
+**Standards Compliance:**
+- <Standard 1>
+- <Standard 2>
+
+### 9.2 Installation and Configuration
+
+**Installation Requirements:**
+- <Requirement 1>
+- <Requirement 2>
+
+**Configuration Requirements:**
+- <Requirement 1>
+- <Requirement 2>
+
+**Startup/Shutdown Requirements:**
+- <Requirement 1>
+- <Requirement 2>
+
+### 9.3 Logging and Monitoring
+
+**Logging Requirements:**
+- <Requirement 1>
+- <Requirement 2>
+
+**Monitoring Requirements:**
+- <Requirement 1>
+- <Requirement 2>
+
+**Audit Trail Requirements:**
+- <Requirement 1>
+- <Requirement 2>
+

package/bin/spec-writer.js

@@ -0,0 +1,56 @@
+#!/usr/bin/env node
+
+const { runInit } = require("../src/cli/init");
+
+function parseArgs(argv) {
+  const [command, ...rest] = argv;
+  const flags = {
+    yes: false,
+    force: false,
+    noGraphify: false,
+    skipIndex: false
+  };
+
+  for (const arg of rest) {
+    if (arg === "--yes" || arg === "-y") flags.yes = true;
+    if (arg === "--force" || arg === "-f") flags.force = true;
+    if (arg === "--no-graphify") flags.noGraphify = true;
+    if (arg === "--skip-index") flags.skipIndex = true;
+  }
+
+  return { command, flags };
+}
+
+function printHelp() {
+  console.log(`spec-writer
+
+Usage:
+  spec-writer init [--yes] [--force] [--no-graphify] [--skip-index]
+
+Commands:
+  init          Install Cursor commands, skill, templates, and workflow files.
+`);
+}
+
+async function main() {
+  const { command, flags } = parseArgs(process.argv.slice(2));
+
+  if (!command || command === "--help" || command === "-h") {
+    printHelp();
+    return;
+  }
+
+  if (command === "init") {
+    await runInit(process.cwd(), flags);
+    return;
+  }
+
+  console.error(`Unknown command: ${command}`);
+  printHelp();
+  process.exitCode = 1;
+}
+
+main().catch((error) => {
+  console.error(error.message);
+  process.exitCode = 1;
+});

package/package.json

@@ -0,0 +1,25 @@
+{
+  "name": "ai-spector",
+  "version": "0.1.1",
+  "description": "Cursor skill and workflow bootstrapper for incremental SRS/detail design generation.",
+  "type": "commonjs",
+  "bin": {
+    "ai-spector": "bin/spec-writer.js"
+  },
+  "keywords": [
+    "cursor",
+    "documentation",
+    "srs",
+    "workflow",
+    "graphify"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "license": "MIT",
+  "scripts": {
+    "start": "node bin/spec-writer.js",
+    "init:local": "node bin/spec-writer.js init",
+    "lint": "node -e \"console.log('No linter configured yet')\""
+  }
+}

package/src/cli/helpers/fs.js

@@ -0,0 +1,50 @@
+const fs = require("fs");
+const path = require("path");
+
+function ensureDir(targetDir) {
+  fs.mkdirSync(targetDir, { recursive: true });
+}
+
+function copyRecursive(sourcePath, targetPath, options = {}) {
+  const { overwrite = false } = options;
+  const stat = fs.statSync(sourcePath);
+
+  if (stat.isDirectory()) {
+    ensureDir(targetPath);
+    for (const entry of fs.readdirSync(sourcePath)) {
+      copyRecursive(
+        path.join(sourcePath, entry),
+        path.join(targetPath, entry),
+        options
+      );
+    }
+    return;
+  }
+
+  if (!overwrite && fs.existsSync(targetPath)) return;
+  ensureDir(path.dirname(targetPath));
+  fs.copyFileSync(sourcePath, targetPath);
+}
+
+function writeJson(targetPath, data, options = {}) {
+  const { overwrite = false } = options;
+  if (!overwrite && fs.existsSync(targetPath)) return;
+  ensureDir(path.dirname(targetPath));
+  fs.writeFileSync(targetPath, JSON.stringify(data, null, 2) + "\n", "utf8");
+}
+
+function readJson(targetPath, fallback = {}) {
+  try {
+    const raw = fs.readFileSync(targetPath, "utf8");
+    return JSON.parse(raw);
+  } catch (_err) {
+    return fallback;
+  }
+}
+
+module.exports = {
+  ensureDir,
+  copyRecursive,
+  writeJson,
+  readJson
+};

package/src/cli/init.js

@@ -0,0 +1,178 @@
+const fs = require("fs");
+const path = require("path");
+const { spawnSync } = require("child_process");
+const { ensureDir, copyRecursive, writeJson, readJson } = require("./helpers/fs");
+
+function getPackageRoot() {
+  return path.resolve(__dirname, "../..");
+}
+
+function targetPaths(cwd) {
+  return {
+    cursorCommands: path.join(cwd, ".cursor/commands"),
+    cursorSkill: path.join(cwd, ".cursor/skills/spec-writer"),
+    docsRoot: path.join(cwd, "docs"),
+    templates: path.join(cwd, "docs/_templates"),
+    docflowRoot: path.join(cwd, "docs/.docflow"),
+    graphIndex: path.join(cwd, "docs/.docflow/graph/graphify-index"),
+    analysis: path.join(cwd, "docs/.docflow/analysis"),
+    partialsSrs: path.join(cwd, "docs/.docflow/partials/srs"),
+    partialsDetail: path.join(cwd, "docs/.docflow/partials/detail-design"),
+    logs: path.join(cwd, "docs/.docflow/logs"),
+    config: path.join(cwd, "docs/.docflow/config"),
+    outputSrs: path.join(cwd, "docs/output/srs"),
+    outputDetail: path.join(cwd, "docs/output/detail-design")
+  };
+}
+
+function installGraphify(cwd) {
+  const detect = spawnSync("npx", ["--yes", "graphify", "--help"], {
+    cwd,
+    stdio: "ignore"
+  });
+  if (detect.status === 0) return { installed: false, available: true };
+
+  const install = spawnSync("npm", ["install", "--save-dev", "graphify"], {
+    cwd,
+    stdio: "inherit"
+  });
+  return {
+    installed: install.status === 0,
+    available: install.status === 0
+  };
+}
+
+function runInitialGraphifyIndex(cwd, graphConfigPath) {
+  const args = [
+    "--yes",
+    "graphify",
+    "index",
+    "--config",
+    graphConfigPath
+  ];
+  const result = spawnSync("npx", args, { cwd, stdio: "inherit" });
+  return result.status === 0;
+}
+
+function installAssets(cwd, options) {
+  const pkgRoot = getPackageRoot();
+  const t = targetPaths(cwd);
+
+  const copyOptions = { overwrite: Boolean(options.force) };
+
+  ensureDir(t.cursorCommands);
+  ensureDir(t.cursorSkill);
+  ensureDir(t.docsRoot);
+  ensureDir(t.templates);
+  ensureDir(t.graphIndex);
+  ensureDir(t.analysis);
+  ensureDir(t.partialsSrs);
+  ensureDir(t.partialsDetail);
+  ensureDir(t.logs);
+  ensureDir(t.config);
+  ensureDir(t.outputSrs);
+  ensureDir(t.outputDetail);
+
+  copyRecursive(
+    path.join(pkgRoot, "assets/cursor/commands"),
+    t.cursorCommands,
+    copyOptions
+  );
+  copyRecursive(
+    path.join(pkgRoot, "assets/cursor/skills/spec-writer"),
+    t.cursorSkill,
+    copyOptions
+  );
+  copyRecursive(
+    path.join(pkgRoot, "assets/workflow/templates"),
+    t.templates,
+    copyOptions
+  );
+  copyRecursive(
+    path.join(pkgRoot, "assets/workflow/config"),
+    t.config,
+    copyOptions
+  );
+
+  const stateTemplatePath = path.join(
+    pkgRoot,
+    "assets/workflow/state/state.template.json"
+  );
+  const stateOutputPath = path.join(t.docflowRoot, "state.json");
+  const template = readJson(stateTemplatePath, {});
+  writeJson(stateOutputPath, template, copyOptions);
+
+  const defaultAnalysisFiles = {
+    knowledgeVersion: 1,
+    generatedAt: null,
+    scope: [],
+    actors: [],
+    useCases: [],
+    features: [],
+    functionalRequirements: [],
+    nfrs: [],
+    entities: [],
+    interfaces: [],
+    constraints: [],
+    openQuestions: []
+  };
+  const defaultGaps = {
+    generatedAt: null,
+    missingSections: [],
+    notes: []
+  };
+
+  writeJson(
+    path.join(t.analysis, "knowledge.json"),
+    defaultAnalysisFiles,
+    copyOptions
+  );
+  writeJson(path.join(t.analysis, "gaps.json"), defaultGaps, copyOptions);
+  writeJson(
+    path.join(t.analysis, "scope.json"),
+    { sources: [], mode: "workspace", analyzedAt: null },
+    copyOptions
+  );
+}
+
+async function runInit(cwd, options) {
+  installAssets(cwd, options);
+  const t = targetPaths(cwd);
+
+  let graphifyReady = false;
+  let graphifyInstalled = false;
+
+  if (!options.noGraphify) {
+    const result = installGraphify(cwd);
+    graphifyReady = result.available;
+    graphifyInstalled = result.installed;
+    if (!graphifyReady) {
+      console.warn(
+        "Graphify installation failed. Continue with manual setup later."
+      );
+    }
+  }
+
+  if (graphifyReady && !options.skipIndex) {
+    const graphConfigPath = path.join(t.config, "analyze.graphify.json");
+    runInitialGraphifyIndex(cwd, graphConfigPath);
+  }
+
+  const statePath = path.join(t.docflowRoot, "state.json");
+  const state = readJson(statePath, {});
+  state.graphify = {
+    ready: graphifyReady,
+    installedByInit: graphifyInstalled,
+    lastBootstrapAt: new Date().toISOString()
+  };
+  writeJson(statePath, state, { overwrite: true });
+
+  console.log("Spec Writer initialization complete.");
+  console.log("Next steps:");
+  console.log("- Run `/analyze [paths...]` in Cursor.");
+  console.log("- Run `/generate-srs` and `/generate-detail-design` incrementally.");
+}
+
+module.exports = {
+  runInit
+};