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

2026-10-29 22:55: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,18 @@
+{
+  "$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": "Warpgate's browser approval shows as a sign in dialog"
+        },
+        {
+          "type": "added",
+          "text": "Your saved password is sent to Warpgate for you"
+        }
+      ]
+    }
+  ]
+}
@@ -1,7 +0,0 @@
-# Changelog
-
-## 1.0.0
-
-First release, bundled with Termix 2.9.0.
-
-Lets you connect through a Warpgate SSH bastion. Its browser approval shows as a sign-in dialog, and your saved password is sent for you.
@@ -0,0 +1,17 @@
+# Contributing to Warpgate
+
+## 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
+
+### Host
+
+- **Warpgate Gateway:** this host connects through Warpgate
@@ -1,23 +1,36 @@
-# Warpgate
+<div align="center">

-Connect through a Warpgate SSH bastion. Its browser approval shows as a sign-in dialog and your saved password is sent for you.
+<img src="https://raw.githubusercontent.com/Termix-SSH/Termix/main/public/icon.svg" width="120" height="120" alt="Termix Logo" />
+
+<h1>Warpgate</h1>
+
+<p>Connect through a Warpgate SSH bastion</p>
+
+</div>
+
+<br />
+
+## Overview
+
+Warpgate lets you connect to hosts through a [Warpgate](https://github.com/warp-tech/warpgate) SSH bastion.
+
+<br />

 ## Features

- Connect through a [Warpgate](https://github.com/warp-tech/warpgate) SSH bastion.
- Warpgate's browser approval shows as a sign-in dialog.
- Your saved password is sent to Warpgate for you.
+- Warpgate's browser approval shows as a sign in dialog
+- Your saved password is sent to Warpgate for you

-## Settings
+<br />

-### Host
+## Support

- Warpgate Gateway: this host connects through Warpgate.
+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.

-## Development
+For discussions and questions, join the [Discord](https://discord.gg/jVQGdvHDrf) server.

-```bash
-npm run build      # build into dist/
-npm run test       # run this plugin's tests
-npm run typecheck  # type-check this plugin
-```
+<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": "warpgate",
  "name": "Warpgate",
  "version": "1.0.0",
-  "description": "Connect through a Warpgate SSH bastion. Its browser approval shows as a sign-in dialog and your saved password is sent for you.",
+  "description": "Connect through a Warpgate SSH bastion, with its browser approval shown as a sign in dialog.",
  "author": {
    "name": "Termix"
  },
-  "license": "MIT",
+  "license": "Apache-2.0",
  "repository": "https://github.com/Termix-SSH/Termix",
  "category": "Access & Security",
  "icon": "DoorOpen",
  "engine": {
-    "termix": ">=2.9.0",
+    "termix": ">=26.10.0",
    "api": "1"
  },
  "capabilities": ["auth:provide"],
@@ -7,16 +7,29 @@
    "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"
  },
  "devDependencies": {
+    "@commitlint/cli": "^21.2.2",
+    "@commitlint/config-conventional": "^21.2.0",
    "@termix/plugin-sdk": "^1.0.0",
    "@types/node": "^26.2.0",
    "@types/react": "^19.2.18",
    "@types/react-dom": "^19.2.4",
+    "husky": "^9.1.7",
+    "lint-staged": "^17.2.0",
+    "prettier": "3.9.9",
    "vitest": "^4.1.11"
  },
  "peerDependencies": {
    "@termix/plugin-sdk": "^1.0.0"
+  },
+  "lint-staged": {
+    "*.{ts,tsx,js,jsx,mjs,cjs,json,css,md}": [
+      "prettier --write"
+    ]
  }
 }