@omnidev-ai/core 0.9.0 → 0.10.1

package/src/templates/capability.ts

@@ -0,0 +1,167 @@
+/**
+ * Templates for bootstrapping new capabilities.
+ */
+
+export interface CapabilityTemplateOptions {
+	id: string;
+	name: string;
+	description?: string;
+}
+
+/**
+ * Generate a capability.toml file for a new capability.
+ */
+export function generateCapabilityToml(options: CapabilityTemplateOptions): string {
+	const description = options.description || "TODO: Add a description for your capability";
+	return `[capability]
+id = "${options.id}"
+name = "${options.name}"
+version = "0.1.0"
+description = "${description}"
+
+# Optional author information
+# [capability.author]
+# name = "Your Name"
+# email = "you@example.com"
+
+# Optional metadata
+# [capability.metadata]
+# repository = "https://github.com/user/repo"
+# license = "MIT"
+`;
+}
+
+/**
+ * Generate a SKILL.md template file.
+ */
+export function generateSkillTemplate(skillName: string): string {
+	return `---
+name: ${skillName}
+description: TODO: Add a description for this skill
+---
+
+## What I do
+
+<!-- Describe what this skill helps the AI agent accomplish -->
+- TODO: List the main capabilities of this skill
+
+## When to use me
+
+<!-- Describe scenarios when this skill should be invoked -->
+Use this skill when you need to:
+- TODO: Add trigger conditions
+
+## Implementation
+
+<!-- Add detailed instructions for the AI agent -->
+### Steps
+
+1. TODO: Add implementation steps
+2. Validate inputs and outputs
+3. Report results to the user
+
+## Examples
+
+<!-- Optional: Add examples of how this skill should be used -->
+\`\`\`
+TODO: Add example usage
+\`\`\`
+`;
+}
+
+/**
+ * Generate a rule markdown template file.
+ */
+export function generateRuleTemplate(ruleName: string): string {
+	return `# ${formatDisplayName(ruleName)}
+
+<!-- Rules are guidelines that the AI agent should follow when working in this project -->
+
+## Overview
+
+TODO: Describe what this rule enforces or guides.
+
+## Guidelines
+
+- TODO: Add specific guidelines the AI should follow
+- Be specific and actionable
+- Include examples where helpful
+
+## Examples
+
+### Good
+
+\`\`\`
+TODO: Add example of correct behavior
+\`\`\`
+
+### Bad
+
+\`\`\`
+TODO: Add example of incorrect behavior
+\`\`\`
+`;
+}
+
+/**
+ * Generate a hooks.toml template file.
+ */
+export function generateHooksTemplate(): string {
+	return `# Hook configuration for this capability
+# See: https://omnidev.dev/docs/advanced/hooks
+
+# Example: Validate bash commands before execution
+# [[PreToolUse]]
+# matcher = "Bash"
+# [[PreToolUse.hooks]]
+# type = "command"
+# command = "\${OMNIDEV_CAPABILITY_ROOT}/hooks/validate-bash.sh"
+# timeout = 30
+
+# Example: Run linter after file edits
+# [[PostToolUse]]
+# matcher = "Write|Edit"
+# [[PostToolUse.hooks]]
+# type = "command"
+# command = "\${OMNIDEV_CAPABILITY_ROOT}/hooks/run-linter.sh"
+
+# Example: Load context at session start
+# [[SessionStart]]
+# matcher = "startup|resume"
+# [[SessionStart.hooks]]
+# type = "command"
+# command = "\${OMNIDEV_CAPABILITY_ROOT}/hooks/load-context.sh"
+`;
+}
+
+/**
+ * Generate a sample hook script.
+ */
+export function generateHookScript(): string {
+	return `#!/bin/bash
+# Sample hook script
+# This script receives JSON input via stdin
+
+# Read JSON input from stdin
+INPUT=$(cat)
+
+# Example: Extract tool information
+# TOOL_NAME=$(echo "$INPUT" | jq -r '.tool_name')
+# COMMAND=$(echo "$INPUT" | jq -r '.tool_input.command // empty')
+
+# Add your validation logic here
+# Exit 0 to allow, exit 2 to block
+
+exit 0
+`;
+}
+
+/**
+ * Convert kebab-case to Title Case for display.
+ */
+function formatDisplayName(kebabCase: string): string {
+	return kebabCase
+		.split("-")
+		.map((word) => word.charAt(0).toUpperCase() + word.slice(1))
+		.join(" ");
+}

package/src/templates/claude.ts

@@ -1,6 +1,6 @@
 /**
  * Template for CLAUDE.md (Claude provider)
- * Creates a minimal file with reference to OmniDev instructions
+ * Creates a minimal file - actual content is generated during sync from OMNI.md + instructions
  */
 export function generateClaudeTemplate(): string {
 	return `# Project Instructions
@@ -9,49 +9,6 @@ export function generateClaudeTemplate(): string {
 
 ## OmniDev
 
-@import .omni/instructions.md
-`;
-}
-
-/**
- * Template for .omni/instructions.md
- * Contains OmniDev-specific instructions and capability rules
- */
-export function generateInstructionsTemplate(): string {
-	return `# OmniDev Instructions
-
-## Project Description
-<!-- TODO: Add 2-3 sentences describing your project -->
-[Describe what this project does and its main purpose]
-
-## How OmniDev Works
-
-OmniDev manages capability content for your project. Capabilities can provide:
-
-- Skills (for agent workflows)
-- Rules (for guardrails and conventions)
-- Docs (reference material)
-- Commands and subagents (optional)
-
-Enable capabilities with:
-
-\`\`\`
-omnidev capability enable <capability-id>
-\`\`\`
-
-OmniDev will automatically sync enabled capabilities into your workspace. If you want to force a refresh:
-
-\`\`\`
-omnidev sync
-\`\`\`
-
-<!-- BEGIN OMNIDEV GENERATED CONTENT - DO NOT EDIT BELOW THIS LINE -->
-<!-- This section is automatically updated by 'omnidev agents sync' -->
-
-## Capabilities
-
-No capabilities enabled yet. Run \`omnidev capability enable <name>\` to enable capabilities.
-
-<!-- END OMNIDEV GENERATED CONTENT -->
+<!-- This section is populated during sync with capability rules and docs -->
 `;
 }

package/src/types/index.ts

@@ -48,12 +48,6 @@ export interface CapabilityExports {
 	gitignore?: string[];
 }
 
-export interface EnvDeclaration {
-	required?: boolean;
-	secret?: boolean;
-	default?: string;
-}
-
 export interface SyncConfig {
 	on_sync?: string;
 }
@@ -65,7 +59,6 @@ export interface CliConfig {
 export interface CapabilityConfig {
 	capability: CapabilityMetadata;
 	exports?: CapabilityExports;
-	env?: Record<string, EnvDeclaration | Record<string, never>>;
 	mcp?: McpConfig;
 	sync?: SyncConfig;
 	cli?: CliConfig;
@@ -84,7 +77,7 @@ export interface McpToolSchema {
  *
  * - **stdio**: Local process using stdin/stdout (default)
  *   - Requires: command
- *   - Optional: args, env, cwd
+ *   - Optional: args, cwd
  *
  * - **http**: Remote HTTP server (recommended for remote servers)
  *   - Requires: url
@@ -205,10 +198,29 @@ export interface GitCapabilitySourceConfig {
 	path?: string;
 }
 
+/** Configuration for a local file-sourced capability */
+export interface FileCapabilitySourceConfig {
+	/** Source path with file:// prefix (e.g., "file://./capabilities/my-cap") */
+	source: string;
+}
+
 /** Combined type for all capability source configurations */
 export type CapabilitySourceConfig =
-	| string // shorthand: "github:user/repo"
-	| GitCapabilitySourceConfig;
+	| string // shorthand: "github:user/repo" or "file://./path"
+	| GitCapabilitySourceConfig
+	| FileCapabilitySourceConfig;
+
+/**
+ * Type guard to check if a source config is a FileCapabilitySourceConfig
+ */
+export function isFileSourceConfig(
+	config: CapabilitySourceConfig,
+): config is FileCapabilitySourceConfig {
+	if (typeof config === "string") {
+		return config.startsWith("file://");
+	}
+	return config.source.startsWith("file://");
+}
 
 /** Lock file entry for a capability (version tracking) */
 export interface CapabilityLockEntry {
@@ -250,7 +262,6 @@ export interface OmniConfig {
 	project?: string;
 	active_profile?: string;
 	always_enabled_capabilities?: string[];
-	env?: Record<string, string>;
 	profiles?: Record<string, ProfileConfig>;
 	providers?: {
 		enabled?: Provider[];
@@ -319,8 +330,8 @@ export interface SyncBundle {
 	subagents: Subagent[];
 	/** Merged hooks from all capabilities */
 	hooks?: HooksConfig;
-	instructionsPath: string; // usually .omni/instructions.md
-	instructionsContent: string; // generated by core
+	/** Generated instructions content from rules and docs, embedded directly into provider files */
+	instructionsContent: string;
 }
 
 export interface ProviderContext {

package/src/config/env.ts

@@ -1,97 +0,0 @@
-import { existsSync } from "node:fs";
-import { readFile } from "node:fs/promises";
-import type { EnvDeclaration } from "../types";
-
-const ENV_FILE = ".omni/.env";
-
-/**
- * Load environment variables from .omni/.env file and merge with process.env.
- * Process environment variables take precedence over file values.
- *
- * @returns Merged environment variables
- */
-export async function loadEnvironment(): Promise<Record<string, string>> {
-	const env: Record<string, string> = {};
-
-	// Load from .omni/.env
-	if (existsSync(ENV_FILE)) {
-		const content = await readFile(ENV_FILE, "utf-8");
-		for (const line of content.split("\n")) {
-			const trimmed = line.trim();
-			// Skip empty lines and comments
-			if (trimmed && !trimmed.startsWith("#")) {
-				const eqIndex = trimmed.indexOf("=");
-				if (eqIndex > 0) {
-					const key = trimmed.slice(0, eqIndex).trim();
-					const value = trimmed.slice(eqIndex + 1).trim();
-					// Remove quotes if present
-					const unquotedValue =
-						(value.startsWith('"') && value.endsWith('"')) ||
-						(value.startsWith("'") && value.endsWith("'"))
-							? value.slice(1, -1)
-							: value;
-					env[key] = unquotedValue;
-				}
-			}
-		}
-	}
-
-	// Process env takes precedence - filter out undefined values
-	const processEnv: Record<string, string> = {};
-	for (const [key, value] of Object.entries(process.env)) {
-		if (value !== undefined) {
-			processEnv[key] = value;
-		}
-	}
-
-	return { ...env, ...processEnv };
-}
-
-/**
- * Validate that all required environment variables are present.
- * Checks declarations from capability config and throws descriptive errors for missing vars.
- *
- * @param declarations - Environment variable declarations from capability.toml
- * @param env - Loaded environment variables
- * @param capabilityId - ID of the capability being validated
- * @throws Error if required environment variables are missing
- */
-export function validateEnv(
-	declarations: Record<string, EnvDeclaration | Record<string, never>>,
-	env: Record<string, string | undefined>,
-	capabilityId: string,
-): void {
-	const missing: string[] = [];
-
-	for (const [key, decl] of Object.entries(declarations)) {
-		const declaration = decl as EnvDeclaration;
-		const value = env[key] ?? declaration.default;
-
-		if (declaration.required && !value) {
-			missing.push(key);
-		}
-	}
-
-	if (missing.length > 0) {
-		throw new Error(
-			`Missing required environment variable${missing.length > 1 ? "s" : ""} for capability "${capabilityId}": ${missing.join(", ")}. ` +
-				`Set ${missing.length > 1 ? "them" : "it"} in .omni/.env or as environment variable${missing.length > 1 ? "s" : ""}.`,
-		);
-	}
-}
-
-/**
- * Check if an environment variable should be treated as a secret.
- * Secrets should be masked in logs and error messages.
- *
- * @param key - Environment variable name
- * @param declarations - Environment variable declarations from capability.toml
- * @returns true if the variable is marked as secret
- */
-export function isSecretEnvVar(
-	key: string,
-	declarations: Record<string, EnvDeclaration | Record<string, never>>,
-): boolean {
-	const decl = declarations[key] as EnvDeclaration | undefined;
-	return decl?.secret === true;
-}