Skip to content

Commit 3a56a10

Browse files
committed
docs(index): add JSDoc comments to exported constants
Signed-off-by: leocavalcante <leo@cavalcante.dev>
1 parent d611449 commit 3a56a10

1 file changed

Lines changed: 21 additions & 0 deletions

File tree

src/index.ts

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,29 @@
1616

1717
import pkg from "../package.json"
1818

19+
/**
20+
* The plugin package name.
21+
* @example "opencode-plugin-opencoder"
22+
*/
1923
export const name = pkg.name
24+
25+
/**
26+
* The current plugin version following semver.
27+
* @example "0.1.0"
28+
*/
2029
export const version = pkg.version
30+
31+
/**
32+
* A brief description of the plugin's purpose.
33+
*/
2134
export const description = pkg.description
2235

36+
/**
37+
* List of agent identifiers installed by this plugin.
38+
* These agents are copied to ~/.config/opencode/agents/ on install.
39+
*
40+
* - `opencoder`: Main orchestrator running the Plan-Build-Commit loop
41+
* - `opencoder-planner`: Analyzes codebases and creates development plans
42+
* - `opencoder-builder`: Executes individual tasks with precision
43+
*/
2344
export const agents = ["opencoder", "opencoder-planner", "opencoder-builder"]

0 commit comments

Comments
 (0)