sigmap 2.9.1 → 3.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sigmap",
-  "version": "2.9.1",
+  "version": "3.0.0",
   "description": "Zero-dependency AI context engine — 97% token reduction. No npm install. Runs on Node 18+.",
   "main": "gen-context.js",
   "exports": {

package/packages/adapters/claude.js

@@ -0,0 +1,71 @@
+'use strict';
+
+/**
+ * Claude adapter — appends to CLAUDE.md under a marker line.
+ * Never overwrites human-written content above the marker.
+ *
+ * Contract:
+ *   format(context, opts?) → string
+ *   outputPath(cwd) → string
+ *   write(context, cwd, opts?) → void   (handles append logic)
+ */
+
+const path = require('path');
+const fs = require('fs');
+
+const name = 'claude';
+
+const MARKER = '\n\n## Auto-generated signatures\n<!-- Updated by gen-context.js -->\n';
+
+/**
+ * Format context suited for CLAUDE.md.
+ * @param {string} context - Raw signature context string
+ * @param {object} [opts]
+ * @param {string} [opts.version] - SigMap version string
+ * @returns {string}
+ */
+function format(context, opts = {}) {
+  if (!context || typeof context !== 'string') return '';
+  const version = opts.version || 'unknown';
+  const timestamp = new Date().toISOString();
+  return [
+    `<!-- Generated by SigMap v${version} — ${timestamp} -->`,
+    '',
+    context,
+  ].join('\n');
+}
+
+/**
+ * Return the output file path for this adapter.
+ * @param {string} cwd - Project root
+ * @returns {string}
+ */
+function outputPath(cwd) {
+  return path.join(cwd, 'CLAUDE.md');
+}
+
+/**
+ * Write signatures into CLAUDE.md using the append-under-marker strategy.
+ * Human content above the marker is never touched.
+ * @param {string} context - Raw signature context string
+ * @param {string} cwd - Project root
+ * @param {object} [opts]
+ */
+function write(context, cwd, opts = {}) {
+  const filePath = outputPath(cwd);
+  let existing = '';
+  if (fs.existsSync(filePath)) {
+    existing = fs.readFileSync(filePath, 'utf8');
+  }
+  const formatted = format(context, opts);
+  const markerIdx = existing.indexOf('## Auto-generated signatures');
+  let newContent;
+  if (markerIdx !== -1) {
+    newContent = existing.slice(0, markerIdx) + MARKER.trimStart() + formatted;
+  } else {
+    newContent = existing + MARKER + formatted;
+  }
+  fs.writeFileSync(filePath, newContent, 'utf8');
+}
+
+module.exports = { name, format, outputPath, write };

package/packages/adapters/copilot.js

@@ -0,0 +1,47 @@
+'use strict';
+
+/**
+ * Copilot adapter — writes to .github/copilot-instructions.md
+ * GitHub Copilot reads this file automatically in every workspace.
+ *
+ * Contract:
+ *   format(context, opts?) → string
+ *   outputPath(cwd) → string
+ */
+
+const path = require('path');
+
+const name = 'copilot';
+
+/**
+ * Format context for GitHub Copilot instructions.
+ * @param {string} context - Raw signature context string
+ * @param {object} [opts]
+ * @param {string} [opts.version] - SigMap version string
+ * @returns {string}
+ */
+function format(context, opts = {}) {
+  if (!context || typeof context !== 'string') return '';
+  const version = opts.version || 'unknown';
+  const timestamp = new Date().toISOString();
+  const header = [
+    `<!-- Generated by SigMap gen-context.js v${version} -->`,
+    `<!-- Updated: ${timestamp} -->`,
+    `<!-- Do not edit below — regenerate with: node gen-context.js -->`,
+    '',
+    '# Code signatures',
+    '',
+  ].join('\n');
+  return header + context;
+}
+
+/**
+ * Return the output file path for this adapter.
+ * @param {string} cwd - Project root
+ * @returns {string}
+ */
+function outputPath(cwd) {
+  return path.join(cwd, '.github', 'copilot-instructions.md');
+}
+
+module.exports = { name, format, outputPath };

package/packages/adapters/cursor.js

@@ -0,0 +1,45 @@
+'use strict';
+
+/**
+ * Cursor adapter — writes to .cursorrules
+ * Cursor reads .cursorrules automatically in every workspace.
+ *
+ * Contract:
+ *   format(context, opts?) → string
+ *   outputPath(cwd) → string
+ */
+
+const path = require('path');
+
+const name = 'cursor';
+
+/**
+ * Format context for Cursor rules file.
+ * @param {string} context - Raw signature context string
+ * @param {object} [opts]
+ * @param {string} [opts.version] - SigMap version string
+ * @returns {string}
+ */
+function format(context, opts = {}) {
+  if (!context || typeof context !== 'string') return '';
+  const version = opts.version || 'unknown';
+  const timestamp = new Date().toISOString();
+  const header = [
+    `# Code signatures — generated by SigMap v${version}`,
+    `# Updated: ${timestamp}`,
+    `# Regenerate: node gen-context.js`,
+    '',
+  ].join('\n');
+  return header + context;
+}
+
+/**
+ * Return the output file path for this adapter.
+ * @param {string} cwd - Project root
+ * @returns {string}
+ */
+function outputPath(cwd) {
+  return path.join(cwd, '.cursorrules');
+}
+
+module.exports = { name, format, outputPath };

package/packages/adapters/gemini.js

@@ -0,0 +1,59 @@
+'use strict';
+
+/**
+ * Gemini adapter — formats context as a Gemini system instruction.
+ * Use the output as the `system_instruction` field in a Gemini API request.
+ *
+ * Example usage:
+ *   const { format } = require('sigmap/adapters/gemini');
+ *   const instruction = format(context);
+ *   // Pass to: genAI.getGenerativeModel({ model: 'gemini-pro', systemInstruction: instruction })
+ *
+ * Contract:
+ *   format(context, opts?) → string
+ *   outputPath(cwd) → string
+ */
+
+const path = require('path');
+
+const name = 'gemini';
+
+/**
+ * Format context as a Gemini system instruction.
+ * @param {string} context - Raw signature context string
+ * @param {object} [opts]
+ * @param {string} [opts.version] - SigMap version string
+ * @param {string} [opts.projectName] - Optional project name
+ * @returns {string}
+ */
+function format(context, opts = {}) {
+  if (!context || typeof context !== 'string') return '';
+  const version = opts.version || 'unknown';
+  const timestamp = new Date().toISOString();
+  const projectLine = opts.projectName
+    ? `Project: ${opts.projectName}\n`
+    : '';
+
+  return [
+    `You are a coding assistant with complete knowledge of this codebase.`,
+    `The following code signatures were extracted by SigMap v${version} on ${timestamp}.`,
+    projectLine,
+    `These signatures represent every public function, class, and type in the project.`,
+    `Refer to them when answering questions about code structure, APIs, and implementation.`,
+    ``,
+    `## Code Signatures`,
+    ``,
+    context,
+  ].join('\n');
+}
+
+/**
+ * Return the output file path for this adapter.
+ * @param {string} cwd - Project root
+ * @returns {string}
+ */
+function outputPath(cwd) {
+  return path.join(cwd, '.github', 'gemini-context.md');
+}
+
+module.exports = { name, format, outputPath };

package/packages/adapters/index.js

@@ -0,0 +1,79 @@
+'use strict';
+
+/**
+ * packages/adapters/index.js
+ * Central registry for all SigMap output adapters.
+ *
+ * Usage:
+ *   const { getAdapter, listAdapters, adapt } = require('sigmap/adapters');
+ *   const output = adapt(context, 'copilot', { version: '3.0.0' });
+ */
+
+const path = require('path');
+
+const ADAPTER_NAMES = ['copilot', 'claude', 'cursor', 'windsurf', 'openai', 'gemini'];
+
+// Lazy-load adapters so unused ones don't pay any require() cost
+const _cache = {};
+
+/**
+ * Load and return an adapter module by name.
+ * @param {string} name - Adapter name (copilot|claude|cursor|windsurf|openai|gemini)
+ * @returns {{ name: string, format: Function, outputPath: Function }|null}
+ */
+function getAdapter(name) {
+  if (!name || typeof name !== 'string') return null;
+  const key = name.toLowerCase();
+  if (!ADAPTER_NAMES.includes(key)) return null;
+  if (!_cache[key]) {
+    try {
+      _cache[key] = require(path.join(__dirname, key + '.js'));
+    } catch (_) {
+      return null;
+    }
+  }
+  return _cache[key];
+}
+
+/**
+ * List all available adapter names.
+ * @returns {string[]}
+ */
+function listAdapters() {
+  return ADAPTER_NAMES.slice();
+}
+
+/**
+ * Format context using the named adapter.
+ * @param {string} context - Raw signature context string
+ * @param {string} adapterName - Adapter name
+ * @param {object} [opts] - Options passed to adapter.format()
+ * @returns {string} Formatted output string (empty string if adapter not found or context empty)
+ */
+function adapt(context, adapterName, opts = {}) {
+  if (!context || typeof context !== 'string') return '';
+  const adapter = getAdapter(adapterName);
+  if (!adapter || typeof adapter.format !== 'function') return '';
+  try {
+    return adapter.format(context, opts);
+  } catch (_) {
+    return '';
+  }
+}
+
+/**
+ * Map old `outputs` config values to new `adapters` names.
+ * Provides backward compatibility for existing configurations.
+ * @param {string[]} outputs - Legacy outputs array
+ * @returns {string[]} Equivalent adapters array
+ */
+function outputsToAdapters(outputs) {
+  if (!Array.isArray(outputs)) return ['copilot'];
+  return outputs.map((o) => {
+    // All current output names already match adapter names
+    if (ADAPTER_NAMES.includes(o)) return o;
+    return o; // pass through unknowns — getAdapter() will handle gracefully
+  });
+}
+
+module.exports = { getAdapter, listAdapters, adapt, outputsToAdapters };

package/packages/adapters/openai.js

@@ -0,0 +1,60 @@
+'use strict';
+
+/**
+ * OpenAI adapter — formats context as an OpenAI system message.
+ * Use the output as the `content` field of a system role message.
+ *
+ * Example usage in code:
+ *   const { format } = require('sigmap/adapters/openai');
+ *   const systemPrompt = format(context);
+ *   // Pass to: openai.chat.completions.create({ messages: [{ role: 'system', content: systemPrompt }] })
+ *
+ * Contract:
+ *   format(context, opts?) → string
+ *   outputPath(cwd) → string
+ */
+
+const path = require('path');
+
+const name = 'openai';
+
+/**
+ * Format context as an OpenAI system prompt.
+ * @param {string} context - Raw signature context string
+ * @param {object} [opts]
+ * @param {string} [opts.version] - SigMap version string
+ * @param {string} [opts.projectName] - Optional project name
+ * @returns {string}
+ */
+function format(context, opts = {}) {
+  if (!context || typeof context !== 'string') return '';
+  const version = opts.version || 'unknown';
+  const timestamp = new Date().toISOString();
+  const projectLine = opts.projectName
+    ? `Project: ${opts.projectName}\n`
+    : '';
+
+  return [
+    `You are a coding assistant with full knowledge of this codebase.`,
+    `Below are the code signatures extracted by SigMap v${version} on ${timestamp}.`,
+    projectLine,
+    `Use these signatures to answer questions about the code accurately.`,
+    `When the user asks about a specific file or function, refer to the signatures below.`,
+    ``,
+    `## Code Signatures`,
+    ``,
+    context,
+  ].join('\n');
+}
+
+/**
+ * Return the output file path for this adapter.
+ * Writes a .openai-context.md file that can be loaded at runtime.
+ * @param {string} cwd - Project root
+ * @returns {string}
+ */
+function outputPath(cwd) {
+  return path.join(cwd, '.github', 'openai-context.md');
+}
+
+module.exports = { name, format, outputPath };

package/packages/adapters/windsurf.js

@@ -0,0 +1,45 @@
+'use strict';
+
+/**
+ * Windsurf adapter — writes to .windsurfrules
+ * Windsurf reads .windsurfrules automatically in every workspace.
+ *
+ * Contract:
+ *   format(context, opts?) → string
+ *   outputPath(cwd) → string
+ */
+
+const path = require('path');
+
+const name = 'windsurf';
+
+/**
+ * Format context for Windsurf rules file.
+ * @param {string} context - Raw signature context string
+ * @param {object} [opts]
+ * @param {string} [opts.version] - SigMap version string
+ * @returns {string}
+ */
+function format(context, opts = {}) {
+  if (!context || typeof context !== 'string') return '';
+  const version = opts.version || 'unknown';
+  const timestamp = new Date().toISOString();
+  const header = [
+    `# Code signatures — generated by SigMap v${version}`,
+    `# Updated: ${timestamp}`,
+    `# Regenerate: node gen-context.js`,
+    '',
+  ].join('\n');
+  return header + context;
+}
+
+/**
+ * Return the output file path for this adapter.
+ * @param {string} cwd - Project root
+ * @returns {string}
+ */
+function outputPath(cwd) {
+  return path.join(cwd, '.windsurfrules');
+}
+
+module.exports = { name, format, outputPath };

package/packages/cli/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sigmap-cli",
-  "version": "2.9.1",
+  "version": "3.0.0",
   "description": "SigMap CLI wrapper — thin adapter for programmatic CLI invocation",
   "main": "index.js",
   "keywords": [

package/packages/core/README.md

@@ -1,6 +1,6 @@
 # sigmap-core
 
-Programmatic API for [SigMap](https://manojmallick.github.io/sigmap/) — zero-dependency code signature extraction, ranked retrieval, secret scanning, and project health scoring.
+Programmatic API for [SigMap](https://manojmallick.github.io/sigmap/) — zero-dependency code signature extraction, ranked retrieval, secret scanning, project health scoring, and multi-adapter output formatting (v3.0+).
 
 ## Installation
 
@@ -13,7 +13,7 @@ npm install sigmap        # installs the full package (CLI + core)
 ## Quick start
 
 ```js
-const { extract, rank, buildSigIndex, scan, score } = require('sigmap');
+const { extract, rank, buildSigIndex, scan, score, adapt } = require('sigmap');
 
 // 1. Extract signatures from any source file
 const sigs = extract('function hello() { return "world"; }', 'javascript');
@@ -128,9 +128,21 @@ const health = score('/path/to/project');
 
 All existing CLI flags (`--generate`, `--watch`, `--mcp`, `--query`, `--analyze`, `--benchmark`, `--health`, …) are unchanged.
 
-## What's next — v2.9
+## v3.0 — Multi-Adapter Architecture (released)
 
-v2.9 adds JetBrains plugin support — install SigMap natively in IntelliJ IDEA, WebStorm, PyCharm, GoLand, RubyMine. Includes toolbar actions, settings panel, file watcher integration, and automated JetBrains Marketplace publishing. See [issue #23](https://github.com/manojmallick/sigmap/issues/23).
+v3.0 adds the `adapt()` function to `packages/core`, making the API **semver-stable**. Breaking changes now require v4.0.
+
+```js
+const { adapt } = require('sigmap');
+
+// Format context as an OpenAI system prompt
+const systemPrompt = adapt(context, 'openai', { version: '3.0.0' });
+
+// Format context as a Gemini system instruction
+const geminiInstruction = adapt(context, 'gemini');
+
+// All 6 adapters: copilot | claude | cursor | windsurf | openai | gemini
+```
 
 See the full [roadmap](https://manojmallick.github.io/sigmap/roadmap.html).
 

package/packages/core/index.js

@@ -198,6 +198,33 @@ function score(cwd) {
   }
 }
 
+// ---------------------------------------------------------------------------
+// adapt(context, adapterName, opts?) → string   (v3.0+)
+// ---------------------------------------------------------------------------
+/**
+ * Format a context string using the named output adapter.
+ *
+ * @param {string} context     - Raw signature context string
+ * @param {string} adapterName - One of: 'copilot'|'claude'|'cursor'|'windsurf'|'openai'|'gemini'
+ * @param {object} [opts]      - Passed through to adapter.format()
+ * @returns {string} Formatted output string (empty string if adapter not found)
+ *
+ * @example
+ *   const { adapt } = require('sigmap');
+ *   const systemPrompt = adapt(context, 'openai', { version: '3.0.0' });
+ *
+ *   const copilotMd = adapt(context, 'copilot');
+ */
+function adapt(context, adapterName, opts = {}) {
+  try {
+    const adaptersPath = path.resolve(__dirname, '..', 'adapters', 'index.js');
+    const { adapt: _adapt } = require(adaptersPath);
+    return _adapt(context, adapterName, opts);
+  } catch (_) {
+    return '';
+  }
+}
+
 // ---------------------------------------------------------------------------
 // Exports
 // ---------------------------------------------------------------------------
@@ -212,4 +239,6 @@ module.exports = {
   scan,
   /** Compute project health score */
   score,
+  /** Format context using a named output adapter (v3.0+) */
+  adapt,
 };

package/packages/core/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sigmap-core",
-  "version": "2.9.1",
+  "version": "3.0.0",
   "description": "SigMap core library — zero-dependency code signature extraction, retrieval, and security scanning",
   "main": "index.js",
   "keywords": [

package/src/config/defaults.js

@@ -11,6 +11,10 @@ const DEFAULTS = {
   // Output targets: 'copilot' | 'claude' | 'cursor' | 'windsurf'
   outputs: ['copilot'],
 
+  // Adapter targets (v3.0+): replaces 'outputs'. Same names, adds 'openai' | 'gemini'.
+  // Old 'outputs' config key is still accepted and silently maps to 'adapters'.
+  adapters: null,
+
   // Directories to scan (relative to project root)
   srcDirs: [
     'src', 'app', 'lib', 'packages', 'services', 'api',

package/src/config/loader.js

@@ -50,6 +50,13 @@ function loadConfig(cwd) {
       merged[key] = val;
     }
   }
+  // Backward compat (v3.0+): mirror outputs ↔ adapters
+  if (merged.adapters && !Array.isArray(merged.adapters)) merged.adapters = null;
+  if (!merged.adapters && Array.isArray(merged.outputs)) {
+    merged.adapters = merged.outputs.slice();
+  } else if (Array.isArray(merged.adapters) && !userConfig.outputs) {
+    merged.outputs = merged.adapters.filter((a) => ['copilot','claude','cursor','windsurf'].includes(a));
+  }
   return merged;
 }