@aramassa/ai-rules 0.2.0 → 0.2.2

package/dist/recipeValidator.d.ts

@@ -0,0 +1,18 @@
+export interface ValidationResult {
+    isValid: boolean;
+    warnings: string[];
+    errors: string[];
+}
+export declare class RecipeValidator {
+    private ajv;
+    private schema;
+    constructor();
+    initialize(): Promise<void>;
+    validateRecipe(recipeData: any): ValidationResult;
+    private formatSchemaError;
+    private getHelpfulMessageForProperty;
+    private isCommonMistake;
+    private checkCommonMistakes;
+}
+export declare function getRecipeValidator(): Promise<RecipeValidator>;
+//# sourceMappingURL=recipeValidator.d.ts.map

package/dist/recipeValidator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"recipeValidator.d.ts","sourceRoot":"","sources":["../src/recipeValidator.ts"],"names":[],"mappings":"AAUA,MAAM,WAAW,gBAAgB;IAC/B,OAAO,EAAE,OAAO,CAAC;IACjB,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB,MAAM,EAAE,MAAM,EAAE,CAAC;CAClB;AAED,qBAAa,eAAe;IAC1B,OAAO,CAAC,GAAG,CAAM;IACjB,OAAO,CAAC,MAAM,CAAM;;IAWd,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC;IAoBjC,cAAc,CAAC,UAAU,EAAE,GAAG,GAAG,gBAAgB;IA0CjD,OAAO,CAAC,iBAAiB;IA0BzB,OAAO,CAAC,4BAA4B;IAYpC,OAAO,CAAC,eAAe;IAUvB,OAAO,CAAC,mBAAmB;CAyC5B;AAKD,wBAAsB,kBAAkB,IAAI,OAAO,CAAC,eAAe,CAAC,CAMnE"}

package/dist/recipeValidator.js

@@ -0,0 +1,158 @@
+import Ajv from 'ajv';
+import addFormats from 'ajv-formats';
+import fs from 'fs/promises';
+import path from 'path';
+import { fileURLToPath } from 'url';
+// Get the current file's directory for schema loading
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+export class RecipeValidator {
+    constructor() {
+        this.ajv = new Ajv({
+            allErrors: true,
+            verbose: true,
+            strict: false // Allow additional properties for better error messages
+        });
+        addFormats(this.ajv);
+    }
+    async initialize() {
+        try {
+            const schemaPath = path.join(__dirname, '../schemas/recipe.schema.json');
+            const schemaContent = await fs.readFile(schemaPath, 'utf-8');
+            this.schema = JSON.parse(schemaContent);
+            this.ajv.addSchema(this.schema, 'recipe');
+        }
+        catch (error) {
+            console.warn('Warning: Could not load recipe schema for validation:', error);
+            // Create a minimal schema as fallback
+            this.schema = {
+                type: 'object',
+                properties: {
+                    recipe: { type: 'array' }
+                },
+                required: ['recipe']
+            };
+            this.ajv.addSchema(this.schema, 'recipe');
+        }
+    }
+    validateRecipe(recipeData) {
+        const result = {
+            isValid: true,
+            warnings: [],
+            errors: []
+        };
+        // Basic structure validation
+        if (!recipeData || typeof recipeData !== 'object') {
+            result.isValid = false;
+            result.errors.push('Recipe must be a valid YAML/JSON object');
+            return result;
+        }
+        if (!Array.isArray(recipeData.recipe)) {
+            result.isValid = false;
+            result.errors.push('Recipe file must contain a "recipe" array');
+            return result;
+        }
+        // Validate against JSON schema
+        const valid = this.ajv.validate('recipe', recipeData);
+        if (!valid && this.ajv.errors) {
+            for (const error of this.ajv.errors) {
+                const errorMessage = this.formatSchemaError(error);
+                // Convert schema errors to warnings to maintain backward compatibility
+                if (this.isCommonMistake(error)) {
+                    result.warnings.push(`Warning: ${errorMessage}`);
+                }
+                else {
+                    result.warnings.push(`Schema validation warning: ${errorMessage}`);
+                }
+            }
+        }
+        // Check for common mistakes and provide helpful warnings
+        this.checkCommonMistakes(recipeData, result);
+        return result;
+    }
+    formatSchemaError(error) {
+        const instancePath = error.instancePath || 'root';
+        switch (error.keyword) {
+            case 'additionalProperties':
+                const extraProperty = error.params?.additionalProperty;
+                if (extraProperty) {
+                    return this.getHelpfulMessageForProperty(extraProperty, instancePath);
+                }
+                return `Unknown property "${extraProperty}" at ${instancePath}`;
+            case 'required':
+                const missingProperty = error.params?.missingProperty;
+                return `Missing required property "${missingProperty}" at ${instancePath}`;
+            case 'type':
+                return `Property at ${instancePath} should be of type ${error.schema}`;
+            case 'enum':
+                return `Property at ${instancePath} should be one of: ${error.schema.join(', ')}`;
+            default:
+                return `${error.message} at ${instancePath}`;
+        }
+    }
+    getHelpfulMessageForProperty(property, path) {
+        const commonMistakes = {
+            'category': 'Property "category" should be under "filters" object, not at the recipe item root level',
+            'focus': 'Property "focus" should be under "filters" object, not at the recipe item root level',
+            'description': 'Property "description" should be under "frontmatter" object, not at the recipe item root level',
+            'applyTo': 'Property "applyTo" should be under "frontmatter" object, not at the recipe item root level',
+            'target': 'Property "target" should be under "filters" object, not at the recipe item root level'
+        };
+        return commonMistakes[property] || `Unknown property "${property}" at ${path}`;
+    }
+    isCommonMistake(error) {
+        if (error.keyword !== 'additionalProperties') {
+            return false;
+        }
+        const property = error.params?.additionalProperty;
+        const commonMistakeProps = ['category', 'focus', 'description', 'applyTo', 'target'];
+        return commonMistakeProps.includes(property);
+    }
+    checkCommonMistakes(recipeData, result) {
+        // Check for properties that should be under filters or frontmatter
+        if (Array.isArray(recipeData.recipe)) {
+            recipeData.recipe.forEach((item, index) => {
+                if (!item || typeof item !== 'object')
+                    return;
+                // Check for filter properties at root level
+                const filterProps = ['category', 'focus', 'target'];
+                filterProps.forEach(prop => {
+                    if (item[prop] !== undefined) {
+                        result.warnings.push(`Warning: Recipe item ${index + 1} has "${prop}" at root level. Consider moving it under "filters" object for better organization.`);
+                    }
+                });
+                // Check for frontmatter properties at root level  
+                const frontmatterProps = ['description', 'applyTo'];
+                frontmatterProps.forEach(prop => {
+                    if (item[prop] !== undefined) {
+                        result.warnings.push(`Warning: Recipe item ${index + 1} has "${prop}" at root level. Consider moving it under "frontmatter" object for better organization.`);
+                    }
+                });
+                // Check for both filters and individual filter properties
+                if (item.filters && typeof item.filters === 'object') {
+                    filterProps.forEach(prop => {
+                        if (item[prop] !== undefined) {
+                            result.warnings.push(`Warning: Recipe item ${index + 1} has both "filters.${prop}" and root-level "${prop}". The root-level property will be ignored.`);
+                        }
+                    });
+                }
+            });
+        }
+        // Check for root-level properties that should be under config
+        const rootLevelProps = ['baseDir'];
+        rootLevelProps.forEach(prop => {
+            if (recipeData[prop] !== undefined && !recipeData.config?.[prop]) {
+                result.warnings.push(`Warning: Root-level "${prop}" found. Consider moving it under "config" object for better organization.`);
+            }
+        });
+    }
+}
+// Singleton instance
+let validatorInstance = null;
+export async function getRecipeValidator() {
+    if (!validatorInstance) {
+        validatorInstance = new RecipeValidator();
+        await validatorInstance.initialize();
+    }
+    return validatorInstance;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aramassa/ai-rules",
-  "version": "0.2.0",
+  "version": "0.2.2",
   "description": "This repository collects guidelines and instructions for developing AI agents. It contains documents covering communication rules, coding standards, testing strategies, and general operational practices.",
   "workspaces": [
     "packages/extract",
@@ -14,6 +14,7 @@
     "dist/",
     "artifact/",
     "presets/",
+    "schemas/",
     "README-npmjs.md"
   ],
   "publishConfig": {
@@ -52,6 +53,7 @@
     "@rollup/plugin-json": "^6.1.0",
     "@rollup/plugin-node-resolve": "^16.0.1",
     "@rollup/plugin-typescript": "^12.1.4",
+    "@types/ajv": "^0.0.5",
     "@types/commander": "^2.12.0",
     "@types/node": "^24.5.2",
     "fast-glob": "^3.3.3",
@@ -64,6 +66,8 @@
     "vitest": "^3.2.4"
   },
   "dependencies": {
+    "ajv": "^8.17.1",
+    "ajv-formats": "^3.0.1",
     "commander": "^14.0.0",
     "glob": "^11.0.3",
     "yaml": "^2.8.0"

package/presets/prompts/prompt-creation.yaml

@@ -0,0 +1,19 @@
+config:
+  baseDir: .github/prompts
+recipe:
+  - title: "Prompts 作成ルール"
+    out: "create_prompts.prompt.md"
+    type: "prompt"
+    filters:
+      category: "content-creation"
+    frontmatter:
+      description: "AI向けプロンプト作成のための包括的なルールとガイドライン。プロンプト工学のベストプラクティスを体系化。"
+      applyTo: "artifact/prompts/**/*.prompt.md"
+  - title: "Recipe ファイル作成ルール"
+    out: "create_recipe.prompt.md"
+    type: "prompt"
+    filters:
+      category: "instruction-generation"
+    frontmatter:
+      description: "AI-rulesプロジェクトにおけるレシピファイル作成のための包括的なガイドライン。複数のinstructionファイルを組み合わせた自動生成設定を支援。"
+      applyTo: "presets/**/*.yaml"

package/presets/prompts/todo-planning.yaml

@@ -4,7 +4,8 @@ recipe:
   - title: "TODO Plans 作成ルール"
     out: "todo_plans.prompt.md"
     type: "prompt"
-    category: "todo-planning"
-    focus: "workflow-management"
+    filters:
+      category: "todo-planning"
+      focus: "workflow-management"
     frontmatter:
       description: "プロジェクトのTODO計画を管理するためのワークフローとガイドライン"