[Init] Initial commit - NetMesh terminal manager

examples/plugins/hello-netcatty/README.md

@@ -0,0 +1,23 @@
+# Hello Netcatty
+
+This package is the runnable internal example for the plugin API. With
+`NETCATTY_PLUGIN_DEV=1`, package and install it to exercise native settings,
+command-palette contributions, lazy command and Provider activation,
+localization, terminal completion/decoration Providers, and the runtime SDK.
+
+From the repository root:
+
+```bash
+npm run build:plugin-packages
+npm exec -- netcatty-plugin validate examples/plugins/hello-netcatty
+npm exec -- netcatty-plugin compatibility examples/plugins/hello-netcatty --netcatty 0.0.0
+npm exec -- netcatty-plugin pack examples/plugins/hello-netcatty --out /tmp/hello-netcatty.ncpkg
+```
+
+After installation, change **Greeting** under **Settings → Plugins**, then run
+**Examples: Say Hello** from the command palette. The setting is read through
+the host settings broker and the command handler is registered inside the
+sandboxed plugin runtime. Type `netc` at a shell prompt to exercise the bounded
+completion Provider, and print `Hello from Netcatty` to exercise the declarative
+decoration Provider. Neither Provider receives raw xterm objects or sensitive
+terminal input/output streams.

examples/plugins/hello-netcatty/netcatty.plugin.json

@@ -0,0 +1,86 @@
+{
+  "$schema": "../../../packages/plugin-contract/schema/plugin-contract.schema.json",
+  "manifestVersion": 1,
+  "id": "com.netcatty.hello",
+  "name": "hello-netcatty",
+  "displayName": {
+    "en": "Hello Netcatty",
+    "zh-CN": "你好，Netcatty"
+  },
+  "description": "Minimal plugin contract and SDK example.",
+  "version": "0.1.0",
+  "publisher": "netcatty",
+  "license": "GPL-3.0-or-later",
+  "engines": {
+    "netcatty": ">=0.0.0",
+    "api": ">=0.1.0-internal <0.2.0"
+  },
+  "main": {
+    "browser": "dist/index.js"
+  },
+  "activationEvents": [
+    "onCommand:com.netcatty.hello.sayHello",
+    "onProvider:com.netcatty.hello.completion",
+    "onProvider:com.netcatty.hello.decoration",
+    "onProvider:com.netcatty.hello.theme"
+  ],
+  "permissions": {
+    "required": [
+      "commands",
+      "settings.read",
+      "menus",
+      "provider.terminal",
+      "terminal.complete",
+      "terminal.output",
+      "terminal.decorate"
+    ],
+    "optional": []
+  },
+  "contributes": {
+    "settings": [
+      {
+        "id": "com.netcatty.hello.greeting",
+        "label": "Greeting",
+        "description": "Text used by the example command.",
+        "control": "text",
+        "scope": "application",
+        "default": "Hello from Netcatty"
+      }
+    ],
+    "commands": [
+      {
+        "id": "com.netcatty.hello.sayHello",
+        "title": "Say Hello",
+        "category": "Examples"
+      }
+    ],
+    "menus": [
+      {
+        "command": "com.netcatty.hello.sayHello",
+        "location": "commandPalette",
+        "group": "examples",
+        "order": 10
+      }
+    ],
+    "providers": [
+      {
+        "id": "com.netcatty.hello.completion",
+        "label": "Hello completion",
+        "description": "Suggests the example hello command.",
+        "kind": "terminal.completion"
+      },
+      {
+        "id": "com.netcatty.hello.decoration",
+        "label": "Hello decoration",
+        "description": "Highlights the example greeting in terminal output.",
+        "kind": "terminal.decoration"
+      },
+      {
+        "id": "com.netcatty.hello.theme",
+        "label": "Hello theme",
+        "description": "Adds a subtle cursor color to the example terminal theme.",
+        "kind": "terminal.theme"
+      }
+    ]
+  }
+}

examples/plugins/hello-netcatty/package.json

@@ -0,0 +1,12 @@
+{
+  "name": "@netcatty/example-hello-plugin",
+  "version": "0.1.0",
+  "private": true,
+  "type": "module",
+  "scripts": {
+    "build": "tsc -p tsconfig.json"
+  },
+  "dependencies": {
+    "@netcatty/plugin-sdk": "0.1.0-internal"
+  }
+}

examples/plugins/hello-netcatty/src/index.ts

@@ -0,0 +1,44 @@
+import { definePlugin } from "@netcatty/plugin-sdk";
+
+export default definePlugin({
+  activate(context) {
+    context.logger.info("Hello Netcatty example activated", {
+      pluginId: context.pluginId,
+    });
+    context.subscriptions.add(context.commands.registerCommand(
+      "com.netcatty.hello.sayHello",
+      async () => {
+        const greeting = await context.settings.get<string>("com.netcatty.hello.greeting");
+        context.logger.info(greeting ?? "Hello from Netcatty");
+        return { greeting: greeting ?? "Hello from Netcatty" };
+      },
+    ));
+    context.subscriptions.add(context.providers.register(
+      "com.netcatty.hello.completion",
+      "terminal.completion",
+      ({ payload }) => {
+        const { input } = payload;
+        return input && "netcatty-hello".startsWith(input)
+          ? { items: [{ text: "netcatty-hello", score: 5_000 }] }
+          : { items: [] };
+      },
+    ));
+    context.subscriptions.add(context.providers.register(
+      "com.netcatty.hello.decoration",
+      "terminal.decoration",
+      () => ({
+        rules: [{
+          id: "greeting",
+          label: "Netcatty greeting",
+          patterns: ["\\bHello from Netcatty\\b"],
+          color: "#34D399",
+        }],
+      }),
+    ));
+    context.subscriptions.add(context.providers.register(
+      "com.netcatty.hello.theme",
+      "terminal.theme",
+      () => ({ colors: { cursor: "#34D399" } }),
+    ));
+  },
+});

examples/plugins/hello-netcatty/tsconfig.json

@@ -0,0 +1,13 @@
+{
+  "compilerOptions": {
+    "target": "ES2022",
+    "module": "NodeNext",
+    "moduleResolution": "NodeNext",
+    "strict": true,
+    "declaration": true,
+    "rootDir": "src",
+    "outDir": "dist",
+    "skipLibCheck": true
+  },
+  "include": ["src/**/*.ts"]
+}