Skip to content

Commit 68b71b8

Browse files
docs(plugin): remove the unused TypeScript plugin package (#739)
Co-authored-by: Cursor <cursoragent@cursor.com>
1 parent 123f20a commit 68b71b8

19 files changed

Lines changed: 8 additions & 1518 deletions

‎AGENTS.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ Things that break silently if you guess wrong.
6060
- **SQLite is pure Go (`modernc.org/sqlite`), not cgo**: No C toolchain needed. Setting `CGO_ENABLED=1` or switching to `mattn/go-sqlite3` breaks cross-compilation.
6161
- **Project config walks UP the directory tree**: Config files in nested directories merge with parent configs (innermost wins). Only checking the project root ignores monorepo nested configs.
6262
- **Plugin system is JSON-RPC over stdin/stdout**: Plugins are standalone Go binaries spawned as child processes, not HTTP services. `pkg/plugin/` is the public SDK.
63-
- **`packages/` is the web UI build**: Not the Go runtime. `make embed-webapp` builds `packages/app` (with `sdk`, `ui`, `plugin`, and `tinycode`). `packages/tinycode` is six helpers under `src/core/util` that the web UI imports. The old TypeScript CLI, server, session, and PTY code is gone, along with `packages/desktop`, `packages/vscode-extension`, `packages/llm`, `packages/http-recorder`, `packages/effect-drizzle-sqlite`, and `packages/script`.
63+
- **`packages/` is the web UI build**: Not the Go runtime. `make embed-webapp` builds `packages/app` (with `sdk`, `ui`, and `tinycode`). `packages/tinycode` is six helpers under `src/core/util` that the web UI imports. The old TypeScript CLI, server, session, and PTY code is gone, along with `packages/desktop`, `packages/vscode-extension`, `packages/llm`, `packages/http-recorder`, `packages/effect-drizzle-sqlite`, and `packages/script`.
6464
- **`safego.Go()` must wrap all goroutine launches**: Bare `go func()` skips panic recovery — a panic in the goroutine crashes the process with no log. `internal/safego` adds `recover()` + `slog.Error`.
6565
- **Plugin tool timeout is 30s, hook timeout is 5s**: `internal/plugin/manager.go` constants. Plugins that exceed these are killed. Changing them affects all plugins and shutdown timing.
6666
- **`config.share` defaults to `"disabled"`**: Not a working share/publish feature in Go — no `/session/{id}/share` routes; web PTY is unsupported (`PTY_SUPPORTED=false`). Do not advertise share or the in-browser terminal as working.

‎CLAUDE.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ Things that break silently if you guess wrong.
6262
- **SQLite is pure Go (`modernc.org/sqlite`), not cgo**: No C toolchain needed. Setting `CGO_ENABLED=1` or switching to `mattn/go-sqlite3` breaks cross-compilation.
6363
- **Project config walks UP the directory tree**: Config files in nested directories merge with parent configs (innermost wins). Only checking the project root ignores monorepo nested configs.
6464
- **Plugin system is JSON-RPC over stdin/stdout**: Plugins are standalone Go binaries spawned as child processes, not HTTP services. `pkg/plugin/` is the public SDK.
65-
- **`packages/` is the web UI build**: Not the Go runtime. `make embed-webapp` builds `packages/app` (with `sdk`, `ui`, `plugin`, and `tinycode`). `packages/tinycode` is six helpers under `src/core/util` that the web UI imports. The old TypeScript CLI, server, session, and PTY code is gone, along with `packages/desktop`, `packages/vscode-extension`, `packages/llm`, `packages/http-recorder`, `packages/effect-drizzle-sqlite`, and `packages/script`.
65+
- **`packages/` is the web UI build**: Not the Go runtime. `make embed-webapp` builds `packages/app` (with `sdk`, `ui`, and `tinycode`). `packages/tinycode` is six helpers under `src/core/util` that the web UI imports. The old TypeScript CLI, server, session, and PTY code is gone, along with `packages/desktop`, `packages/vscode-extension`, `packages/llm`, `packages/http-recorder`, `packages/effect-drizzle-sqlite`, and `packages/script`.
6666
- **`safego.Go()` must wrap all goroutine launches**: Bare `go func()` skips panic recovery — a panic in the goroutine crashes the process with no log. `internal/safego` adds `recover()` + `slog.Error`.
6767
- **Plugin tool timeout is 30s, hook timeout is 5s**: `internal/plugin/manager.go` constants. Plugins that exceed these are killed. Changing them affects all plugins and shutdown timing.
6868
- **`config.share` defaults to `"disabled"`**: Not a working share/publish feature in Go — no `/session/{id}/share` routes; web PTY is unsupported (`PTY_SUPPORTED=false`). Do not advertise share or the in-browser terminal as working.

‎README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -322,7 +322,7 @@ make embed-webapp # Embed SolidJS web app into the binary (builds from package
322322
make clean # Remove build artifacts
323323
```
324324

325-
The runtime is Go only. `packages/` is legacy TypeScript kept so `make embed-webapp` can build the web UI (`app`, `sdk`, `ui`, `tinycode`, and `plugin`). See [docs/building.md](docs/building.md) and [docs/spec/README.md](docs/spec/README.md).
325+
The runtime is Go only. `packages/` is legacy TypeScript kept so `make embed-webapp` can build the web UI (`app`, `sdk`, `ui`, and `tinycode`). See [docs/building.md](docs/building.md) and [docs/spec/README.md](docs/spec/README.md).
326326

327327
## Documentation
328328

‎docs/architecture.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ internal/
4343
vcs/ Git operations
4444
pkg/
4545
plugin/ Public plugin SDK (protocol, hooks, tools)
46-
packages/ Legacy TypeScript for the web UI (app, sdk, ui, tinycode, plugin)
46+
packages/ Legacy TypeScript for the web UI (app, sdk, ui, tinycode)
4747
```
4848

4949
---

‎docs/building.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
| `cmd/plugin-*/` | Optional plugin binaries (30 plugins) |
1515
| `internal/` | Private application code |
1616
| `pkg/plugin/` | Public plugin SDK |
17-
| `packages/` | **Legacy TypeScript** for the optional web UI (`app`, `sdk`, `ui`, `tinycode`, `plugin`). Not the Go runtime. No Electron app or VS Code extension. |
17+
| `packages/` | **Legacy TypeScript** for the optional web UI (`app`, `sdk`, `ui`, `tinycode`). Not the Go runtime. No Electron app or VS Code extension. |
1818

1919
Agent and contributor guidance for Go lives in the repo root: `AGENTS.md` and `CLAUDE.md`. See [spec/README.md](spec/README.md) for a full documentation index.
2020

‎docs/plugin-sdk-design.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,8 @@ Each plugin is a standalone binary. Tinycode spawns it, communicates via JSON-RP
1919

2020
## TS Plugin API Audit
2121

22+
`@tinycode/plugin` has been removed. The table is a historical audit.
23+
2224
The TS SDK (`@tinycode/plugin` v1.20.0) has 27 hook types, but real-world usage concentrates on ~8:
2325

2426
| Hook | Usage | Example |

‎docs/spec/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ Use this table as the current documentation index.
3333
| [../plugin-sdk-design.md](../plugin-sdk-design.md), [../bubbletea-tui-design.md](../bubbletea-tui-design.md) | Design notes for decisions that shipped. Keep unless you want the history gone. |
3434
| [../plugin-auth-audit.md](../plugin-auth-audit.md) | September 2026 auth snapshot. |
3535

36-
**Repository layout:** The product is the Go tree (`cmd/`, `internal/`, `pkg/`). `packages/` is legacy TypeScript kept for `make embed-webapp` (`app`, `sdk`, `ui`, `tinycode`, `plugin`). It is not the runtime. The Electron app and VS Code extension are not in the repository.
36+
**Repository layout:** The product is the Go tree (`cmd/`, `internal/`, `pkg/`). `packages/` is legacy TypeScript kept for `make embed-webapp` (`app`, `sdk`, `ui`, `tinycode`). It is not the runtime. The Electron app and VS Code extension are not in the repository.
3737

3838
**Authoritative HTTP surface:** Go route tables in [02-api-routes.md](02-api-routes.md) (and `internal/server/router.go`) are the source of truth for `tinycode serve`. `packages/sdk/openapi.json` is the historical TypeScript contract and overstates share/PTY/OAuth routes that are not implemented in Go.
3939

‎package.json‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,6 @@
9191
"@ai-sdk/provider": "4.0.0",
9292
"@ai-sdk/provider-utils": "5.0.1",
9393
"@playwright/test": "^1.63.0",
94-
"@tinycode/plugin": "workspace:*",
9594
"@tinycode/sdk": "workspace:*",
9695
"ai": "7.0.4",
9796
"diff": "9.0.0",

‎packages/plugin/.gitignore‎

Lines changed: 0 additions & 1 deletion
This file was deleted.

‎packages/plugin/package.json‎

Lines changed: 0 additions & 66 deletions
This file was deleted.

0 commit comments

Comments
 (0)