matterbridge-example-accessory-platform 3.0.4-dev-20260914-0dfae10 → 3.0.4-dev-20260929-efa8088

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (5) hide show
  1. package/CHANGELOG.md +19 -2
  2. package/README.md +51 -18
  3. package/dist/module.js +2 -2
  4. package/npm-shrinkwrap.json +2 -2
  5. package/package.json +1 -1
package/CHANGELOG.md CHANGED
@@ -31,14 +31,31 @@ If you like this project and find it useful, please consider giving it a star on
31
31
 
32
32
  ## [3.0.4] - Dev branch
33
33
 
34
+ ### Breaking changes
35
+
36
+ - [matterbridge]: Require matterbridge v.3.10.10 with matter v.1.6.0.
37
+
34
38
  ### Added
35
39
 
36
- - [devcontainer]: Upgrade the `Dev Container` to v.2.1.0, using the Node.js and Bun stack.
40
+ - [devcontainer]: Add [`Dev Container`](.devcontainer/README.md) v.2.2.0 with dual Node and Bun runtime support.
41
+ - [agents]: Add a [`shared setup`](.agents/README.md) for all agents: OpenAI Codex, Claude Code, GitHub Copilot and Google Gemini / Antigravity.
42
+ - [agents]: Add [`commit message instructions`](.github/commit-message-instructions.md) v.1.0.0 for the VS Code Copilot "Generate Commit Message" button (Conventional Commits).
37
43
 
38
44
  ### Changed
39
45
 
46
+ - [vscode]: Update `.vscode/settings.json` to v.1.0.13: point the Copilot "Generate Commit Message" button to `.github/commit-message-instructions.md`.
47
+ - [styleguide]: Update [`STYLEGUIDE.md`](STYLEGUIDE.md) to v.1.1.0: align it with the lint and format config and add the Commit Messages and Changelog sections.
48
+ - [scripts]: Update `scripts/clean.mjs` and `scripts/deep-clean.mjs` to v.1.3.0: log every removed path, add `--help` and `--version` and reject unknown arguments.
40
49
  - [package]: Upgrade package.
41
- - [package]: Update dependencies.
50
+ - [package]: Bump `node-ansi-logger` to v.3.3.1.
51
+ - [package]: Bump `node-persist-manager` to v.2.1.1.
52
+ - [package]: Bump `oxfmt` to v.0.71.0.
53
+ - [package]: Bump `oxlint` to v.1.86.0.
54
+ - [package]: Bump `oxlint-tsgolint` to v.7.0.2003.
55
+ - [package]: Bump `vitest` to v.5.0.2.
56
+ - [package]: Bump `@vitest/coverage-v8` to v.5.0.2.
57
+ - [package]: Bump `@types/node` to v.26.6.3.
58
+ - [package]: Bump `typescript` to v.7.0.2.
42
59
 
43
60
  <a href="https://www.buymeacoffee.com/luligugithub"><img src="https://matterbridge.io/assets/bmc-button.svg" alt="Buy me a coffee" width="80"></a>
44
61
 
package/README.md CHANGED
@@ -53,37 +53,70 @@ See also the [Style Guide](./STYLEGUIDE.md) for JSDoc, naming, and logging conve
53
53
  - **Much faster builds** — tsgo compiles the project in a fraction of the time required by the standard `tsc` build.
54
54
  - **Editor support** — use the VS Code extensions for tsgo and oxc to get the same experience in the editor.
55
55
 
56
- ## Copilot instructions
56
+ ## Shared agent instructions
57
+
58
+ All coding agents read the same guidance. [AGENTS.md](./AGENTS.md) and [.agents/](./.agents/) are the **single source of truth**; everything under `.github/`, `.claude/`, `.codex/` and `.antigravity/` are pointers and mirrors. Edit `.agents/` (or `AGENTS.md`), never the copies. See [.agents/README.md](./.agents/README.md) for the full layout.
59
+
60
+ | File | Notes |
61
+ | ----------------------------------------------- | ------------------------------------------------------------------------------------------------------------ |
62
+ | `AGENTS.md` | Main project instructions — shared by every agent |
63
+ | `.agents/README.md` | Layout and versioning of the shared instructions |
64
+ | `.agents/rules/testing.instructions.md` | Testing standards for unit tests |
65
+ | `.agents/rules/matterbridge.instructions.md` | Creating endpoints and using the single-class devices |
66
+ | `.agents/rules/plugin-frontend.instructions.md` | Serving a plugin's own frontend SPA and REST API |
67
+ | `.agents/rules/chip-tests.instructions.md` | The CHIP conformance test harness |
68
+ | `.agents/skills/verify-agent-context/SKILL.md` | Verify the agent loaded this context — `$verify-agent-context` (Codex), `/verify-agent-context` (all others) |
69
+
70
+ Content lives only in `.agents/`. The per-agent folders exist because each tool discovers rules and skills from its own hardcoded location, so they hold stubs that point back here — except where the tool reads `.agents/` natively.
71
+
72
+ | Tool | Instructions | Rules | Skills |
73
+ | ---------------------------------- | ----------------------------------------------- | ----------------------------------------------------- | --------------------------------------------------- |
74
+ | Codex | `AGENTS.md` — read natively | `.agents/rules/` — linked from `AGENTS.md`, on demand | `.agents/skills/` — native, `$verify-agent-context` |
75
+ | Copilot (VS Code and coding agent) | `.github/copilot-instructions.md` → `AGENTS.md` | stubs in `.github/instructions/` — `applyTo` globs | stub in `.github/skills/` — `/verify-agent-context` |
76
+ | Claude Code | `CLAUDE.md` imports `AGENTS.md` | stubs in `.claude/rules/` — `paths` globs | stub in `.claude/skills/` — `/verify-agent-context` |
77
+ | Gemini / Antigravity | `GEMINI.md` imports `AGENTS.md` | `.agents/rules/` — on demand | `.agents/skills/` — native, `/verify-agent-context` |
78
+
79
+ ### Copilot instructions
57
80
 
58
81
  | File | Notes |
59
82
  | ---------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
60
- | `.github/copilot-instructions.md` | Main project instructions — always loaded |
83
+ | `.github/copilot-instructions.md` | Pointer to AGENTS.md — always loaded |
61
84
  | `.github/instructions/chip-tests/chip-tests.instructions.md` | CHIP conformance test harness — scoped to CHIP test files |
62
85
  | `.github/instructions/matterbridge/matterbridge.instructions.md` | Matterbridge endpoint guide — dedicated Copilot instruction file |
63
86
  | `.github/instructions/plugin-frontend/plugin-frontend.instructions.md` | Plugin frontend SPA and custom REST API guide — scoped to frontend and plugin code |
64
- | `.github/instructions/testing/unit-tests.instructions.md` | Testing standards — scoped to `**/*.test.ts` |
87
+ | `.github/instructions/testing/testing.instructions.md` | Testing standards — scoped to `**/*.test.ts` |
88
+ | `.github/skills/verify-agent-context/SKILL.md` | Skill invocable as `/verify-agent-context` |
65
89
 
66
- ## Claude instructions
90
+ ### Claude instructions
67
91
 
68
92
  | File | Notes |
69
93
  | --------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
70
- | `CLAUDE.md` | Main project instructions — always loaded |
94
+ | `CLAUDE.md` | Pointer to AGENTS.md — always loaded |
95
+ | `.claude/settings.json` | Claude permissions: allow, ask and deny rules |
71
96
  | `.claude/rules/chip-tests/chip-tests.instructions.md` | CHIP conformance test harness — scoped to CHIP test files |
72
97
  | `.claude/rules/matterbridge/matterbridge.instructions.md` | Matterbridge endpoint guide — loaded for all contexts |
73
98
  | `.claude/rules/plugin-frontend/plugin-frontend.instructions.md` | Plugin frontend SPA and custom REST API guide — scoped to frontend and plugin code |
74
- | `.claude/rules/testing/unit-tests.instructions.md` | Testing standards — scoped to `**/*.test.ts` |
75
-
76
- ## Codex/Agents instructions
77
-
78
- | File | Notes |
79
- | ---------------------------- | ------------------------------------------------- |
80
- | `AGENTS.md` | Main project instructions |
81
- | `.agents/chip-tests.md` | CHIP conformance test harness |
82
- | `.agents/matterbridge.md` | Matterbridge endpoint guide |
83
- | `.agents/plugin-frontend.md` | Plugin frontend SPA and custom REST API guide |
84
- | `.agents/testing.md` | Testing and validation expectations |
85
- | `.codex/config.toml` | Codex project permissions, approvals, and profile |
86
- | `.codex/rules/default.rules` | Codex command allow, prompt, and deny rules |
99
+ | `.claude/rules/testing/testing.instructions.md` | Testing standards — scoped to `**/*.test.ts` |
100
+ | `.claude/skills/verify-agent-context/SKILL.md` | Skill invocable as `/verify-agent-context` |
101
+
102
+ ### Codex instructions
103
+
104
+ | File | Notes |
105
+ | ---------------------------- | ----------------------------------------------------------------- |
106
+ | `AGENTS.md` | Main project instructions — read directly, no pointer file needed |
107
+ | `.codex/config.toml` | Codex project permissions, approvals, and profile |
108
+ | `.codex/rules/default.rules` | Codex command allow, prompt, and deny rules |
109
+
110
+ Codex reads the shared rules and skills from `.agents/` directly; the skill is invoked as `$verify-agent-context`.
111
+
112
+ ### Gemini / Antigravity instructions
113
+
114
+ | File | Notes |
115
+ | ---------------------------- | ----------------------------------------------------- |
116
+ | `GEMINI.md` | Pointer to AGENTS.md — always loaded |
117
+ | `.antigravity/settings.json` | Sandboxing and permissions: allow, ask and deny rules |
118
+
119
+ The shared rules under `.agents/rules/` apply on demand for the relevant tasks, and `.agents/skills/` is discovered automatically as `/verify-agent-context`.
87
120
 
88
121
  ## Development guide
89
122
 
package/dist/module.js CHANGED
@@ -9,8 +9,8 @@ export class ExampleMatterbridgeAccessoryPlatform extends MatterbridgeAccessoryP
9
9
  coverInterval;
10
10
  constructor(matterbridge, log, config) {
11
11
  super(matterbridge, log, config);
12
- if (typeof this.verifyMatterbridgeVersion !== 'function' || !this.verifyMatterbridgeVersion('3.10.0')) {
13
- throw new Error(`This plugin requires Matterbridge version >= "3.10.0". Please update Matterbridge from ${this.matterbridge.matterbridgeVersion} to the latest version in the frontend.`);
12
+ if (typeof this.verifyMatterbridgeVersion !== 'function' || !this.verifyMatterbridgeVersion('3.10.10')) {
13
+ throw new Error(`This plugin requires Matterbridge version >= "3.10.10". Please update Matterbridge from ${this.matterbridge.matterbridgeVersion} to the latest version in the frontend.`);
14
14
  }
15
15
  this.log.info(`Initializing platform ${this.config.name}...`);
16
16
  }
package/npm-shrinkwrap.json CHANGED
@@ -1,12 +1,12 @@
1
1
  {
2
2
  "name": "matterbridge-example-accessory-platform",
3
- "version": "3.0.4-dev-20260914-0dfae10",
3
+ "version": "3.0.4-dev-20260929-efa8088",
4
4
  "lockfileVersion": 3,
5
5
  "requires": true,
6
6
  "packages": {
7
7
  "": {
8
8
  "name": "matterbridge-example-accessory-platform",
9
- "version": "3.0.4-dev-20260914-0dfae10",
9
+ "version": "3.0.4-dev-20260929-efa8088",
10
10
  "license": "Apache-2.0",
11
11
  "dependencies": {
12
12
  "node-ansi-logger": "3.3.1",
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "matterbridge-example-accessory-platform",
3
- "version": "3.0.4-dev-20260914-0dfae10",
3
+ "version": "3.0.4-dev-20260929-efa8088",
4
4
  "description": "Matterbridge accessory plugin",
5
5
  "author": "https://github.com/Luligu",
6
6
  "license": "Apache-2.0",