byterover-cli 0.3.3 → 0.3.4

package/dist/infra/file/fs-file-service.js

@@ -1,9 +1,21 @@
-import { access, appendFile, mkdir, readFile, writeFile } from 'node:fs/promises';
+import { access, appendFile, copyFile, mkdir, readFile, writeFile } from 'node:fs/promises';
 import { dirname } from 'node:path';
 /**
  * File service implementation using Node.js fs module.
  */
 export class FsFileService {
+    async createBackup(filePath) {
+        try {
+            // Timestamp format: YYYY-MM-DD-HH-MM-SS
+            const timestamp = new Date().toISOString().replaceAll(/[:.]/g, '-').split('T').join('-').slice(0, -5);
+            const backupPath = `${filePath}.backup-${timestamp}`;
+            await copyFile(filePath, backupPath);
+            return backupPath;
+        }
+        catch (error) {
+            throw new Error(`Failed to create backup file '${filePath}': ${error instanceof Error ? error.message : 'Unknown error'}`);
+        }
+    }
     /**
      * Checks if a file exists at the specified path.
      *
@@ -33,6 +45,16 @@ export class FsFileService {
             throw new Error(`Failed to read content from file '${filePath}': ${error instanceof Error ? error.message : String(error)}`);
         }
     }
+    async replaceContent(filePath, oldContent, newContent) {
+        try {
+            const currentContent = await this.read(filePath);
+            const updatedContent = currentContent.replace(oldContent, newContent);
+            await this.write(updatedContent, filePath, 'overwrite');
+        }
+        catch (error) {
+            throw new Error(`Failed to replace content in file '${filePath}': ${error instanceof Error ? error.message : 'Unknown error'}`);
+        }
+    }
     /**
      * Writes content to the specified file.
      * @param content The content to write.

package/dist/infra/rule/constants.d.ts

@@ -1,4 +1,12 @@
 /**
  * ByteRover CLI generated rule template tag.
  */
-export declare const BR_RULE_TAG = "Generated by ByteRover CLI for";
+export declare const BRV_RULE_TAG = "Generated by ByteRover CLI for";
+/**
+ * Boundary markers for managed ByteRover rule sections.
+ * Used to identify and replace ByteRover-generated content in shared instruction files.
+ */
+export declare const BRV_RULE_MARKERS: {
+    readonly END: "<!-- END BYTEROVER RULES -->";
+    readonly START: "<!-- BEGIN BYTEROVER RULES -->";
+};

package/dist/infra/rule/constants.js

@@ -1,4 +1,12 @@
 /**
  * ByteRover CLI generated rule template tag.
  */
-export const BR_RULE_TAG = 'Generated by ByteRover CLI for';
+export const BRV_RULE_TAG = 'Generated by ByteRover CLI for';
+/**
+ * Boundary markers for managed ByteRover rule sections.
+ * Used to identify and replace ByteRover-generated content in shared instruction files.
+ */
+export const BRV_RULE_MARKERS = {
+    END: '<!-- END BYTEROVER RULES -->',
+    START: '<!-- BEGIN BYTEROVER RULES -->',
+};

package/dist/infra/rule/legacy-rule-detector.d.ts

@@ -0,0 +1,21 @@
+import type { Agent } from '../../core/domain/entities/agent.js';
+import type { ILegacyRuleDetector, LegacyRuleDetectionResult } from '../../core/interfaces/i-legacy-rule-detector.js';
+export declare class LegacyRuleDetector implements ILegacyRuleDetector {
+    private static readonly SECTION_SEPARATOR_PATTERN;
+    private static readonly WORKFLOW_HEADER_PATTERN;
+    detectLegacyRules(content: string, agentName: Agent): LegacyRuleDetectionResult;
+    /**
+     * Attempts to find the start of a ByteRover rule section by working backwards from the footer.
+     *
+     * Strategy 3 (Conservative Multi-Pattern Match):
+     * 1. Look backwards for "# Workflow Instruction" header (most reliable)
+     * 2. If not found, look backwards for "---" separator before command reference
+     * 3. If still not found, return undefined (uncertain)
+     *
+     * @param lines All lines in the file.
+     * @param footerIndex Index of the line containing the footer tag (0-indexed).
+     * @param usedLineRanges Line ranges already claimed by detected sections.
+     * @returns Index of the start line (0-indexed), or undefined if uncertain.
+     */
+    private findSectionStart;
+}

package/dist/infra/rule/legacy-rule-detector.js

@@ -0,0 +1,106 @@
+import { BRV_RULE_TAG } from './constants.js';
+export class LegacyRuleDetector {
+    static SECTION_SEPARATOR_PATTERN = /^---\s*$/;
+    static WORKFLOW_HEADER_PATTERN = /^#\sWorkflow Instruction$/;
+    detectLegacyRules(content, agentName) {
+        // Normalize line endings to handle CRLF
+        const normalizedContent = content.replaceAll('\r\n', '\n').replaceAll('\r', '\n');
+        const lines = normalizedContent.split('\n');
+        const footerTag = `${BRV_RULE_TAG} ${agentName}`;
+        const reliableMatches = [];
+        const uncertainMatches = [];
+        const usedLineRanges = [];
+        // Find all occurrences of the footer tag
+        for (const [index, line] of lines.entries()) {
+            // Use exact match to avoid matching partial agent names like "Github Copilot Extended"
+            if (line.trim() === footerTag) {
+                const footerIndex = index;
+                const footerLineNumber = footerIndex + 1;
+                // Try to find the start of this ByteRover section
+                const startIndex = this.findSectionStart(lines, footerIndex, usedLineRanges);
+                if (startIndex === undefined) {
+                    // Uncertain match - couldn't reliably determine start
+                    uncertainMatches.push({
+                        footerLine: footerLineNumber,
+                        reason: 'Could not reliably determine the start of the ByteRover rule section.',
+                    });
+                }
+                else {
+                    // Reliable match found
+                    const startLineNumber = startIndex + 1;
+                    const sectionContent = lines.slice(startIndex, footerIndex + 1).join('\n');
+                    reliableMatches.push({
+                        content: sectionContent,
+                        endLine: footerLineNumber,
+                        startLine: startLineNumber,
+                    });
+                    // Mark this range as used so it won't be reused by subsequent footers
+                    usedLineRanges.push({ end: footerIndex, start: startIndex });
+                }
+            }
+        }
+        return { reliableMatches, uncertainMatches };
+    }
+    /**
+     * Attempts to find the start of a ByteRover rule section by working backwards from the footer.
+     *
+     * Strategy 3 (Conservative Multi-Pattern Match):
+     * 1. Look backwards for "# Workflow Instruction" header (most reliable)
+     * 2. If not found, look backwards for "---" separator before command reference
+     * 3. If still not found, return undefined (uncertain)
+     *
+     * @param lines All lines in the file.
+     * @param footerIndex Index of the line containing the footer tag (0-indexed).
+     * @param usedLineRanges Line ranges already claimed by detected sections.
+     * @returns Index of the start line (0-indexed), or undefined if uncertain.
+     */
+    findSectionStart(lines, footerIndex, usedLineRanges) {
+        // Strategy 1: Look for "# Workflow Instruction" header (most reliable)
+        for (let i = footerIndex - 1; i >= 0; i--) {
+            if (LegacyRuleDetector.WORKFLOW_HEADER_PATTERN.test(lines[i])) {
+                // Check if this header is within any already-detected section
+                const isWithinUsedRange = usedLineRanges.some((range) => i >= range.start && i <= range.end);
+                if (!isWithinUsedRange) {
+                    return i;
+                }
+            }
+        }
+        // Strategy 2: Look for "---" separator
+        // We need to find the section separator that appears before the command reference
+        // and after the workflow content. This is less reliable but still useful.
+        const separatorIndices = [];
+        for (let i = footerIndex - 1; i >= 0; i--) {
+            if (LegacyRuleDetector.SECTION_SEPARATOR_PATTERN.test(lines[i])) {
+                separatorIndices.push(i);
+            }
+        }
+        // If we found at least one separator, use it as a fallback
+        // We want the one closest to the footer but before the "---" that precedes the footer
+        if (separatorIndices.length > 0) {
+            // The footer line should be preceded by "---", so we skip that one
+            // and look for the next separator going backwards
+            let candidateIndex;
+            for (const sepIndex of separatorIndices) {
+                const linesBetween = footerIndex - sepIndex;
+                if (linesBetween === 1) {
+                    // This is the separator right before the footer, skip it
+                    continue;
+                }
+                // Check if this separator is within any already-detected section
+                const isWithinUsedRange = usedLineRanges.some((range) => sepIndex >= range.start && sepIndex <= range.end);
+                if (isWithinUsedRange) {
+                    continue;
+                }
+                // This could be a section separator within the ByteRover content
+                // Use the first one we find (closest to footer)
+                candidateIndex = sepIndex + 1;
+                break;
+            }
+            if (candidateIndex !== undefined && candidateIndex < footerIndex) {
+                return candidateIndex;
+            }
+        }
+        // Strategy 3: Could not reliably determine start
+        return undefined;
+    }
+}

package/dist/infra/rule/rule-template-service.js

@@ -1,4 +1,16 @@
-import { BR_RULE_TAG } from './constants.js';
+import { BRV_RULE_MARKERS, BRV_RULE_TAG } from './constants.js';
+/**
+ * Wraps rule content with boundary markers for identification and replacement.
+ *
+ * @param content The rule content to wrap.
+ * @param agent The agent name for the footer tag.
+ * @param header Agent-specific header.
+ * @returns The wrapped content with boundary markers.
+ */
+const wrapContentWithBoundaryMarkers = (content, agent, header) => {
+    const parts = [BRV_RULE_MARKERS.START, header, content, '---', `${BRV_RULE_TAG} ${agent}`, BRV_RULE_MARKERS.END];
+    return parts.join('\n');
+};
 const guideHeaders = [
     {
         agent: 'Augment Code',
@@ -67,11 +79,7 @@ export class RuleTemplateService {
             const content = this.templateLoader.substituteVariables(baseTemplate, context);
             // Add agent-specific header if available (from develop branch)
             const header = guideHeaders.find((h) => h.agent === agent)?.value || '';
-            return `${header}
-${content}
----
-${BR_RULE_TAG} ${agent}
-`;
+            return wrapContentWithBoundaryMarkers(content, agent, header);
         }
         catch (error) {
             throw new Error(`Failed to generate rule content for agent '${agent}': ${error instanceof Error ? error.message : String(error)}`);

package/oclif.manifest.json

@@ -672,5 +672,5 @@
       ]
     }
   },
-  "version": "0.3.3"
+  "version": "0.3.4"
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "byterover-cli",
   "description": "ByteRover's CLI",
-  "version": "0.3.3",
+  "version": "0.3.4",
   "author": "ByteRover",
   "bin": {
     "brv": "./bin/run.js"
@@ -16,6 +16,7 @@
     "@inquirer/prompts": "^7.9.0",
     "@oclif/core": "^4",
     "@oclif/plugin-help": "^6",
+    "@types/update-notifier": "^6.0.8",
     "axios": "^1.12.2",
     "better-sqlite3": "^11.5.0",
     "chalk": "^5.6.2",
@@ -30,6 +31,7 @@
     "nanoid": "^5.1.6",
     "open": "^10.2.0",
     "openai": "^6.9.1",
+    "update-notifier": "^7.3.1",
     "zod": "^3.25.76",
     "zod-to-json-schema": "^3.24.6"
   },
@@ -75,7 +77,10 @@
     "dirname": "brv",
     "commands": "./dist/commands",
     "hooks": {
-      "init": "./dist/hooks/init/welcome",
+      "init": [
+        "./dist/hooks/init/welcome",
+        "./dist/hooks/init/update-notifier"
+      ],
       "command_not_found": "./dist/hooks/command_not_found/handle-invalid-commands",
       "error": "./dist/hooks/error/clean-errors",
       "prerun": "./dist/hooks/prerun/validate-brv-config-version"

package/dist/core/domain/errors/rule-error.d.ts

@@ -1,6 +0,0 @@
-export declare class RuleError extends Error {
-    constructor(message: string);
-}
-export declare class RuleExistsError extends RuleError {
-    constructor(message?: string);
-}

package/dist/core/domain/errors/rule-error.js

@@ -1,12 +0,0 @@
-export class RuleError extends Error {
-    constructor(message) {
-        super(message);
-        this.name = 'RuleError';
-    }
-}
-export class RuleExistsError extends RuleError {
-    constructor(message = 'Rule already exists') {
-        super(message);
-        this.name = 'RuleExistsError';
-    }
-}

package/dist/core/interfaces/i-rule-writer-service.d.ts

@@ -1,13 +0,0 @@
-import { Agent } from '../domain/entities/agent.js';
-/**
- * Interface for rule writer service operations.
- */
-export interface IRuleWriterService {
-    /**
-     * Writes a rule for the given agent.
-     * @param agent The agent for which to write the rule.
-     * @param force Whether to force the rule to be written even if it already exists.
-     * @returns A promise that resolves when the rule has been written.
-     */
-    writeRule: (agent: Agent, force: boolean) => Promise<void>;
-}

package/dist/infra/rule/rule-writer-service.d.ts

@@ -1,19 +0,0 @@
-import { type Agent } from '../../core/domain/entities/agent.js';
-import { type IFileService } from '../../core/interfaces/i-file-service.js';
-import { IRuleTemplateService } from '../../core/interfaces/i-rule-template-service.js';
-import { type IRuleWriterService } from '../../core/interfaces/i-rule-writer-service.js';
-/**
- * Service for writing agent-specific rule files.
- * Uses IFileService to write files and RuleTemplateService to generate content.
- */
-export declare class RuleWriterService implements IRuleWriterService {
-    private readonly fileService;
-    private readonly templateService;
-    /**
-     * Creates a new RuleWriterService.
-     * @param fileService The file service to use for writing files.
-     * @param templateService The template service to use for generating rule content.
-     */
-    constructor(fileService: IFileService, templateService: IRuleTemplateService);
-    writeRule(agent: Agent, force: boolean): Promise<void>;
-}

package/dist/infra/rule/rule-writer-service.js

@@ -1,39 +0,0 @@
-import { RuleExistsError } from '../../core/domain/errors/rule-error.js';
-import { AGENT_RULE_CONFIGS } from './agent-rule-config.js';
-import { BR_RULE_TAG } from './constants.js';
-/**
- * Service for writing agent-specific rule files.
- * Uses IFileService to write files and RuleTemplateService to generate content.
- */
-export class RuleWriterService {
-    fileService;
-    templateService;
-    /**
-     * Creates a new RuleWriterService.
-     * @param fileService The file service to use for writing files.
-     * @param templateService The template service to use for generating rule content.
-     */
-    constructor(fileService, templateService) {
-        this.fileService = fileService;
-        this.templateService = templateService;
-    }
-    async writeRule(agent, force) {
-        const config = AGENT_RULE_CONFIGS[agent];
-        if (!config) {
-            throw new Error(`No configuration found for agent: ${agent}`);
-        }
-        const { filePath, writeMode } = config;
-        const fileExists = await this.fileService.exists(filePath);
-        if (writeMode === 'overwrite' && fileExists && !force) {
-            throw new RuleExistsError();
-        }
-        if (writeMode === 'append' && fileExists && !force) {
-            const content = await this.fileService.read(filePath);
-            if (content.includes(BR_RULE_TAG)) {
-                throw new RuleExistsError();
-            }
-        }
-        const ruleContent = await this.templateService.generateRuleContent(agent);
-        await this.fileService.write(ruleContent, filePath, writeMode);
-    }
-}