@nerviq/cli 0.0.1 → 0.9.0-beta.1

package/src/copilot/config-parser.js

@@ -0,0 +1,226 @@
+/**
+ * Copilot config parser.
+ *
+ * Copilot uses JSON for .vscode/settings.json and .vscode/mcp.json,
+ * plus YAML frontmatter in *.instructions.md and *.prompt.md files.
+ * This module handles both formats with unified value extraction.
+ */
+
+// ─── JSON parsing ────────────────────────────────────────────────────────────
+
+function tryParseJson(content) {
+  try {
+    const data = JSON.parse(content);
+    return { ok: true, data, error: null };
+  } catch (error) {
+    return { ok: false, data: null, error: error.message };
+  }
+}
+
+// ─── YAML frontmatter parsing ────────────────────────────────────────────────
+
+/**
+ * Extract YAML frontmatter from a markdown file.
+ * Frontmatter is delimited by --- at the start of the file.
+ * Returns { frontmatter: object|null, body: string, raw: string|null }
+ */
+function extractFrontmatter(content) {
+  if (!content || typeof content !== 'string') {
+    return { frontmatter: null, body: content || '', raw: null };
+  }
+
+  const trimmed = content.trimStart();
+  if (!trimmed.startsWith('---')) {
+    return { frontmatter: null, body: content, raw: null };
+  }
+
+  const endIdx = trimmed.indexOf('---', 3);
+  if (endIdx === -1) {
+    return { frontmatter: null, body: content, raw: null };
+  }
+
+  const raw = trimmed.slice(3, endIdx).trim();
+  const body = trimmed.slice(endIdx + 3).trim();
+  const frontmatter = parseSimpleYaml(raw);
+
+  return { frontmatter, body, raw };
+}
+
+/**
+ * Minimal YAML parser for frontmatter fields.
+ * Handles: key: value, key: [item1, item2], key: "quoted", booleans, numbers.
+ * Does NOT handle nested objects or multi-line values (use a full YAML parser for those).
+ */
+function parseSimpleYaml(yamlStr) {
+  if (!yamlStr || typeof yamlStr !== 'string') return {};
+
+  const result = {};
+  const lines = yamlStr.split(/\r?\n/);
+
+  for (const line of lines) {
+    const trimmedLine = line.trim();
+    if (!trimmedLine || trimmedLine.startsWith('#')) continue;
+
+    const colonIdx = trimmedLine.indexOf(':');
+    if (colonIdx === -1) continue;
+
+    const key = trimmedLine.slice(0, colonIdx).trim();
+    let value = trimmedLine.slice(colonIdx + 1).trim();
+
+    if (!key) continue;
+
+    // Parse value
+    if (value === '') {
+      result[key] = null;
+    } else if (value.startsWith('[') && value.endsWith(']')) {
+      // Inline array: [item1, item2]
+      const inner = value.slice(1, -1).trim();
+      if (!inner) {
+        result[key] = [];
+      } else {
+        result[key] = inner.split(',').map(item => {
+          const t = item.trim();
+          return stripQuotes(t);
+        });
+      }
+    } else if ((value.startsWith('"') && value.endsWith('"')) ||
+               (value.startsWith("'") && value.endsWith("'"))) {
+      result[key] = value.slice(1, -1);
+    } else if (value === 'true') {
+      result[key] = true;
+    } else if (value === 'false') {
+      result[key] = false;
+    } else if (/^-?\d+$/.test(value)) {
+      result[key] = parseInt(value, 10);
+    } else if (/^-?\d+\.\d+$/.test(value)) {
+      result[key] = parseFloat(value);
+    } else {
+      result[key] = value;
+    }
+  }
+
+  return result;
+}
+
+function stripQuotes(str) {
+  if ((str.startsWith('"') && str.endsWith('"')) ||
+      (str.startsWith("'") && str.endsWith("'"))) {
+    return str.slice(1, -1);
+  }
+  return str;
+}
+
+// ─── Value extraction ────────────────────────────────────────────────────────
+
+function getValueByPath(obj, dottedPath) {
+  if (!obj) return undefined;
+  const parts = dottedPath.split('.').filter(Boolean);
+  let cursor = obj;
+  for (const part of parts) {
+    if (cursor == null || typeof cursor !== 'object' || !(part in cursor)) {
+      return undefined;
+    }
+    cursor = cursor[part];
+  }
+  return cursor;
+}
+
+// ─── Validation ──────────────────────────────────────────────────────────────
+
+const KNOWN_COPILOT_SETTINGS_KEYS = new Set([
+  'github.copilot.chat.agent.enabled',
+  'github.copilot.chat.codeGeneration.instructions',
+  'github.copilot.chat.reviewSelection.instructions',
+  'github.copilot.chat.commitMessageGeneration.instructions',
+  'github.copilot.chat.pullRequestDescriptionGeneration.instructions',
+  'chat.instructionsFilesLocations',
+  'chat.tools.terminal.sandbox.enabled',
+  'chat.agent.autoApproval.terminalCommands',
+  'chat.agent.autoApproval.tools',
+  'github.copilot.enable',
+  'github.copilot.advanced',
+]);
+
+const DEPRECATED_COPILOT_KEYS = new Map([
+  ['github.copilot.chat.codeGeneration.instructions', 'Deprecated since VS Code 1.102. Use .github/instructions/*.instructions.md instead.'],
+]);
+
+/**
+ * Validate VS Code settings.json keys for Copilot-specific settings.
+ * @param {object} data - Parsed settings object.
+ * @returns {{ unknown: string[], deprecated: Array<{key: string, message: string}>, copilotKeys: string[] }}
+ */
+function validateCopilotSettingsKeys(data) {
+  if (!data || typeof data !== 'object') {
+    return { unknown: [], deprecated: [], copilotKeys: [] };
+  }
+
+  const copilotKeys = [];
+  const deprecated = [];
+
+  function walk(obj, prefix) {
+    for (const key of Object.keys(obj)) {
+      const fullKey = prefix ? `${prefix}.${key}` : key;
+
+      // Only track copilot-related keys
+      if (fullKey.startsWith('github.copilot') || fullKey.startsWith('chat.')) {
+        copilotKeys.push(fullKey);
+      }
+
+      if (DEPRECATED_COPILOT_KEYS.has(fullKey)) {
+        deprecated.push({ key: fullKey, message: DEPRECATED_COPILOT_KEYS.get(fullKey) });
+      }
+
+      if (obj[key] && typeof obj[key] === 'object' && !Array.isArray(obj[key])) {
+        walk(obj[key], fullKey);
+      }
+    }
+  }
+
+  walk(data, '');
+  return { unknown: [], deprecated, copilotKeys };
+}
+
+/**
+ * Validate .prompt.md frontmatter for required fields.
+ * Valid fields: description, agent, model, tools, mode.
+ */
+function validatePromptFrontmatter(frontmatter) {
+  if (!frontmatter) return { valid: false, errors: ['No frontmatter found'] };
+
+  const errors = [];
+  const VALID_PROMPT_FIELDS = new Set(['description', 'agent', 'model', 'tools', 'mode']);
+
+  for (const key of Object.keys(frontmatter)) {
+    if (!VALID_PROMPT_FIELDS.has(key)) {
+      errors.push(`Unknown prompt frontmatter field: "${key}"`);
+    }
+  }
+
+  return { valid: errors.length === 0, errors };
+}
+
+/**
+ * Validate .instructions.md frontmatter for required applyTo field.
+ */
+function validateInstructionFrontmatter(frontmatter) {
+  if (!frontmatter) return { valid: false, errors: ['No frontmatter found'] };
+
+  const errors = [];
+
+  if (!frontmatter.applyTo) {
+    errors.push('Missing required "applyTo" glob pattern in frontmatter');
+  }
+
+  return { valid: errors.length === 0, errors };
+}
+
+module.exports = {
+  tryParseJson,
+  extractFrontmatter,
+  parseSimpleYaml,
+  getValueByPath,
+  validateCopilotSettingsKeys,
+  validatePromptFrontmatter,
+  validateInstructionFrontmatter,
+};

package/src/copilot/context.js

@@ -0,0 +1,197 @@
+/**
+ * Copilot project context.
+ *
+ * Extends the shared ProjectContext with Copilot-specific file lookups,
+ * 3-surface detection (VS Code, cloud agent, CLI), instruction parsing,
+ * and per-surface config resolution.
+ */
+
+const fs = require('fs');
+const path = require('path');
+const { ProjectContext } = require('../context');
+const { tryParseJson, extractFrontmatter, getValueByPath } = require('./config-parser');
+
+function listFiles(fullPath, filter) {
+  try {
+    const entries = fs.readdirSync(fullPath).filter(f => !f.startsWith('.'));
+    return filter ? entries.filter(filter) : entries;
+  } catch {
+    return [];
+  }
+}
+
+class CopilotProjectContext extends ProjectContext {
+
+  // ─── Instructions ─────────────────────────────────────────────────────
+
+  /**
+   * .github/copilot-instructions.md — repo-wide instructions for all surfaces.
+   */
+  copilotInstructionsContent() {
+    return this.fileContent('.github/copilot-instructions.md');
+  }
+
+  /**
+   * .github/instructions/*.instructions.md — path-scoped instructions.
+   * Returns array of { name, path, frontmatter, body, applyTo }.
+   */
+  scopedInstructions() {
+    const dir = path.join(this.dir, '.github', 'instructions');
+    const files = listFiles(dir, f => f.endsWith('.instructions.md'));
+    return files.map(f => {
+      const relPath = `.github/instructions/${f}`;
+      const content = this.fileContent(relPath);
+      if (!content) return null;
+      const parsed = extractFrontmatter(content);
+      return {
+        name: f.replace('.instructions.md', ''),
+        path: relPath,
+        frontmatter: parsed.frontmatter,
+        body: parsed.body,
+        applyTo: parsed.frontmatter ? parsed.frontmatter.applyTo : null,
+      };
+    }).filter(Boolean);
+  }
+
+  /**
+   * .github/prompts/*.prompt.md — reusable prompt templates.
+   * Returns array of { name, path, frontmatter, body }.
+   */
+  promptFiles() {
+    const dir = path.join(this.dir, '.github', 'prompts');
+    const files = listFiles(dir, f => f.endsWith('.prompt.md'));
+    return files.map(f => {
+      const relPath = `.github/prompts/${f}`;
+      const content = this.fileContent(relPath);
+      if (!content) return null;
+      const parsed = extractFrontmatter(content);
+      return {
+        name: f.replace('.prompt.md', ''),
+        path: relPath,
+        frontmatter: parsed.frontmatter,
+        body: parsed.body,
+      };
+    }).filter(Boolean);
+  }
+
+  // ─── VS Code settings ─────────────────────────────────────────────────
+
+  /**
+   * .vscode/settings.json parsed — full VS Code settings (Copilot-relevant keys).
+   */
+  vscodeSettings() {
+    const content = this.fileContent('.vscode/settings.json');
+    if (!content) {
+      return { ok: false, data: null, error: 'missing .vscode/settings.json', source: '.vscode/settings.json' };
+    }
+    const parsed = tryParseJson(content);
+    return { ...parsed, source: '.vscode/settings.json' };
+  }
+
+  /**
+   * Get a specific Copilot-related setting from .vscode/settings.json.
+   */
+  copilotSetting(dottedKey) {
+    const result = this.vscodeSettings();
+    if (!result.ok) return undefined;
+    return getValueByPath(result.data, dottedKey);
+  }
+
+  // ─── Cloud agent config ───────────────────────────────────────────────
+
+  /**
+   * copilot-setup-steps.yml — cloud agent environment setup.
+   */
+  cloudAgentConfig() {
+    return this.fileContent('.github/workflows/copilot-setup-steps.yml') ||
+           this.fileContent('copilot-setup-steps.yml');
+  }
+
+  // ─── MCP config ───────────────────────────────────────────────────────
+
+  /**
+   * .vscode/mcp.json — VS Code MCP server configuration.
+   * Note: Copilot MCP uses .vscode/mcp.json (separate from settings.json mcpServers).
+   */
+  mcpConfig() {
+    const content = this.fileContent('.vscode/mcp.json');
+    if (!content) {
+      return { ok: false, data: null, error: 'missing .vscode/mcp.json', source: '.vscode/mcp.json' };
+    }
+    const parsed = tryParseJson(content);
+    return { ...parsed, source: '.vscode/mcp.json' };
+  }
+
+  /**
+   * MCP servers from .vscode/mcp.json.
+   */
+  mcpServers() {
+    const result = this.mcpConfig();
+    if (!result.ok || !result.data) return {};
+    return result.data.servers || result.data.mcpServers || {};
+  }
+
+  // ─── Content exclusions ───────────────────────────────────────────────
+
+  /**
+   * Content exclusion patterns from .vscode/settings.json or org-level markers.
+   * Returns array of glob patterns, or null if not configured.
+   */
+  contentExclusions() {
+    const settings = this.vscodeSettings();
+    if (!settings.ok) return null;
+
+    // Check multiple possible config keys for content exclusions
+    const exclusions = getValueByPath(settings.data, 'github.copilot.advanced.contentExclusion') ||
+                       getValueByPath(settings.data, 'github.copilot.contentExclusion') ||
+                       null;
+
+    return exclusions;
+  }
+
+  // ─── Workflow files ───────────────────────────────────────────────────
+
+  workflowFiles() {
+    const dir = path.join(this.dir, '.github', 'workflows');
+    return listFiles(dir, f => f.endsWith('.yml') || f.endsWith('.yaml'))
+      .map(f => `.github/workflows/${f}`);
+  }
+
+  // ─── Surface detection ────────────────────────────────────────────────
+
+  /**
+   * Detect which Copilot surfaces are configured.
+   */
+  detectSurfaces() {
+    const vscode = Boolean(
+      this.fileContent('.vscode/settings.json') ||
+      this.fileContent('.vscode/mcp.json')
+    );
+    const cloudAgent = Boolean(this.cloudAgentConfig());
+    const cli = false; // CLI detection is local-only; can't detect from repo files
+
+    return { vscode, cloudAgent, cli };
+  }
+
+  // ─── Static detection ─────────────────────────────────────────────────
+
+  static isCopilotRepo(dir) {
+    try {
+      return fs.existsSync(path.join(dir, '.github', 'copilot-instructions.md')) ||
+        fs.existsSync(path.join(dir, '.vscode', 'mcp.json')) ||
+        fs.existsSync(path.join(dir, '.github', 'instructions'));
+    } catch {
+      return false;
+    }
+  }
+
+  // ─── Stack detection (reuse shared) ───────────────────────────────────
+
+  detectStacks(STACKS) {
+    return super.detectStacks(STACKS);
+  }
+}
+
+module.exports = {
+  CopilotProjectContext,
+};