@ridit/lens 0.3.1 → 0.3.2

package/addons/README.md

@@ -1,3 +1,55 @@
-# Sample addons for Lens
-
-Paste them inside ~/.lens/addons or C:/Users/UserName/.lens/addons
+# Sample addons for Lens
+
+## These addons are generated by lens.
+
+Paste them inside ~/.lens/addons or C:/Users/UserName/.lens/addons
+
+## Addon Format
+
+Addons use `defineTool` from `@ridit/lens-sdk`:
+
+```js
+const { defineTool } = require("@ridit/lens-sdk");
+
+defineTool({
+  name: "tool-name",
+  description: "what it does",
+  safe: false,
+  permissionLabel: "label shown to user",
+  systemPromptEntry: () => `<tool-name>{}</tool-name> — description`,
+  parseInput: (body) => JSON.parse(body.trim() || "{}"),
+  summariseInput: (input) => "summary",
+  execute: async (input, ctx) => {
+    // ctx.repoPath is the current repo
+    return { kind: "text", value: "result" };
+  },
+});
+```
+
+## Available Addons
+
+### clean-cache
+Clears node_modules and bun install cache
+```xml
+<clean-cache>{}</clean-cache>
+```
+
+### generate-readme
+Creates a README.md file for the project
+```xml
+<generate-readme>{}</generate-readme>
+```
+
+### git-stats
+Shows git contributor commit counts
+```xml
+<git-stats></git-stats>
+```
+
+### run-tests
+Runs test suite or specific test files
+```xml
+<run-tests>{}</run-tests> — full suite
+<run-tests>{"file": "src/utils.test.js"}</run-tests> — specific file
+<run-tests>{"command": "node script.js"}</run-tests> — custom command
+```

package/addons/clean-cache.js

@@ -0,0 +1,48 @@
+const { defineTool } = require("@ridit/lens-sdk");
+const { execSync } = require("child_process");
+
+const isWindows = process.platform === "win32";
+
+defineTool({
+  name: "clean-cache",
+  description: "Clean node_modules and bun install cache",
+  safe: false,
+  permissionLabel: "Clean cache and node_modules",
+
+  systemPromptEntry: () =>
+    `<clean-cache>{}</clean-cache> — clean node_modules and bun cache`,
+
+  parseInput: (body) => {
+    const trimmed = body.trim();
+    if (!trimmed || trimmed === "{}") return {};
+    return JSON.parse(trimmed);
+  },
+
+  summariseInput: () => "clean cache",
+
+  execute: async (input, ctx) => {
+    const repoPath = ctx.repoPath;
+
+    try {
+      // Remove node_modules
+      if (isWindows) {
+        execSync("rmdir /s /q node_modules", { cwd: repoPath, stdio: "pipe" });
+      } else {
+        execSync("rm -rf node_modules", { cwd: repoPath, stdio: "pipe" });
+      }
+
+      // Clean bun cache
+      execSync("bun clean", { cwd: repoPath, stdio: "pipe" });
+
+      return {
+        kind: "text",
+        value: "Cache cleaned successfully! node_modules removed and bun cache cleared.",
+      };
+    } catch (err) {
+      return {
+        kind: "error",
+        value: `Failed to clean cache: ${err.message}`,
+      };
+    }
+  },
+});

package/addons/generate-readme.js

@@ -0,0 +1,67 @@
+const { defineTool } = require("@ridit/lens-sdk");
+const fs = require("fs");
+
+const readmeTemplate = `# {name}
+
+{description}
+
+## Getting Started
+
+\`\`\`bash
+bun install
+bun run dev
+\`\`\`
+
+## Features
+
+- Feature one
+- Feature two
+
+## Contributing
+
+Pull requests welcome.`;
+
+defineTool({
+  name: "generate-readme",
+  description: "Generate a README.md file for the project",
+  safe: true,
+  permissionLabel: "Generate README",
+
+  systemPromptEntry: () =>
+    `<generate-readme>{}</generate-readme> — generate a README.md`,
+
+  parseInput: (body) => {
+    const trimmed = body.trim();
+    if (!trimmed || trimmed === "{}") return {};
+    return JSON.parse(trimmed);
+  },
+
+  summariseInput: () => "generate README",
+
+  execute: async (input, ctx) => {
+    const repoPath = ctx.repoPath;
+    const pkgPath = `${repoPath}/package.json`;
+    
+    let name = "Project";
+    let description = "A brief description.";
+    
+    if (fs.existsSync(pkgPath)) {
+      try {
+        const pkg = JSON.parse(fs.readFileSync(pkgPath, "utf8"));
+        name = pkg.name || name;
+        description = pkg.description || description;
+      } catch {}
+    }
+    
+    const content = readmeTemplate
+      .replace("{name}", name)
+      .replace("{description}", description);
+    
+    fs.writeFileSync(`${repoPath}/README.md`, content);
+    
+    return {
+      kind: "text",
+      value: "README.md generated successfully!"
+    };
+  }
+});

package/addons/git-stats.js

@@ -0,0 +1,29 @@
+const { defineTool } = require("@ridit/lens-sdk");
+const { execSync } = require("child_process");
+
+defineTool({
+  name: "git-stats",
+  description: "Show git contributor stats",
+  safe: true,
+  permissionLabel: "View git stats",
+  systemPromptEntry: () => "<git-stats>{}</git-stats> — show contributor commit counts",
+  parseInput: (body) => JSON.parse(body.trim() || "{}"),
+  summariseInput: () => "git contributor stats",
+  execute: async (input, ctx) => {
+    try {
+      const output = execSync("git shortlog -sn --all", {
+        cwd: ctx.repoPath,
+        stdio: "pipe",
+      }).toString();
+      return {
+        kind: "text",
+        value: output || "No commits found",
+      };
+    } catch (err) {
+      return {
+        kind: "error",
+        value: `Failed to get git stats: ${err.message}`,
+      };
+    }
+  },
+});