Skip to main content

Project layout

manifest.json what the plugin is, adds and may do
package.json npm scripts and dependencies
CHANGELOG.md release notes, one section per version
README.md the repo front page
docs/
index.md the plugin's docs page
src/
backend/
index.ts activate(ctx), run in the Termix server
tables.ts table definitions
routes.ts HTTP routes
frontend/
index.tsx activate(app), run in the browser
locales/
en.json every string the plugin shows
translated/ other languages, like de_DE.json (optional)
migrations/
sqlite/ postgres/ mysql/
snapshot.json what the last migration knew about
tests/
backend/ frontend/
vitest.config.ts

manifest.json​

The plugin's contract with Termix. Termix reads it without running any plugin code, so it can show what a plugin does before anyone installs it. See manifest.

src/backend/index.ts​

Exports activate(ctx) and, if you need it, deactivate(). ctx is everything your backend can use. See backend.

A plugin without a backend can leave it out, but most have one.

src/frontend/index.tsx​

Exports activate(app). app is how you add things to the UI. See frontend.

locales/en.json​

Every string the plugin shows, in English. Keys are looked up in the plugin's own namespace, so tab.title in your manifest means tab.title in this file. See translations.

migrations/​

SQL for SQLite, PostgreSQL and MySQL, made by npm run migrations from src/backend/tables.ts. Never edit one that has shipped. See database.

docs/​

Your docs. docs/index.md is the page people see first. See writing docs.

dist/​

What npm run build makes. The release packs it into a .tmxplug.

npm scripts​

ScriptWhat it runs
npm run buildtermix-plugin build, bundles into dist/.
npm testtermix-plugin test, runs your tests.
npm run typechecktsc, type checks.
npm run validatetermix-plugin validate, checks the manifest and files.
npm run migrationstermix-plugin migrations, writes migrations.
npm run packtermix-plugin pack, writes the .tmxplug.

See the CLI reference for every command.