Merge pull request #2 from JUVOJustin/npm-deployment

Implement DDEV plugin with installation instructions, CI/CD workflow

Author: Justin Vogt

.github/workflows/deploy.yml

@@ -0,0 +1,55 @@
+name: Deploy
+
+on:
+  push:
+    tags:
+      - '*'
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      id-token: write
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20'
+          registry-url: 'https://registry.npmjs.org'
+
+      - name: Extract tag version
+        id: version
+        run: echo "VERSION=${GITHUB_REF#refs/tags/}" >> $GITHUB_OUTPUT
+
+      - name: Update package.json version
+        run: npm version ${{ steps.version.outputs.VERSION }} --no-git-tag-version
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Run build
+        run: npm run build
+
+      - name: Commit version update
+        run: |
+          git config --local user.email "action@github.com"
+          git config --local user.name "GitHub Action"
+          git add package.json package-lock.json
+          if git diff --staged --quiet; then
+            echo "No changes to commit"
+          else
+            git commit -m "chore: update package.json version to ${{ steps.version.outputs.VERSION }}"
+            git push
+          fi
+
+      - name: Publish to npm
+        run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

.gitignore

@@ -0,0 +1,6 @@
+node_modules/
+dist/
+*.log
+.DS_Store
+*.tsbuildinfo
+thoughts/

.npmignore

@@ -0,0 +1 @@
+tsconfig.json

README.md

@@ -12,25 +12,22 @@ DDEV Plugin for [OpenCode](https://opencode.ai) - Automatically detects DDEV ava
 - **Session Notifications**: Notifies the LLM about DDEV environment only on first bash command execution (to save tokens)
 - **Custom DDEV Logs Tool**: Provides a `ddev_logs` tool for retrieving logs from DDEV services
 
-## How to Include as Submodule
+## Installation
+Add to your opencode.json or ~/.config/opencode/opencode.json:
 
-Add this plugin to your OpenCode configuration as a Git submodule:
-
-```bash
-# Add the submodule
-git submodule add git@github.com:JUVOJustin/opencode-ddev-plugin.git plugin/ddev
-
-# Create an index.js file in the plugin root directory
-echo 'export { DDEVPlugin } from "./ddev/ddev.js";' > plugin/index.js
-
-# Commit the changes
-git add .gitmodules plugin/ddev plugin/index.js
-git commit -m "Add DDEV plugin as submodule"
+```json
+{
+  "plugin": ["opencode-ddev"]
+}
 ```
 
-## Loading the Plugin
+OpenCode auto-installs plugins on startup.
+
+### Update
+Force update to latest:
 
-To load plugins from the plugin subfolder, ensure your OpenCode configuration includes the plugin directory. The plugin will be automatically discovered and loaded.
+`rm -rf ~/.cache/opencode`
+Then restart OpenCode.
 
 ## Usage
 

ddev.ts index.tsddev.ts renamed to index.ts

@@ -1,4 +1,4 @@
-import { tool } from "@opencode-ai/plugin";
+import { tool } from "@opencode-ai/plugin/tool";
 
 /**
  * Creates a DDEV logs tool for viewing container logs

logs.ts

@@ -0,0 +1,36 @@
+{
+  "name": "opencode-ddev",
+  "version": "1.0.0",
+  "type": "module",
+  "description": "Adds context about ddev setup and improves command calling",
+  "main": "index.js",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/JUVOJustin/opencode-ddev-plugin.git"
+  },
+  "keywords": [
+    "opencode",
+    "ddev"
+  ],
+  "author": "Justin Vogt",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/JUVOJustin/opencode-ddev-plugin/issues"
+  },
+  "homepage": "https://github.com/JUVOJustin/opencode-ddev-plugin#readme",
+  "scripts": {
+    "build": "tsc",
+    "typecheck": "tsc --noEmit"
+  },
+  "peerDependencies": {
+    "@opencode-ai/plugin": "^1.0.126"
+  },
+  "devDependencies": {
+    "@opencode-ai/plugin": "^1.0.126",
+    "@types/node": "^24.10.1",
+    "typescript": "^5.9.3"
+  },
+  "dependencies": {
+    "@opencode-ai/sdk": "^1.0.126"
+  }
+}

package-lock.json

@@ -0,0 +1,26 @@
+{
+    "compilerOptions": {
+        "target": "ES2020",
+        "module": "ESNext",
+        "lib": ["ES2020"],
+        "moduleResolution": "bundler",
+        "esModuleInterop": true,
+        "declaration": true,
+        "declarationMap": true,
+        "sourceMap": true,
+        "outDir": "./dist",
+        "rootDir": "./",
+        "strict": true,
+        "skipLibCheck": true,
+        "resolveJsonModule": true,
+        "types": ["node"]
+    },
+    "include": [
+        "index.ts",
+        "logs.ts"
+    ],
+    "exclude": [
+        "node_modules",
+        "dist"
+    ]
+}