bitcompass 0.3.7 → 0.3.8

package/dist/commands/rules.js

@@ -4,6 +4,7 @@ import chalk from 'chalk';
 import { loadCredentials } from '../auth/config.js';
 import { searchRules, fetchRules, getRuleById, insertRule } from '../api/client.js';
 import { pullRuleToFile } from '../lib/rule-file-ops.js';
+import { parseRuleMdcContent } from '../lib/mdc-format.js';
 import { formatList, shouldUseTable } from '../lib/list-format.js';
 export const runRulesSearch = async (query, options) => {
     if (!loadCredentials()) {
@@ -108,9 +109,23 @@ export const runRulesPush = async (file) => {
             payload = JSON.parse(raw);
         }
         catch {
-            const lines = raw.split('\n');
-            const title = lines[0].replace(/^#\s*/, '') || 'Untitled';
-            payload = { kind: 'rule', title, description: '', body: raw };
+            const parsed = parseRuleMdcContent(raw);
+            if (parsed) {
+                const titleFromBody = parsed.body.split('\n')[0]?.replace(/^#\s*/, '').trim() || 'Untitled';
+                payload = {
+                    kind: 'rule',
+                    title: titleFromBody,
+                    description: parsed.description,
+                    body: parsed.body,
+                    globs: parsed.globs ?? undefined,
+                    always_apply: parsed.alwaysApply,
+                };
+            }
+            else {
+                const lines = raw.split('\n');
+                const title = lines[0].replace(/^#\s*/, '') || 'Untitled';
+                payload = { kind: 'rule', title, description: '', body: raw };
+            }
         }
     }
     else {

package/dist/lib/mdc-format.d.ts

@@ -0,0 +1,16 @@
+import type { Rule } from '../types.js';
+/**
+ * Builds Cursor .mdc content for a rule: YAML frontmatter (description, globs, alwaysApply) then body.
+ */
+export declare const buildRuleMdcContent: (rule: Rule) => string;
+export interface ParsedMdcFrontmatter {
+    description: string;
+    globs?: string;
+    alwaysApply: boolean;
+    body: string;
+}
+/**
+ * Parses .mdc content: frontmatter (description, globs, alwaysApply) and body.
+ * Returns null if the file does not start with --- (not frontmatter format).
+ */
+export declare const parseRuleMdcContent: (raw: string) => ParsedMdcFrontmatter | null;

package/dist/lib/mdc-format.js

@@ -0,0 +1,66 @@
+const FRONTMATTER_DELIM = '---';
+/**
+ * Builds Cursor .mdc content for a rule: YAML frontmatter (description, globs, alwaysApply) then body.
+ */
+export const buildRuleMdcContent = (rule) => {
+    const lines = [FRONTMATTER_DELIM];
+    lines.push(`description: ${escapeYamlValue(rule.description ?? '')}`);
+    if (rule.globs != null && String(rule.globs).trim() !== '') {
+        lines.push(`globs: ${escapeYamlValue(String(rule.globs).trim())}`);
+    }
+    lines.push(`alwaysApply: ${rule.always_apply === true}`);
+    lines.push(FRONTMATTER_DELIM);
+    lines.push('');
+    lines.push(rule.body.trimEnd());
+    if (!rule.body.endsWith('\n')) {
+        lines.push('');
+    }
+    return lines.join('\n');
+};
+const escapeYamlValue = (s) => {
+    if (/^[a-z0-9-]+$/i.test(s) && !s.includes(':'))
+        return s;
+    return `"${s.replace(/\\/g, '\\\\').replace(/"/g, '\\"').replace(/\n/g, '\\n')}"`;
+};
+/**
+ * Parses .mdc content: frontmatter (description, globs, alwaysApply) and body.
+ * Returns null if the file does not start with --- (not frontmatter format).
+ */
+export const parseRuleMdcContent = (raw) => {
+    const trimmed = raw.trimStart();
+    if (!trimmed.startsWith(FRONTMATTER_DELIM)) {
+        return null;
+    }
+    const rest = trimmed.slice(FRONTMATTER_DELIM.length);
+    const endIdx = rest.indexOf('\n' + FRONTMATTER_DELIM);
+    if (endIdx === -1) {
+        return null;
+    }
+    const frontmatterBlock = rest.slice(0, endIdx).trim();
+    const body = rest.slice(endIdx + FRONTMATTER_DELIM.length + 1).trimStart();
+    let description = '';
+    let globs;
+    let alwaysApply = false;
+    for (const line of frontmatterBlock.split('\n')) {
+        const colonIdx = line.indexOf(':');
+        if (colonIdx === -1)
+            continue;
+        const key = line.slice(0, colonIdx).trim();
+        let value = line.slice(colonIdx + 1).trim();
+        if ((value.startsWith('"') && value.endsWith('"')) || (value.startsWith("'") && value.endsWith("'"))) {
+            value = value.slice(1, -1).replace(/\\n/g, '\n').replace(/\\"/g, '"').replace(/\\\\/g, '\\');
+        }
+        switch (key) {
+            case 'description':
+                description = value;
+                break;
+            case 'globs':
+                globs = value;
+                break;
+            case 'alwaysApply':
+                alwaysApply = value === 'true' || value === '1';
+                break;
+        }
+    }
+    return { description, globs, alwaysApply, body };
+};

package/dist/lib/rule-cache.d.ts

@@ -4,11 +4,11 @@ import type { Rule } from '../types.js';
  */
 export declare const getCacheDir: () => string;
 /**
- * Gets the cached file path for a rule by ID
+ * Gets the cached file path for a rule by ID (rules use .mdc, others use .md)
  */
 export declare const getCachedRulePath: (rule: Rule) => string;
 /**
  * Ensures a rule is cached. Downloads and caches it if not present or outdated.
- * Returns the path to the cached file.
+ * Returns the path to the cached file. Rules are stored as .mdc with Cursor frontmatter.
  */
 export declare const ensureRuleCached: (id: string) => Promise<string>;

package/dist/lib/rule-cache.js

@@ -2,7 +2,8 @@ import { existsSync, mkdirSync, writeFileSync, statSync } from 'fs';
 import { join } from 'path';
 import { getConfigDir } from '../auth/config.js';
 import { getRuleById } from '../api/client.js';
-import { ruleFilename, solutionFilename } from './slug.js';
+import { ruleFilename, solutionFilename, skillFilename, commandFilename } from './slug.js';
+import { buildRuleMdcContent } from './mdc-format.js';
 /**
  * Gets the cache directory for rules (~/.bitcompass/cache/rules/)
  */
@@ -14,18 +15,22 @@ export const getCacheDir = () => {
     return cacheDir;
 };
 /**
- * Gets the cached file path for a rule by ID
+ * Gets the cached file path for a rule by ID (rules use .mdc, others use .md)
  */
 export const getCachedRulePath = (rule) => {
     const cacheDir = getCacheDir();
     const filename = rule.kind === 'solution'
         ? solutionFilename(rule.title, rule.id)
-        : ruleFilename(rule.title, rule.id);
+        : rule.kind === 'skill'
+            ? skillFilename(rule.title, rule.id)
+            : rule.kind === 'command'
+                ? commandFilename(rule.title, rule.id)
+                : ruleFilename(rule.title, rule.id);
     return join(cacheDir, `${rule.id}-${filename}`);
 };
 /**
  * Ensures a rule is cached. Downloads and caches it if not present or outdated.
- * Returns the path to the cached file.
+ * Returns the path to the cached file. Rules are stored as .mdc with Cursor frontmatter.
  */
 export const ensureRuleCached = async (id) => {
     const rule = await getRuleById(id);
@@ -35,9 +40,11 @@ export const ensureRuleCached = async (id) => {
     const cachedPath = getCachedRulePath(rule);
     const needsUpdate = !existsSync(cachedPath) || isCacheOutdated(cachedPath, rule);
     if (needsUpdate) {
-        const content = rule.kind === 'solution'
-            ? `# ${rule.title}\n\n${rule.description}\n\n## Solution\n\n${rule.body}\n`
-            : `# ${rule.title}\n\n${rule.description}\n\n${rule.body}\n`;
+        const content = rule.kind === 'rule'
+            ? buildRuleMdcContent(rule)
+            : rule.kind === 'solution'
+                ? `# ${rule.title}\n\n${rule.description}\n\n## Solution\n\n${rule.body}\n`
+                : `# ${rule.title}\n\n${rule.description}\n\n${rule.body}\n`;
         writeFileSync(cachedPath, content, 'utf-8');
     }
     return cachedPath;

package/dist/lib/rule-file-ops.js

@@ -5,6 +5,7 @@ import { getRuleById } from '../api/client.js';
 import { getProjectConfig } from '../auth/project-config.js';
 import { ruleFilename, solutionFilename, skillFilename, commandFilename } from './slug.js';
 import { ensureRuleCached } from './rule-cache.js';
+import { buildRuleMdcContent } from './mdc-format.js';
 /**
  * Pulls a rule or solution to a file using symbolic links (like Bun init).
  * Returns the file path where it was written/linked.
@@ -79,23 +80,12 @@ export const pullRuleToFile = async (id, options = {}) => {
         }
     }
     else {
-        // Fallback: copy file content (for compatibility or when symlinks aren't desired)
-        let content;
-        switch (rule.kind) {
-            case 'solution':
-                content = `# ${rule.title}\n\n${rule.description}\n\n## Solution\n\n${rule.body}\n`;
-                break;
-            case 'skill':
-                content = `# ${rule.title}\n\n${rule.description}\n\n${rule.body}\n`;
-                break;
-            case 'command':
-                content = `# ${rule.title}\n\n${rule.description}\n\n${rule.body}\n`;
-                break;
-            case 'rule':
-            default:
-                content = `# ${rule.title}\n\n${rule.description}\n\n${rule.body}\n`;
-                break;
-        }
+        // Fallback: copy file content (rules as .mdc with frontmatter, others as .md)
+        const content = rule.kind === 'rule'
+            ? buildRuleMdcContent(rule)
+            : rule.kind === 'solution'
+                ? `# ${rule.title}\n\n${rule.description}\n\n## Solution\n\n${rule.body}\n`
+                : `# ${rule.title}\n\n${rule.description}\n\n${rule.body}\n`;
         writeFileSync(filename, content);
     }
     return filename;

package/dist/lib/slug.d.ts

@@ -4,7 +4,7 @@
  */
 export declare const titleToSlug: (title: string) => string;
 /**
- * Returns the rule filename (e.g. rule-strava-api-authentication-flow.md).
+ * Returns the rule filename in Cursor .mdc format (e.g. rule-strava-api-authentication-flow.mdc).
  * Falls back to id if slug is empty.
  */
 export declare const ruleFilename: (title: string, id: string) => string;

package/dist/lib/slug.js

@@ -14,13 +14,13 @@ export const titleToSlug = (title) => {
         .replace(/^-|-$/g, '');
 };
 /**
- * Returns the rule filename (e.g. rule-strava-api-authentication-flow.md).
+ * Returns the rule filename in Cursor .mdc format (e.g. rule-strava-api-authentication-flow.mdc).
  * 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`;
+    return `${base}.mdc`;
 };
 /**
  * Returns the solution filename (e.g. solution-strava-api-authentication-flow.md).

package/dist/mcp/server.js

@@ -139,7 +139,7 @@ function createStdioServer() {
                             },
                             {
                                 name: 'update-rule',
-                                description: 'Use when the user wants to edit an existing rule or solution they own. Pass id and any fields to update (title, description, body, context, examples, technologies). Returns updated metadata. Requires authentication.',
+                                description: 'Use when the user wants to edit an existing rule or solution they own. Pass id and any fields to update (title, description, body, context, examples, technologies, globs, always_apply). Returns updated metadata. Requires authentication.',
                                 inputSchema: {
                                     type: 'object',
                                     properties: {
@@ -150,6 +150,8 @@ function createStdioServer() {
                                         context: { type: 'string', description: 'Updated context' },
                                         examples: { type: 'array', items: { type: 'string' }, description: 'Updated examples array' },
                                         technologies: { type: 'array', items: { type: 'string' }, description: 'Updated technologies array' },
+                                        globs: { type: 'string', description: 'Glob patterns for when rule applies (e.g. "*.ts, *.tsx")' },
+                                        always_apply: { type: 'boolean', description: 'If true, Cursor applies this rule globally' },
                                     },
                                     required: ['id'],
                                 },
@@ -399,6 +401,8 @@ function createStdioServer() {
                 context: rule.context ?? null,
                 examples: rule.examples ?? [],
                 technologies: rule.technologies ?? [],
+                globs: rule.globs ?? null,
+                always_apply: rule.always_apply ?? false,
                 author: rule.author_display_name ?? null,
                 created_at: rule.created_at,
                 updated_at: rule.updated_at,
@@ -459,6 +463,10 @@ function createStdioServer() {
             updates.examples = args.examples;
         if (Array.isArray(args.technologies))
             updates.technologies = args.technologies;
+        if (args.globs !== undefined)
+            updates.globs = args.globs || null;
+        if (args.always_apply !== undefined)
+            updates.always_apply = Boolean(args.always_apply);
         try {
             const updated = await updateRule(id, updates);
             return {

package/dist/types.d.ts

@@ -11,6 +11,10 @@ export interface Rule {
     user_id: string;
     author_display_name?: string | null;
     version?: string | null;
+    /** Optional glob patterns for when the rule applies (e.g. "*.ts, *.tsx"). Used in .mdc frontmatter. */
+    globs?: string | null;
+    /** If true, Cursor applies this rule globally. Default false. Used in .mdc frontmatter. */
+    always_apply?: boolean;
     created_at: string;
     updated_at: string;
 }
@@ -23,6 +27,8 @@ export interface RuleInsert {
     examples?: string[];
     technologies?: string[];
     version?: string;
+    globs?: string | null;
+    always_apply?: boolean;
 }
 export interface StoredCredentials {
     access_token: string;

package/package.json

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