@aramassa/ai-rules 0.1.1-npmjs.20250910072942

package/dist/variableResolver.js

@@ -0,0 +1,190 @@
+import fs from "fs/promises";
+import path from "path";
+/**
+ * Variable resolver that handles collecting variables from multiple sources
+ * with proper priority order: CLI > recipe > .env > environment variables
+ */
+export class VariableResolver {
+    /**
+     * Resolve variables from multiple sources according to priority
+     * @param options Resolution options specifying sources
+     * @returns Merged variables with proper priority
+     */
+    async resolveVariables(options) {
+        const sources = [];
+        // Lowest priority: environment variables
+        if (options.environmentVariables !== false) {
+            sources.push(this.getEnvironmentVariables());
+        }
+        // .env file variables
+        if (options.envFile) {
+            try {
+                const envVars = await this.loadEnvFile(options.envFile);
+                sources.push(envVars);
+            }
+            catch (error) {
+                throw new Error(`Failed to load .env file '${options.envFile}': ${error instanceof Error ? error.message : String(error)}`);
+            }
+        }
+        // Recipe variables
+        if (options.recipeVariables) {
+            sources.push(options.recipeVariables);
+        }
+        // Highest priority: CLI variables
+        if (options.cliVariables) {
+            sources.push(options.cliVariables);
+        }
+        return this.mergeVariables(...sources);
+    }
+    /**
+     * Load variables from .env file
+     * @param filePath Path to .env file
+     * @returns Variables loaded from file
+     */
+    async loadEnvFile(filePath) {
+        const absolutePath = path.resolve(filePath);
+        try {
+            await fs.access(absolutePath);
+        }
+        catch {
+            throw new Error(`File not found: ${absolutePath}`);
+        }
+        const content = await fs.readFile(absolutePath, "utf-8");
+        return this.parseEnvContent(content);
+    }
+    /**
+     * Parse .env file content into variables object
+     * @param content .env file content
+     * @returns Parsed variables
+     */
+    parseEnvContent(content) {
+        const variables = {};
+        const lines = content.split('\n');
+        for (let i = 0; i < lines.length; i++) {
+            const line = lines[i].trim();
+            // Skip empty lines and comments
+            if (!line || line.startsWith('#')) {
+                continue;
+            }
+            // Parse KEY=value format
+            const match = line.match(/^([A-Z_][A-Z0-9_]*)=(.*)$/);
+            if (match) {
+                const [, key, value] = match;
+                // Remove surrounding quotes if present
+                variables[key] = this.unquoteValue(value);
+            }
+        }
+        return variables;
+    }
+    /**
+     * Remove surrounding quotes from environment variable values
+     * @param value Value to unquote
+     * @returns Unquoted value
+     */
+    unquoteValue(value) {
+        const trimmed = value.trim();
+        // Remove single or double quotes if they wrap the entire value
+        if ((trimmed.startsWith('"') && trimmed.endsWith('"')) ||
+            (trimmed.startsWith("'") && trimmed.endsWith("'"))) {
+            return trimmed.slice(1, -1);
+        }
+        return trimmed;
+    }
+    /**
+     * Get relevant environment variables (those that match template variable naming convention)
+     * @returns Environment variables that could be used as template variables
+     */
+    getEnvironmentVariables() {
+        const variables = {};
+        // System/CI environment variables to exclude from template variable display
+        const excludedPrefixes = [
+            'GITHUB_', 'RUNNER_', 'ACTIONS_', 'CI_', 'DEBIAN_', 'LANG', 'LC_', 'PWD', 'OLDPWD',
+            'SHELL', 'TERM', 'USER', 'HOME', 'LOGNAME', 'MAIL', 'PATH', 'PS1', 'PS2', 'PS4',
+            'TMPDIR', 'TMP', 'TEMP', 'HOSTNAME', 'HOSTTYPE', 'MACHTYPE', 'OSTYPE', 'DISPLAY',
+            'XDG_', 'DBUS_', 'SESSION_', 'DESKTOP_', 'GTK_', 'QT_', 'KDE_', 'GNOME_', 'WAYLAND_',
+            'SSH_', 'GPG_', 'EDITOR', 'VISUAL', 'PAGER', 'BROWSER', 'MANPATH', 'INFOPATH',
+            'DEBIAN_FRONTEND', 'APT_', 'DPKG_', 'DEB_', 'COLORTERM', 'INVOCATION_ID',
+            'JOURNAL_STREAM', 'SYSTEMD_', 'NODE_', 'NPM_', 'YARN_', 'PNPM_', 'COPILOT_',
+            'AGENT_', 'ANDROID_', 'ANT_', 'AZURE_', 'BLACKBIRD_', 'BOOTSTRAP_', 'CAROOT',
+            'CHROME_', 'CHROMEWEBDRIVER', 'CONDA', 'CPD_', 'CURL_', 'DOTNET_', 'EDGEWEBDRIVER',
+            'ENABLE_', 'FIREWALL_', 'FORCE_', 'GECKOWEBDRIVER', 'GHCUP_', 'GOROOT_', 'GRADLE_',
+            'INIT_', 'JAVA_', 'MEMORY_', 'NVM_', 'PIPX_', 'POWERSHELL_', 'REQUESTS_', 'SELENIUM_',
+            'SGX_', 'SSL_', 'SUDO_', 'SWIFT_', 'TINYPOOL_', 'VCPKG_', 'VITEST_', 'ACCEPT_',
+            'BASE_'
+        ];
+        const excludedExact = [
+            'CI', 'SHLVL', '_', 'COLOR', 'DEV', 'MODE', 'PROD', 'SSR', 'VITEST'
+        ];
+        // Only include environment variables that match the template variable naming pattern
+        // and don't appear to be system variables
+        for (const [key, value] of Object.entries(process.env)) {
+            if (/^[A-Z_][A-Z0-9_]*$/.test(key) && value !== undefined) {
+                // Skip if it matches any excluded prefix or exact name
+                const shouldExclude = excludedPrefixes.some(prefix => key.startsWith(prefix)) ||
+                    excludedExact.includes(key);
+                if (!shouldExclude) {
+                    variables[key] = value;
+                }
+            }
+        }
+        return variables;
+    }
+    /**
+     * Merge variables from multiple sources with later sources taking precedence
+     * @param sources Variable objects in order of precedence (lowest to highest)
+     * @returns Merged variables object
+     */
+    mergeVariables(...sources) {
+        return Object.assign({}, ...sources);
+    }
+    /**
+     * Parse CLI variables string in key=value format
+     * @param varsString Comma-separated key=value pairs
+     * @returns Parsed variables object
+     */
+    static parseCliVariables(varsString) {
+        const variables = {};
+        if (!varsString.trim()) {
+            return variables;
+        }
+        const pairs = varsString.split(',');
+        for (const pair of pairs) {
+            const trimmed = pair.trim();
+            if (!trimmed)
+                continue;
+            const equalIndex = trimmed.indexOf('=');
+            if (equalIndex === -1) {
+                throw new Error(`Invalid variable format: '${trimmed}'. Expected 'KEY=value' format.`);
+            }
+            const key = trimmed.substring(0, equalIndex).trim();
+            const value = trimmed.substring(equalIndex + 1).trim();
+            // Validate key format
+            if (!/^[A-Z_][A-Z0-9_]*$/.test(key)) {
+                throw new Error(`Invalid variable name: '${key}'. Variable names must start with a letter or underscore and contain only uppercase letters, numbers, and underscores.`);
+            }
+            variables[key] = value;
+        }
+        return variables;
+    }
+    /**
+     * Get variables by source for display purposes
+     * @param options Options specifying which sources to check
+     * @returns Object with variables grouped by source
+     */
+    async getVariablesBySource(options) {
+        const result = {
+            environment: this.getEnvironmentVariables(),
+            envFile: {}
+        };
+        if (options.envFile) {
+            try {
+                result.envFile = await this.loadEnvFile(options.envFile);
+            }
+            catch {
+                // Silently ignore .env file errors for display purposes
+                result.envFile = {};
+            }
+        }
+        return result;
+    }
+}

package/package.json

@@ -0,0 +1,69 @@
+{
+  "name": "@aramassa/ai-rules",
+  "version": "0.1.1-npmjs.20250910072942",
+  "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",
+    "packages/core"
+  ],
+  "main": "index.js",
+  "bin": {
+    "ai-rules": "dist/cli.js"
+  },
+  "files": [
+    "dist/",
+    "artifact/",
+    "presets/",
+    "README-npmjs.md"
+  ],
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "scripts": {
+    "start:cli": "node dist/cli.js",
+    "start:dev:cli": "tsx src/cli.ts",
+    "test": "vitest run --environment node test",
+    "test:all": "npm run test --workspaces",
+    "build": "npm run --ws build && tsc -p tsconfig.build.json",
+    "build:pkg:clean": "npm run --ws clean",
+    "clean": "npm run build:pkg:clean && rm -rf dist",
+    "root:build": "npm run build && if [ \"$NODE_ENV\" != \"test\" ]; then rollup -c && chmod +x dist/cli.js; fi"
+  },
+  "prepublishOnly": "npm run root:build",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Aramassa/ai-rules.git"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "type": "module",
+  "bugs": {
+    "url": "https://github.com/Aramassa/ai-rules/issues"
+  },
+  "homepage": "https://github.com/Aramassa/ai-rules#readme",
+  "devDependencies": {
+    "@aramassa/skel-extractor": "^0.0.1",
+    "@rollup/plugin-alias": "^5.1.1",
+    "@rollup/plugin-commonjs": "^28.0.6",
+    "@rollup/plugin-json": "^6.1.0",
+    "@rollup/plugin-node-resolve": "^16.0.1",
+    "@rollup/plugin-typescript": "^12.1.4",
+    "@types/commander": "^2.12.0",
+    "@types/node": "^24.3.0",
+    "fast-glob": "^3.3.3",
+    "gray-matter": "^4.0.3",
+    "rollup": "^4.45.0",
+    "ts-node": "^10.9.2",
+    "tslib": "^2.8.1",
+    "tsx": "^4.20.3",
+    "typescript": "^5.9.2",
+    "vitest": "^3.2.4"
+  },
+  "dependencies": {
+    "commander": "^14.0.0",
+    "glob": "^11.0.3",
+    "yaml": "^2.8.0"
+  }
+}

package/presets/README.md

@@ -0,0 +1,109 @@
+# Presets
+
+このディレクトリには、プロジェクトタイプ別の事前定義されたrecipeファイルが含まれています。
+
+## 利用可能なプリセット
+
+### `basic.yaml`
+
+すべてのプロジェクトタイプで共通して必要となる基本的なinstruction構成です。
+
+**含まれる内容:**
+
+- Communication Rules
+- Retrospective Instructions
+
+**使用方法:**
+
+```bash
+npx @aramassa/ai-rules extract --recipe presets/basic.yaml --src artifact/instructions
+```
+
+**対象プロジェクト:**
+
+- すべてのプロジェクトタイプ（言語・環境に依存しない共通ルール）
+
+### `typescript.yaml`
+
+TypeScriptプロジェクト向けの標準的なinstruction構成です。
+
+**含まれる内容:**
+
+- AI Document Generation
+- TypeScript Coding Rules
+- TypeScript / Vitest
+
+**使用方法:**
+
+```bash
+npx @aramassa/ai-rules extract --recipe presets/typescript.yaml --src artifact/instructions
+```
+
+### `infrastructure-ansible.yaml`
+
+インフラストラクチャ管理とAnsibleを使用したプロジェクト向けの設定です。
+
+**含まれる内容:**
+
+- Infrastructure General Principles
+- Ansible Infrastructure Automation
+- Infrastructure Change Planning
+
+**使用方法:**
+
+```bash
+npx @aramassa/ai-rules extract --recipe presets/infrastructure-ansible.yaml --src artifact/instructions
+```
+
+**対象プロジェクト:**
+
+- Ansibleを使用したインフラ自動化プロジェクト
+- クラウドインフラ管理プロジェクト
+- DevOps・SRE関連プロジェクト
+- 設定管理・自動化プロジェクト
+
+### `chatmodes.yaml`
+
+AI対話支援機能（chatmodes）をプロジェクトに統合するための設定です。
+
+**含まれる内容:**
+
+- Instruction Improve Chatmode - プロジェクト指示の改善支援
+- Planning Chatmode - todo_plans作成支援
+
+**使用方法:**
+
+```bash
+npx @aramassa/ai-rules extract --recipe presets/chatmodes.yaml --src artifact/chatmodes
+```
+
+**対象プロジェクト:**
+
+- ai-rulesを活用した開発プロジェクト
+- 構造化されたプランニングプロセスが必要なプロジェクト
+- 継続的なinstruction改善を行うプロジェクト
+
+## カスタムプリセットの作成
+
+新しいプリセットを作成する場合は、以下の手順で行ってください：
+
+1. 必要なinstructionファイルを `artifact/instructions/` 以下に作成
+2. YAML形式のrecipeファイルを `presets/` ディレクトリに作成
+3. このREADMEにプリセットの説明を追加
+4. テスト実行して動作確認
+
+### recipeファイル形式例
+
+```yaml
+recipe:
+  - title: "ドキュメントのタイトル"
+    frontmatter:
+      description: "説明"
+      applyTo: "適用対象パターン"
+    out: "./出力先パス"
+    type: "対象のinstructionタイプ"
+    language: "対象言語"
+    mode: "append" # オプション：既存ファイルに追記
+```
+
+詳細な仕様については、プロジェクトのメインREADMEを参照してください。

package/presets/basic.yaml

@@ -0,0 +1,14 @@
+recipe:
+  - title: Communication Rules
+    frontmatter:
+      description: |
+        These rules are for writing clear and effective communication in the project.
+    out: ./.github/copilot-instructions.md
+    type: planning,documentation
+  - title: Package Management Rules
+    frontmatter:
+      description: |
+        These rules are for managing project dependencies and packages effectively.
+    out: ./.github/copilot-instructions.md
+    mode: append
+    type: package-management

package/presets/chatmodes.yaml

@@ -0,0 +1,64 @@
+recipe:
+  - title: Instruction Improve Chatmode
+    frontmatter:
+      description: |
+        Chatmode for improving the project instructions through retrospective analysis.
+        Provides structured approach to analyzing past tasks and converting insights into GitHub issues.
+        Includes comprehensive GitHub integration tools for issue and pull request management.
+      tools:
+        [
+          "changes",
+          "create_issue",
+          "list_issues",
+          "get_issue",
+          "get_pull_request",
+          "create_pull_request",
+          "list_pull_requests",
+          "get_pull_request_comments",
+          "get_pull_request_reviews",
+          "search_issues",
+          "search_pull_requests",
+        ]
+    out: ./.github/chatmodes/Instruction Improve.chatmode.md
+    type: chatmode
+    filters:
+      chatmode: instruction-improve
+    variables:
+      INSTRUCTION_GITHUB_REPO: https://github.com/Aramassa/ai-rules
+  - title: Planning Chatmode
+    frontmatter:
+      description: |
+        Chatmode for supporting todo_plans creation with structured planning process.
+        Provides phase-based guidance for requirement clarification, technical investigation, and implementation planning.
+      tools:
+        [
+          "changes",
+          "searchResults",
+          "editFiles",
+          "search",
+          "add_issue_comment",
+          "add_sub_issue",
+          "assign_copilot_to_issue",
+          "create_issue",
+          "create_pull_request_with_copilot",
+          "get_code_scanning_alert",
+          "get_discussion",
+          "get_discussion_comments",
+          "get_issue_comments",
+          "get_pull_request",
+          "get_pull_request_diff",
+          "get_pull_request_files",
+          "list_commits",
+          "list_issues",
+          "list_pull_requests",
+          "search_code",
+          "search_issues",
+          "search_pull_requests",
+          "search_repositories",
+          "update_issue",
+          "update_pull_request",
+        ]
+    out: ./.github/chatmodes/Planning.chatmode.md
+    type: chatmode
+    filters:
+      chatmode: planning

package/presets/docs-ai.yaml

@@ -0,0 +1,7 @@
+recipe:
+  - title: Documentation for AI
+    frontmatter:
+      description: These rules are for writing clear and effective documentation for AI Coding tools.
+      applyTo: "docs-ai/**/*.md"
+    out: ./.github/instructions/docs-ai.instructions.md
+    type: documentation-ai

package/presets/infrastructure-ansible.yaml

@@ -0,0 +1,19 @@
+recipe:
+  - title: Infrastructure General Principles
+    frontmatter:
+      description: |
+        General principles and best practices for infrastructure management.
+      applyTo: "**/*"
+    out: ./.github/instructions/infrastructure.instructions.md
+    type: infrastructure
+    category: best-practices
+  - title: Ansible Infrastructure Automation
+    mode: append
+    out: ./.github/instructions/infrastructure.instructions.md
+    type: infrastructure
+    language: ansible
+  - title: Infrastructure Change Planning
+    mode: append
+    out: ./.github/instructions/infrastructure.instructions.md
+    type: infrastructure
+    category: planning

package/presets/typescript.yaml

@@ -0,0 +1,16 @@
+recipe:
+  - import: :basic
+  - import: :docs-ai
+  - title: Typescript Coding Rules
+    frontmatter:
+      description: |
+        These rules are for writing TypeScript code in the project.
+      applyTo: "**/*.ts"
+    out: ./.github/instructions/typescript.instructions.md
+    type: coding-rules
+    language: typescript
+  - title: TypeScript / Vitest
+    mode: append
+    out: ./.github/instructions/typescript.instructions.md
+    type: test
+    language: typescript