chore: rework plugin readmes, json changelogs and standalone repo setup

2026-10-29 06:35:24 +00:00 · 2026-10-04 21:25:16 -05:00
1 parent a8f383d2b3
commit 29a946d02e
@@ -0,0 +1,21 @@
+{
+  "extends": ["@commitlint/config-conventional"],
+  "rules": {
+    "type-enum": [
+      2,
+      "always",
+      [
+        "feat",
+        "fix",
+        "docs",
+        "style",
+        "refactor",
+        "perf",
+        "test",
+        "chore",
+        "revert"
+      ]
+    ],
+    "subject-case": [0]
+  }
+}
@@ -0,0 +1 @@
+custom: https://donate.termix.site/
@@ -0,0 +1,34 @@
+# Overview
+
+_Short summary of what this PR does_
+
+- [ ] Added: ...
+- [ ] Updated: ...
+- [ ] Removed: ...
+- [ ] Fixed: ...
+
+# Changes Made
+
+_Detailed explanation of changes (if needed)_
+
+- ...
+
+# Related Issues
+
+_Link any issues this PR addresses_
+
+- Closes #ISSUE_NUMBER
+- Related to #ISSUE_NUMBER
+
+# Screenshots / Demos
+
+_(Optional: add before/after screenshots, GIFs, or console output)_
+
+# Checklist
+
+- [ ] Code follows project style guidelines
+- [ ] Supports mobile and desktop UI/app (if applicable)
+- [ ] Added the change to `CHANGELOG.json`
+- [ ] `npm run test`, `npm run typecheck` and `npm run validate` pass
+- [ ] I have read `CONTRIBUTING.md`
+- [ ] This is not a translation request. See [docs](https://docs.termix.site/translations)
@@ -0,0 +1,9 @@
+node_modules
+dist
+coverage
+*.log
+.env
+*.tmxplug
+*.tmxplug.sig
+termix-plugin-signing.key
+.termix-tables-*
@@ -0,0 +1 @@
+npx --no -- commitlint --edit "$1"
@@ -0,0 +1 @@
+npx lint-staged
@@ -0,0 +1,4 @@
+dist
+coverage
+node_modules
+package-lock.json
@@ -0,0 +1,9 @@
+{
+  "semi": true,
+  "singleQuote": false,
+  "tabWidth": 2,
+  "trailingComma": "all",
+  "printWidth": 80,
+  "arrowParens": "always",
+  "endOfLine": "lf"
+}
@@ -0,0 +1,22 @@
+{
+  "$schema": "https://raw.githubusercontent.com/Termix-SSH/Termix/main/packages/plugin-sdk/schema/changelog.schema.json",
+  "releases": [
+    {
+      "version": "1.0.0",
+      "changes": [
+        {
+          "type": "added",
+          "text": "Never sends usernames, hostnames, IP addresses or credentials"
+        },
+        {
+          "type": "added",
+          "text": "Choose what the report includes, or turn it off"
+        },
+        {
+          "type": "added",
+          "text": "Preview the exact report before it is sent"
+        }
+      ]
+    }
+  ]
+}
@@ -1,7 +0,0 @@
-# Changelog
-
-## 1.0.0
-
-First release, bundled with Termix 2.9.0.
-
-Moves the daily anonymous usage report out of Termix core. Adds platform info, feature usage counts and the list of running features, each with its own switch, a per-user opt-out, a preview of the exact report and a button to send it now.
@@ -0,0 +1,26 @@
+# Contributing to Usage Statistics
+
+## Development
+
+```bash
+npm run build      # build into dist/
+npm run test       # run this plugin's tests
+npm run typecheck  # type-check this plugin
+npm run validate   # check manifest.json
+npm run format     # format the code with Prettier
+```
+
+## Settings
+
+### Admin
+
+- **Share anonymous usage statistics:** turn the daily report on or off
+- **Include platform info, Include feature usage and Include installed features:** choose what the report includes
+
+### User
+
+- **Include my feature usage:** count which kinds of tabs you open in the report
+
+## Permissions
+
+- `telemetry.manage`: see what is sent, send it now and reset the instance ID. Only admins have it by default.
@@ -1,29 +1,37 @@
-# Usage Statistics
+<div align="center">

-Sends a small anonymous report once a day so the Termix developers can see how many instances run and which features get used.
+<img src="https://raw.githubusercontent.com/Termix-SSH/Termix/main/public/icon.svg" width="120" height="120" alt="Termix Logo" />

-## What is sent
+<h1>Usage Statistics</h1>

-Always, while it is on:
+<p>A small anonymous report that helps improve Termix</p>

- A random instance ID, the Termix version, and how many users and hosts exist.
+</div>

-Each of these has its own switch in Admin Settings > Usage Statistics:
+<br />

- Platform info: operating system, CPU architecture, Node.js version, database type, and whether Termix runs in Docker, the desktop app or as a plain server.
- Feature usage: how many times each kind of tab was opened, plus SSH logins and host connections, since the last report.
- Installed features: the ids of the running built-in features.
+## Overview

-It never sends usernames, hostnames, IP addresses, credentials or anything else that identifies you or your servers. Admins can preview the exact report before it is sent.
+Usage Statistics sends a small anonymous report once a day so the Termix developers can see how many instances are running and which features get used.

-## Turning it off
+<br />

- Admin Settings > Usage Statistics > Share anonymous usage statistics.
- Each user can leave their own feature usage out in User Profile > Usage Statistics.
- `ENABLE_TELEMETRY=false` turns it off and locks the switch. `ENABLE_TELEMETRY=true` locks it on.
+## Features

-## Environment
+- Never sends usernames, hostnames, IP addresses or credentials
+- Choose what the report includes, or turn it off
+- Preview the exact report before it is sent

- `ENABLE_TELEMETRY`: `true` or `false` overrides the admin switch.
- `POSTHOG_API_KEY`: the PostHog project key. Defaults to the Termix project.
- `POSTHOG_HOST`: the PostHog host. Defaults to `https://us.i.posthog.com`.
+<br />
+
+## Support
+
+To report a bug or request a feature, open a [support ticket](https://github.com/Termix-SSH/Support/issues/new/choose). You need to be logged in to GitHub. Please be as detailed as possible, preferably in English.
+
+For discussions and questions, join the [Discord](https://discord.gg/jVQGdvHDrf) server.
+
+<br />
+
+## License
+
+Distributed under the Apache License Version 2.0. See [LICENSE](https://github.com/Termix-SSH/Termix/blob/main/LICENSE) for more information.
@@ -2,16 +2,16 @@
  "id": "telemetry",
  "name": "Usage Statistics",
  "version": "1.0.0",
-  "description": "Sends an anonymous daily summary of how Termix is used, to help decide what to work on next.",
+  "description": "Sends a small anonymous report once a day so the Termix developers can see how many instances run and which features get used.",
  "author": {
    "name": "Termix"
  },
-  "license": "MIT",
+  "license": "Apache-2.0",
  "repository": "https://github.com/Termix-SSH/Termix",
  "category": "Monitoring",
  "icon": "ChartNoAxesColumn",
  "engine": {
-    "termix": ">=2.9.0",
+    "termix": ">=26.10.0",
    "api": "1"
  },
  "capabilities": [
@@ -7,19 +7,27 @@
    "build": "termix-plugin build",
    "test": "termix-plugin test",
    "typecheck": "tsc -p .",
-    "validate": "termix-plugin validate"
+    "validate": "termix-plugin validate",
+    "format": "prettier --write .",
+    "format:check": "prettier --check .",
+    "prepare": "husky || true"
  },
  "dependencies": {
    "drizzle-orm": "^0.45.2"
  },
  "devDependencies": {
+    "@commitlint/cli": "^21.2.2",
+    "@commitlint/config-conventional": "^21.2.0",
    "@termix/plugin-sdk": "^1.0.0",
    "@testing-library/dom": "^10.4.2",
    "@testing-library/react": "^16.3.3",
    "@types/node": "^26.2.0",
    "@types/react": "^19.2.18",
    "@types/react-dom": "^19.2.4",
+    "husky": "^9.1.7",
    "jsdom": "^30.0.1",
+    "lint-staged": "^17.2.0",
+    "prettier": "3.9.9",
    "vitest": "^4.1.11"
  },
  "peerDependencies": {
@@ -27,5 +35,10 @@
    "express": "^5.2.1",
    "react": "^19.2.8",
    "sonner": "^2.0.8"
+  },
+  "lint-staged": {
+    "*.{ts,tsx,js,jsx,mjs,cjs,json,css,md}": [
+      "prettier --write"
+    ]
  }
 }