@stackguide/mcp-server 3.2.0 → 3.8.1

package/dist/services/rulesEngine.d.ts

@@ -0,0 +1,255 @@
+/**
+ * Configurable Rules Engine
+ * Dynamic rule loading, validation, and configuration
+ * @version 3.7.0
+ */
+import { z } from 'zod';
+/** Rule severity levels */
+export declare const RuleSeveritySchema: z.ZodEnum<["error", "warning", "info", "suggestion"]>;
+export type RuleSeverity = z.infer<typeof RuleSeveritySchema>;
+/** Rule categories */
+export declare const RuleCategorySchema: z.ZodEnum<["security", "performance", "best-practices", "maintainability", "architecture", "accessibility", "code-style"]>;
+export type RuleCategory = z.infer<typeof RuleCategorySchema>;
+/** Full rule definition schema */
+export declare const RuleDefinitionSchema: z.ZodObject<{
+    id: z.ZodString;
+    name: z.ZodString;
+    description: z.ZodString;
+    category: z.ZodEnum<["security", "performance", "best-practices", "maintainability", "architecture", "accessibility", "code-style"]>;
+    severity: z.ZodEnum<["error", "warning", "info", "suggestion"]>;
+    enabled: z.ZodDefault<z.ZodBoolean>;
+    languages: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+    filePatterns: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+    pattern: z.ZodOptional<z.ZodString>;
+    astQuery: z.ZodOptional<z.ZodString>;
+    message: z.ZodString;
+    suggestion: z.ZodOptional<z.ZodString>;
+    tags: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+    source: z.ZodDefault<z.ZodEnum<["builtin", "custom", "plugin"]>>;
+    version: z.ZodOptional<z.ZodString>;
+    autoFix: z.ZodOptional<z.ZodObject<{
+        replacement: z.ZodString;
+        description: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        description: string;
+        replacement: string;
+    }, {
+        description: string;
+        replacement: string;
+    }>>;
+}, "strip", z.ZodTypeAny, {
+    id: string;
+    name: string;
+    category: "best-practices" | "security" | "performance" | "architecture" | "accessibility" | "maintainability" | "code-style";
+    description: string;
+    enabled: boolean;
+    message: string;
+    source: "custom" | "builtin" | "plugin";
+    severity: "error" | "warning" | "info" | "suggestion";
+    suggestion?: string | undefined;
+    pattern?: string | undefined;
+    version?: string | undefined;
+    languages?: string[] | undefined;
+    tags?: string[] | undefined;
+    autoFix?: {
+        description: string;
+        replacement: string;
+    } | undefined;
+    filePatterns?: string[] | undefined;
+    astQuery?: string | undefined;
+}, {
+    id: string;
+    name: string;
+    category: "best-practices" | "security" | "performance" | "architecture" | "accessibility" | "maintainability" | "code-style";
+    description: string;
+    message: string;
+    severity: "error" | "warning" | "info" | "suggestion";
+    suggestion?: string | undefined;
+    pattern?: string | undefined;
+    enabled?: boolean | undefined;
+    version?: string | undefined;
+    languages?: string[] | undefined;
+    source?: "custom" | "builtin" | "plugin" | undefined;
+    tags?: string[] | undefined;
+    autoFix?: {
+        description: string;
+        replacement: string;
+    } | undefined;
+    filePatterns?: string[] | undefined;
+    astQuery?: string | undefined;
+}>;
+export type RuleDefinition = z.infer<typeof RuleDefinitionSchema>;
+/** Rule override (partial update) */
+export declare const RuleOverrideSchema: z.ZodObject<{
+    enabled: z.ZodOptional<z.ZodBoolean>;
+    severity: z.ZodOptional<z.ZodEnum<["error", "warning", "info", "suggestion"]>>;
+    message: z.ZodOptional<z.ZodString>;
+}, "strict", z.ZodTypeAny, {
+    enabled?: boolean | undefined;
+    message?: string | undefined;
+    severity?: "error" | "warning" | "info" | "suggestion" | undefined;
+}, {
+    enabled?: boolean | undefined;
+    message?: string | undefined;
+    severity?: "error" | "warning" | "info" | "suggestion" | undefined;
+}>;
+export type RuleOverride = z.infer<typeof RuleOverrideSchema>;
+export interface RuleConfig {
+    version: string;
+    rules: RuleDefinition[];
+    overrides: Record<string, RuleOverride>;
+    disabledCategories: RuleCategory[];
+    disabledRules: string[];
+    settings: RuleEngineSettings;
+}
+export interface RuleEngineSettings {
+    maxIssuesPerFile: number;
+    maxIssuesTotal: number;
+    failOnError: boolean;
+    failOnWarning: boolean;
+    autoFix: boolean;
+    verboseOutput: boolean;
+}
+declare class RulesRegistry {
+    private builtinRules;
+    private customRules;
+    private overrides;
+    private disabledCategories;
+    private disabledRules;
+    private settings;
+    constructor();
+    /**
+     * Register a builtin rule
+     */
+    registerBuiltin(rule: RuleDefinition): this;
+    /**
+     * Register multiple builtin rules
+     */
+    registerBuiltinRules(rules: RuleDefinition[]): this;
+    /**
+     * Add a custom rule
+     */
+    addCustomRule(rule: RuleDefinition): {
+        success: boolean;
+        error?: string;
+    };
+    /**
+     * Remove a custom rule
+     */
+    removeCustomRule(ruleId: string): boolean;
+    /**
+     * Override a rule's properties
+     */
+    setOverride(ruleId: string, override: RuleOverride): {
+        success: boolean;
+        error?: string;
+    };
+    /**
+     * Remove a rule override
+     */
+    removeOverride(ruleId: string): boolean;
+    /**
+     * Enable/disable a specific rule
+     */
+    setRuleEnabled(ruleId: string, enabled: boolean): boolean;
+    /**
+     * Enable/disable a category
+     */
+    setCategoryEnabled(category: RuleCategory, enabled: boolean): boolean;
+    /**
+     * Update settings
+     */
+    updateSettings(settings: Partial<RuleEngineSettings>): void;
+    /**
+     * Get a rule by ID (with overrides applied)
+     */
+    getRule(ruleId: string): RuleDefinition | null;
+    /**
+     * Get all rules (with filters)
+     */
+    getRules(options?: {
+        category?: RuleCategory;
+        severity?: RuleSeverity;
+        language?: string;
+        enabledOnly?: boolean;
+        source?: 'builtin' | 'custom' | 'all';
+    }): RuleDefinition[];
+    /**
+     * Get rules for a specific file
+     */
+    getRulesForFile(filePath: string, language?: string): RuleDefinition[];
+    /**
+     * Get settings
+     */
+    getSettings(): RuleEngineSettings;
+    /**
+     * Get statistics
+     */
+    getStats(): {
+        totalBuiltin: number;
+        totalCustom: number;
+        enabled: number;
+        disabled: number;
+        overridden: number;
+        byCategory: Record<string, number>;
+        bySeverity: Record<string, number>;
+    };
+    private saveToStorage;
+    private loadFromStorage;
+    /**
+     * Reset to defaults
+     */
+    reset(): void;
+    /**
+     * Full reset including builtin rules (for testing)
+     */
+    resetAll(): void;
+    /**
+     * Export configuration
+     */
+    exportConfig(): RuleConfig;
+    /**
+     * Import configuration
+     */
+    importConfig(config: RuleConfig): {
+        success: boolean;
+        imported: number;
+        errors: string[];
+    };
+}
+export declare const rulesRegistry: RulesRegistry;
+export declare function registerBuiltinRule(rule: RuleDefinition): void;
+export declare function registerBuiltinRules(rules: RuleDefinition[]): void;
+export declare function addCustomRule(rule: RuleDefinition): {
+    success: boolean;
+    error?: string;
+};
+export declare function removeCustomRule(ruleId: string): boolean;
+export declare function getRule(ruleId: string): RuleDefinition | null;
+export declare function getRules(options?: Parameters<RulesRegistry['getRules']>[0]): RuleDefinition[];
+export declare function getRulesForFile(filePath: string, language?: string): RuleDefinition[];
+export declare function setRuleEnabled(ruleId: string, enabled: boolean): boolean;
+export declare function setRuleOverride(ruleId: string, override: RuleOverride): {
+    success: boolean;
+    error?: string;
+};
+export declare function getRuleSettings(): RuleEngineSettings;
+export declare function updateRuleSettings(settings: Partial<RuleEngineSettings>): void;
+export declare function getRuleStats(): {
+    totalBuiltin: number;
+    totalCustom: number;
+    enabled: number;
+    disabled: number;
+    overridden: number;
+    byCategory: Record<string, number>;
+    bySeverity: Record<string, number>;
+};
+export declare function resetRulesEngine(): void;
+export declare function exportRulesConfig(): RuleConfig;
+export declare function importRulesConfig(config: RuleConfig): {
+    success: boolean;
+    imported: number;
+    errors: string[];
+};
+export {};
+//# sourceMappingURL=rulesEngine.d.ts.map

package/dist/services/rulesEngine.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"rulesEngine.d.ts","sourceRoot":"","sources":["../../src/services/rulesEngine.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAQxB,2BAA2B;AAC3B,eAAO,MAAM,kBAAkB,uDAAqD,CAAC;AACrF,MAAM,MAAM,YAAY,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAC;AAE9D,sBAAsB;AACtB,eAAO,MAAM,kBAAkB,4HAQ7B,CAAC;AACH,MAAM,MAAM,YAAY,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAC;AAE9D,kCAAkC;AAClC,eAAO,MAAM,oBAAoB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EA8B/B,CAAC;AAEH,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAC;AAElE,qCAAqC;AACrC,eAAO,MAAM,kBAAkB;;;;;;;;;;;;EAIpB,CAAC;AAEZ,MAAM,MAAM,YAAY,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAC;AAM9D,MAAM,WAAW,UAAU;IACzB,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,cAAc,EAAE,CAAC;IACxB,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;IACxC,kBAAkB,EAAE,YAAY,EAAE,CAAC;IACnC,aAAa,EAAE,MAAM,EAAE,CAAC;IACxB,QAAQ,EAAE,kBAAkB,CAAC;CAC9B;AAED,MAAM,WAAW,kBAAkB;IACjC,gBAAgB,EAAE,MAAM,CAAC;IACzB,cAAc,EAAE,MAAM,CAAC;IACvB,WAAW,EAAE,OAAO,CAAC;IACrB,aAAa,EAAE,OAAO,CAAC;IACvB,OAAO,EAAE,OAAO,CAAC;IACjB,aAAa,EAAE,OAAO,CAAC;CACxB;AAeD,cAAM,aAAa;IACjB,OAAO,CAAC,YAAY,CAA0C;IAC9D,OAAO,CAAC,WAAW,CAA0C;IAC7D,OAAO,CAAC,SAAS,CAAwC;IACzD,OAAO,CAAC,kBAAkB,CAAgC;IAC1D,OAAO,CAAC,aAAa,CAA0B;IAC/C,OAAO,CAAC,QAAQ,CAA+C;;IAQ/D;;OAEG;IACH,eAAe,CAAC,IAAI,EAAE,cAAc,GAAG,IAAI;IAM3C;;OAEG;IACH,oBAAoB,CAAC,KAAK,EAAE,cAAc,EAAE,GAAG,IAAI;IAOnD;;OAEG;IACH,aAAa,CAAC,IAAI,EAAE,cAAc,GAAG;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE;IAqBzE;;OAEG;IACH,gBAAgB,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO;IAWzC;;OAEG;IACH,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,YAAY,GAAG;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE;IAmBzF;;OAEG;IACH,cAAc,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO;IAQvC;;OAEG;IACH,cAAc,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,GAAG,OAAO;IAUzD;;OAEG;IACH,kBAAkB,CAAC,QAAQ,EAAE,YAAY,EAAE,OAAO,EAAE,OAAO,GAAG,OAAO;IAUrE;;OAEG;IACH,cAAc,CAAC,QAAQ,EAAE,OAAO,CAAC,kBAAkB,CAAC,GAAG,IAAI;IAO3D;;OAEG;IACH,OAAO,CAAC,MAAM,EAAE,MAAM,GAAG,cAAc,GAAG,IAAI;IAgB9C;;OAEG;IACH,QAAQ,CAAC,OAAO,GAAE;QAChB,QAAQ,CAAC,EAAE,YAAY,CAAC;QACxB,QAAQ,CAAC,EAAE,YAAY,CAAC;QACxB,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,WAAW,CAAC,EAAE,OAAO,CAAC;QACtB,MAAM,CAAC,EAAE,SAAS,GAAG,QAAQ,GAAG,KAAK,CAAC;KAClC,GAAG,cAAc,EAAE;IAyCzB;;OAEG;IACH,eAAe,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,cAAc,EAAE;IAqBtE;;OAEG;IACH,WAAW,IAAI,kBAAkB;IAIjC;;OAEG;IACH,QAAQ,IAAI;QACV,YAAY,EAAE,MAAM,CAAC;QACrB,WAAW,EAAE,MAAM,CAAC;QACpB,OAAO,EAAE,MAAM,CAAC;QAChB,QAAQ,EAAE,MAAM,CAAC;QACjB,UAAU,EAAE,MAAM,CAAC;QACnB,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QACnC,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;KACpC;IAyBD,OAAO,CAAC,aAAa;IAiBrB,OAAO,CAAC,eAAe;IA4CvB;;OAEG;IACH,KAAK,IAAI,IAAI;IAUb;;OAEG;IACH,QAAQ,IAAI,IAAI;IAKhB;;OAEG;IACH,YAAY,IAAI,UAAU;IAW1B;;OAEG;IACH,YAAY,CAAC,MAAM,EAAE,UAAU,GAAG;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,EAAE,CAAA;KAAE;CA2C3F;AAMD,eAAO,MAAM,aAAa,eAAsB,CAAC;AAMjD,wBAAgB,mBAAmB,CAAC,IAAI,EAAE,cAAc,GAAG,IAAI,CAE9D;AAED,wBAAgB,oBAAoB,CAAC,KAAK,EAAE,cAAc,EAAE,GAAG,IAAI,CAElE;AAED,wBAAgB,aAAa,CAAC,IAAI,EAAE,cAAc,GAAG;IAAE,OAAO,EAAE,OAAO,CAAC;IAAC,KAAK,CAAC,EAAE,MAAM,CAAA;CAAE,CAExF;AAED,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAExD;AAED,wBAAgB,OAAO,CAAC,MAAM,EAAE,MAAM,GAAG,cAAc,GAAG,IAAI,CAE7D;AAED,wBAAgB,QAAQ,CAAC,OAAO,CAAC,EAAE,UAAU,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,cAAc,EAAE,CAE7F;AAED,wBAAgB,eAAe,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,cAAc,EAAE,CAErF;AAED,wBAAgB,cAAc,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,GAAG,OAAO,CAExE;AAED,wBAAgB,eAAe,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,YAAY,GAAG;IAAE,OAAO,EAAE,OAAO,CAAC;IAAC,KAAK,CAAC,EAAE,MAAM,CAAA;CAAE,CAE5G;AAED,wBAAgB,eAAe,IAAI,kBAAkB,CAEpD;AAED,wBAAgB,kBAAkB,CAAC,QAAQ,EAAE,OAAO,CAAC,kBAAkB,CAAC,GAAG,IAAI,CAE9E;AAED,wBAAgB,YAAY;kBAtOV,MAAM;iBACP,MAAM;aACV,MAAM;cACL,MAAM;gBACJ,MAAM;gBACN,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC;gBACtB,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC;EAkOrC;AAED,wBAAgB,gBAAgB,IAAI,IAAI,CAEvC;AAED,wBAAgB,iBAAiB,IAAI,UAAU,CAE9C;AAED,wBAAgB,iBAAiB,CAAC,MAAM,EAAE,UAAU;aA/GL,OAAO;cAAY,MAAM;YAAU,MAAM,EAAE;EAiHzF"}