bitcompass 0.2.6 → 0.2.8

package/dist/auth/project-config.d.ts

@@ -0,0 +1,16 @@
+import type { EditorProvider, ProjectConfig } from '../types.js';
+declare const EDITOR_DEFAULT_PATHS: Record<EditorProvider, string>;
+declare const DEFAULT_EDITOR: EditorProvider;
+declare const DEFAULT_OUTPUT_PATH: string;
+export declare const getProjectConfigDir: () => string;
+export declare const getEditorDefaultPath: (editor: EditorProvider) => string;
+export declare const loadProjectConfig: () => ProjectConfig | null;
+export declare const saveProjectConfig: (config: ProjectConfig) => void;
+/**
+ * Returns project config, or defaults if not configured.
+ * When warnIfMissing is true and no config exists, prints a small warning once to stderr and proceeds with defaults.
+ */
+export declare const getProjectConfig: (options?: {
+    warnIfMissing?: boolean;
+}) => ProjectConfig;
+export { EDITOR_DEFAULT_PATHS, DEFAULT_EDITOR, DEFAULT_OUTPUT_PATH };

package/dist/auth/project-config.js

@@ -0,0 +1,63 @@
+import { existsSync, mkdirSync, readFileSync, writeFileSync } from 'fs';
+import { join } from 'path';
+const PROJECT_CONFIG_DIR = '.bitcompass';
+const PROJECT_CONFIG_FILE = 'config.json';
+const EDITOR_DEFAULT_PATHS = {
+    vscode: '.vscode/rules',
+    cursor: '.cursor/rules',
+    antigrativity: '.antigrativity/rules',
+    claudecode: '.claude/rules',
+};
+const DEFAULT_EDITOR = 'cursor';
+const DEFAULT_OUTPUT_PATH = EDITOR_DEFAULT_PATHS[DEFAULT_EDITOR];
+const getProjectConfigPath = () => {
+    const cwd = process.cwd();
+    return join(cwd, PROJECT_CONFIG_DIR, PROJECT_CONFIG_FILE);
+};
+export const getProjectConfigDir = () => join(process.cwd(), PROJECT_CONFIG_DIR);
+export const getEditorDefaultPath = (editor) => EDITOR_DEFAULT_PATHS[editor];
+export const loadProjectConfig = () => {
+    const path = getProjectConfigPath();
+    if (!existsSync(path))
+        return null;
+    try {
+        const raw = readFileSync(path, 'utf-8');
+        const data = JSON.parse(raw);
+        const editor = data.editor;
+        const outputPath = typeof data.outputPath === 'string' ? data.outputPath : undefined;
+        if (editor && Object.keys(EDITOR_DEFAULT_PATHS).includes(editor) && outputPath) {
+            return { editor, outputPath };
+        }
+        return null;
+    }
+    catch {
+        return null;
+    }
+};
+const ensureProjectConfigDir = () => {
+    const dir = join(process.cwd(), PROJECT_CONFIG_DIR);
+    if (!existsSync(dir)) {
+        mkdirSync(dir, { mode: 0o755, recursive: true });
+    }
+};
+export const saveProjectConfig = (config) => {
+    ensureProjectConfigDir();
+    const path = getProjectConfigPath();
+    writeFileSync(path, JSON.stringify(config, null, 2), { mode: 0o644 });
+};
+let warnedMissing = false;
+/**
+ * Returns project config, or defaults if not configured.
+ * When warnIfMissing is true and no config exists, prints a small warning once to stderr and proceeds with defaults.
+ */
+export const getProjectConfig = (options) => {
+    const config = loadProjectConfig();
+    if (config)
+        return config;
+    if (options?.warnIfMissing && !warnedMissing) {
+        warnedMissing = true;
+        process.stderr.write('[bitcompass] No project config found (.bitcompass/config.json). Using defaults. Run "bitcompass init" to configure.\n');
+    }
+    return { editor: DEFAULT_EDITOR, outputPath: DEFAULT_OUTPUT_PATH };
+};
+export { EDITOR_DEFAULT_PATHS, DEFAULT_EDITOR, DEFAULT_OUTPUT_PATH };

package/dist/commands/init.d.ts

@@ -0,0 +1 @@
+export declare const runInit: () => Promise<void>;

package/dist/commands/init.js

@@ -0,0 +1,56 @@
+import inquirer from 'inquirer';
+import chalk from 'chalk';
+import { existsSync, readFileSync, writeFileSync } from 'fs';
+import { join } from 'path';
+import { getEditorDefaultPath, loadProjectConfig, saveProjectConfig, getProjectConfigDir, } from '../auth/project-config.js';
+const EDITOR_CHOICES = [
+    { name: 'VSCode', value: 'vscode' },
+    { name: 'Cursor', value: 'cursor' },
+    { name: 'Antigrativity', value: 'antigrativity' },
+    { name: 'Claude Code', value: 'claudecode' },
+];
+const GITIGNORE_ENTRY = '.bitcompass';
+const ensureGitignoreEntry = () => {
+    const gitignorePath = join(process.cwd(), '.gitignore');
+    if (!existsSync(gitignorePath)) {
+        writeFileSync(gitignorePath, `${GITIGNORE_ENTRY}\n`, 'utf-8');
+        return;
+    }
+    const content = readFileSync(gitignorePath, 'utf-8');
+    const lines = content.split(/\r?\n/);
+    const hasEntry = lines.some((line) => line.trim() === GITIGNORE_ENTRY);
+    if (hasEntry)
+        return;
+    const trimmed = content.trimEnd();
+    const suffix = trimmed ? '\n' : '';
+    writeFileSync(gitignorePath, `${trimmed}${suffix}\n${GITIGNORE_ENTRY}\n`, 'utf-8');
+};
+export const runInit = async () => {
+    const existing = loadProjectConfig();
+    const answers = await inquirer.prompt([
+        {
+            name: 'editor',
+            message: 'Editor / AI provider',
+            type: 'list',
+            choices: EDITOR_CHOICES,
+            default: existing?.editor ?? 'cursor',
+        },
+        {
+            name: 'outputPath',
+            message: 'Folder for rules/docs/commands output',
+            type: 'input',
+            default: ({ editor }) => getEditorDefaultPath(editor),
+        },
+    ]);
+    const config = {
+        editor: answers.editor,
+        outputPath: answers.outputPath.trim() || getEditorDefaultPath(answers.editor),
+    };
+    saveProjectConfig(config);
+    ensureGitignoreEntry();
+    console.log(chalk.green('Project configured.'));
+    console.log(chalk.dim('Config:'), join(getProjectConfigDir(), 'config.json'));
+    console.log(chalk.dim('Editor:'), config.editor);
+    console.log(chalk.dim('Output path:'), config.outputPath);
+    console.log(chalk.dim('.gitignore:'), GITIGNORE_ENTRY, 'added or already present.');
+};

package/dist/commands/rules.js

@@ -1,9 +1,12 @@
 import inquirer from 'inquirer';
 import ora from 'ora';
 import chalk from 'chalk';
-import { writeFileSync } from 'fs';
+import { mkdirSync, writeFileSync } from 'fs';
+import { join } from 'path';
 import { loadCredentials } from '../auth/config.js';
+import { getProjectConfig } from '../auth/project-config.js';
 import { searchRules, fetchRules, getRuleById, insertRule } from '../api/client.js';
+import { ruleFilename } from '../lib/slug.js';
 export const runRulesSearch = async (query) => {
     if (!loadCredentials()) {
         console.error(chalk.red('Not logged in. Run bitcompass login.'));
@@ -67,7 +70,10 @@ export const runRulesPull = async (id) => {
         console.error(chalk.red('Rule not found.'));
         process.exit(1);
     }
-    const filename = `rule-${rule.id}.md`;
+    const { outputPath } = getProjectConfig({ warnIfMissing: true });
+    const outDir = join(process.cwd(), outputPath);
+    mkdirSync(outDir, { recursive: true });
+    const filename = join(outDir, ruleFilename(rule.title, rule.id));
     const content = `# ${rule.title}\n\n${rule.description}\n\n${rule.body}\n`;
     writeFileSync(filename, content);
     console.log(chalk.green('Wrote'), filename);

package/dist/commands/solutions.js

@@ -1,9 +1,12 @@
 import inquirer from 'inquirer';
 import ora from 'ora';
 import chalk from 'chalk';
-import { writeFileSync } from 'fs';
+import { mkdirSync, writeFileSync } from 'fs';
+import { join } from 'path';
 import { loadCredentials } from '../auth/config.js';
+import { getProjectConfig } from '../auth/project-config.js';
 import { searchRules, fetchRules, getRuleById, insertRule } from '../api/client.js';
+import { solutionFilename } from '../lib/slug.js';
 export const runSolutionsSearch = async (query) => {
     if (!loadCredentials()) {
         console.error(chalk.red('Not logged in. Run bitcompass login.'));
@@ -55,7 +58,10 @@ export const runSolutionsPull = async (id) => {
         console.error(chalk.red('Solution not found.'));
         process.exit(1);
     }
-    const filename = `solution-${rule.id}.md`;
+    const { outputPath } = getProjectConfig({ warnIfMissing: true });
+    const outDir = join(process.cwd(), outputPath);
+    mkdirSync(outDir, { recursive: true });
+    const filename = join(outDir, solutionFilename(rule.title, rule.id));
     const content = `# ${rule.title}\n\n${rule.description}\n\n## Solution\n\n${rule.body}\n`;
     writeFileSync(filename, content);
     console.log(chalk.green('Wrote'), filename);

package/dist/index.js

@@ -3,6 +3,7 @@ import 'dotenv/config';
 import chalk from 'chalk';
 import { Command } from 'commander';
 import { runConfigGet, runConfigList, runConfigSet } from './commands/config-cmd.js';
+import { runInit } from './commands/init.js';
 import { runLogin } from './commands/login.js';
 import { runLogout } from './commands/logout.js';
 import { runMcpStart, runMcpStatus } from './commands/mcp.js';
@@ -27,6 +28,10 @@ program
     .command('whoami')
     .description('Show current user (email)')
     .action(runWhoami);
+program
+    .command('init')
+    .description('Configure project: editor/AI provider and output folder for rules/docs/commands')
+    .action(() => runInit().catch(handleErr));
 program
     .command('log [dates...]')
     .description('Collect repo summary and git activity, then push to your activity logs. Optional: bitcompass log YYYY-MM-DD or bitcompass log YYYY-MM-DD YYYY-MM-DD')

package/dist/lib/slug.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Converts a rule/solution title to a standardized filename slug.
+ * e.g. "# Strava API Authentication Flow" -> "strava-api-authentication-flow"
+ */
+export declare const titleToSlug: (title: string) => string;
+/**
+ * Returns the rule filename (e.g. rule-strava-api-authentication-flow.md).
+ * Falls back to id if slug is empty.
+ */
+export declare const ruleFilename: (title: string, id: string) => string;
+/**
+ * Returns the solution filename (e.g. solution-strava-api-authentication-flow.md).
+ * Falls back to id if slug is empty.
+ */
+export declare const solutionFilename: (title: string, id: string) => string;

package/dist/lib/slug.js

@@ -0,0 +1,33 @@
+/**
+ * Converts a rule/solution title to a standardized filename slug.
+ * e.g. "# Strava API Authentication Flow" -> "strava-api-authentication-flow"
+ */
+export const titleToSlug = (title) => {
+    const trimmed = (title ?? '').trim().replace(/^#\s*/, '');
+    if (!trimmed)
+        return '';
+    return trimmed
+        .toLowerCase()
+        .replace(/\s+/g, '-')
+        .replace(/[^a-z0-9-]/g, '')
+        .replace(/-+/g, '-')
+        .replace(/^-|-$/g, '');
+};
+/**
+ * Returns the rule filename (e.g. rule-strava-api-authentication-flow.md).
+ * Falls back to id if slug is empty.
+ */
+export const ruleFilename = (title, id) => {
+    const slug = titleToSlug(title);
+    const base = slug ? `rule-${slug}` : `rule-${id}`;
+    return `${base}.md`;
+};
+/**
+ * Returns the solution filename (e.g. solution-strava-api-authentication-flow.md).
+ * Falls back to id if slug is empty.
+ */
+export const solutionFilename = (title, id) => {
+    const slug = titleToSlug(title);
+    const base = slug ? `solution-${slug}` : `solution-${id}`;
+    return `${base}.md`;
+};

package/dist/mcp/server.js

@@ -1,6 +1,7 @@
 import { AUTH_REQUIRED_MSG, insertRule, searchRules } from '../api/client.js';
 import { buildAndPushActivityLog } from '../commands/log.js';
 import { loadCredentials } from '../auth/config.js';
+import { getProjectConfig } from '../auth/project-config.js';
 /** When token is missing, we fail initialize so Cursor shows "Needs authentication" (yellow) instead of success (green). */
 const NEEDS_AUTH_ERROR_MESSAGE = 'Needs authentication';
 const NEEDS_AUTH_ERROR_CODE = -32001; // Server error: auth required
@@ -276,6 +277,7 @@ function createStdioServer() {
     };
 }
 export const startMcpServer = async () => {
+    getProjectConfig({ warnIfMissing: true });
     const server = createStdioServer();
     await server.connect();
     // Do not exit when not logged in: Cursor needs the process alive to complete

package/dist/types.d.ts

@@ -30,6 +30,12 @@ export interface StoredCredentials {
         email?: string;
     };
 }
+export type EditorProvider = 'vscode' | 'cursor' | 'antigrativity' | 'claudecode';
+export interface ProjectConfig {
+    editor: EditorProvider;
+    /** Folder for rules/docs/commands output (e.g. .cursor/rules/) */
+    outputPath: string;
+}
 export interface BitcompassConfig {
     apiUrl?: string;
     supabaseUrl?: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bitcompass",
-  "version": "0.2.6",
+  "version": "0.2.8",
   "description": "BitCompass CLI - rules, solutions, and MCP server",
   "type": "module",
   "bin": {