opencode-leetcode-realworld 0.2.0 → 0.2.2

package/README.md

@@ -1,5 +1,7 @@
 # opencode-leetcode-realworld
 
+[![npm version](https://img.shields.io/npm/v/opencode-leetcode-realworld.svg)](https://www.npmjs.com/package/opencode-leetcode-realworld)
+
 An [opencode](https://opencode.ai) plugin that turns a LeetCode problem into a
 **realistic software-engineering assignment**.
 
@@ -15,6 +17,49 @@ and a test suite. The original problem is never shown to you.
 /practice medium dynamic-programming python
 ```
 
+## Install
+
+Add the plugin to your `opencode.json` and restart opencode:
+
+```jsonc
+{
+  "$schema": "https://opencode.ai/config.json",
+  "plugin": ["opencode-leetcode-realworld"]
+}
+```
+
+That's all you have to do. **You do not run `npm install` yourself** — opencode
+reads the `plugin` list on startup and installs the package automatically with
+Bun (cached in `~/.cache/opencode/node_modules/`). Just naming it in the config is
+enough; the plugin then registers the `/practice` command on its own.
+
+Prefer not to edit the file by hand? Let opencode do it:
+
+```bash
+opencode plugin opencode-leetcode-realworld
+```
+
+Use the project `opencode.json` to enable it for one repo, or
+`~/.config/opencode/opencode.json` to enable it everywhere.
+
+Confirm it loaded:
+
+```bash
+opencode debug config   # look for a "practice" command
+```
+
+### Requirements
+
+- [opencode](https://opencode.ai) 1.x
+- Node.js 18+ — the test runner uses Node no matter which language you pick
+- The toolchain for your chosen language (see [Supported languages](#supported-languages))
+
+Then, in opencode:
+
+```
+/practice
+```
+
 ## Usage
 
 ```
@@ -104,6 +149,8 @@ they tend to produce:
 
 ```
 /practice
+   │
+   ├─ (agent)             if language/difficulty are missing, ask you via the `question` tool
    │
    ├─ leetcode_fetch      fetch a problem from the LeetCode API (private reasoning input)
    │
@@ -135,24 +182,11 @@ node tests/runner.mjs            # all cases
 node tests/runner.mjs --public   # visible cases only
 ```
 
-## Install
-
-### Local (development)
-
-Clone/copy this repo, then open opencode inside it. Files under
-`.opencode/plugins/` and `.opencode/commands/` are auto-loaded.
-
-### From npm (once published)
-
-```jsonc
-// opencode.json
-{
-  "$schema": "https://opencode.ai/config.json",
-  "plugin": ["opencode-leetcode-realworld"]
-}
-```
+## Running from source
 
-The plugin registers the `/practice` command itself, so no extra config is needed.
+For plugin development, clone the repo and open opencode inside it — files under
+`.opencode/plugins/` are auto-loaded. See [Development](#development) for the test
+and typecheck commands.
 
 ## Tools
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "opencode-leetcode-realworld",
-  "version": "0.2.0",
+  "version": "0.2.2",
   "description": "OpenCode plugin that turns a LeetCode problem into a realistic software-engineering assignment, so you practice applying the underlying algorithm instead of solving the puzzle.",
   "type": "module",
   "license": "MIT",

package/src/scaffold.ts

@@ -130,6 +130,29 @@ function edgeCaseSection(spec: ScaffoldSpec): string {
   return `## Edge cases to handle\n\n${edgeCases.map((edge) => `- ${edge}`).join("\n")}\n`;
 }
 
+function exampleSection(spec: ScaffoldSpec): string {
+  const tests = spec.publicTests ?? [];
+  if (tests.length === 0) return "";
+  const blocks = tests.slice(0, 3).map((test, index) => {
+    const input = json(test.input);
+    const output = json(test.expected);
+    return `### Example ${index + 1}: ${test.name}
+
+**Input**
+
+\`\`\`json
+${input}
+\`\`\`
+
+**Output**
+
+\`\`\`json
+${output}
+\`\`\``;
+  });
+  return `## Example input / output\n\nUse these to derive the logic.\n\n${blocks.join("\n\n")}\n`;
+}
+
 function readmeFor(names: ResolvedNames, spec: ScaffoldSpec, language: LanguageId): string {
   const adapter = getLanguage(language);
   const source = `src/solution.${adapter.extension}`;
@@ -176,6 +199,7 @@ function projectDoc(spec: ScaffoldSpec, names: ResolvedNames, language: Language
 
 ${spec.scenario.trim()}
 
+${exampleSection(spec)}
 ${requirementsSection(spec)}
 ${edgeCaseSection(spec)}
 ## Interface