@camstack/develop 0.1.35 → 0.1.37
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.
- package/CHANGELOG.md +24 -0
- package/README.md +15 -0
- package/dist/scaffold/addon.d.ts.map +1 -1
- package/dist/scaffold/addon.js +25 -1
- package/dist/scaffold/cap-stub.js +1 -1
- package/package.json +10 -3
- package/skills/camstack-addon.md +16 -0
- package/skills/camstack-docs.md +1 -1
package/CHANGELOG.md
ADDED
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# Changelog
|
|
2
|
+
|
|
3
|
+
All notable changes to this package are documented in this file.
|
|
4
|
+
|
|
5
|
+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
|
|
6
|
+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
|
7
|
+
|
|
8
|
+
## [Unreleased]
|
|
9
|
+
|
|
10
|
+
## [0.1.37] - 2026-10-27
|
|
11
|
+
|
|
12
|
+
### Added
|
|
13
|
+
|
|
14
|
+
- The published package now includes its README and CHANGELOG.
|
|
15
|
+
|
|
16
|
+
### Changed
|
|
17
|
+
|
|
18
|
+
- The camstack-addon skill explains how to write a changelog entry with changelog:add.
|
|
19
|
+
|
|
20
|
+
## [0.1.36] - 2026-10-27
|
|
21
|
+
|
|
22
|
+
### Added
|
|
23
|
+
|
|
24
|
+
- CamStack Develop: CamStack developer tooling — catalogue, scaffold, validate, and example lookup shared by the CLI and MCP server.
|
package/README.md
ADDED
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# CamStack Develop
|
|
2
|
+
|
|
3
|
+
CamStack developer tooling — catalogue, scaffold, validate, and example lookup shared by the CLI and MCP server.
|
|
4
|
+
|
|
5
|
+
<!-- readme:generated:start (derived from the manifest; edit outside this block) -->
|
|
6
|
+
|
|
7
|
+
Package `@camstack/develop` on npm.
|
|
8
|
+
|
|
9
|
+
## Requirements
|
|
10
|
+
|
|
11
|
+
- Node.js >=24.
|
|
12
|
+
|
|
13
|
+
See [CHANGELOG.md](./CHANGELOG.md) for what changed in each version.
|
|
14
|
+
|
|
15
|
+
<!-- readme:generated:end -->
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"addon.d.ts","sourceRoot":"","sources":["../../src/scaffold/addon.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,oBAAoB,EAAE,mBAAmB,EAAE,MAAM,aAAa,CAAA;AAa5E;;;;GAIG;AACH,wBAAgB,aAAa,CAAC,OAAO,EAAE,oBAAoB,GAAG,mBAAmB,
|
|
1
|
+
{"version":3,"file":"addon.d.ts","sourceRoot":"","sources":["../../src/scaffold/addon.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,oBAAoB,EAAE,mBAAmB,EAAE,MAAM,aAAa,CAAA;AAa5E;;;;GAIG;AACH,wBAAgB,aAAa,CAAC,OAAO,EAAE,oBAAoB,GAAG,mBAAmB,CA0FhF"}
|
package/dist/scaffold/addon.js
CHANGED
|
@@ -37,6 +37,8 @@ export function scaffoldAddon(options) {
|
|
|
37
37
|
};
|
|
38
38
|
const files = [
|
|
39
39
|
{ relative: 'package.json', content: renderTemplate(PACKAGE_JSON, vars) },
|
|
40
|
+
{ relative: 'README.md', content: renderTemplate(README_MD, vars) },
|
|
41
|
+
{ relative: 'CHANGELOG.md', content: CHANGELOG_MD },
|
|
40
42
|
{ relative: 'tsconfig.json', content: renderTemplate(TSCONFIG, vars) },
|
|
41
43
|
{ relative: 'vite.config.ts', content: renderTemplate(VITE_CONFIG, vars) },
|
|
42
44
|
{ relative: 'src/index.ts', content: renderTemplate(INDEX_TS, vars) },
|
|
@@ -137,7 +139,9 @@ const PACKAGE_JSON = `{
|
|
|
137
139
|
]
|
|
138
140
|
},
|
|
139
141
|
"files": [
|
|
140
|
-
"dist"
|
|
142
|
+
"dist",
|
|
143
|
+
"README.md",
|
|
144
|
+
"CHANGELOG.md"
|
|
141
145
|
],
|
|
142
146
|
"scripts": {
|
|
143
147
|
"build": "vite build",
|
|
@@ -158,6 +162,26 @@ const PACKAGE_JSON = `{
|
|
|
158
162
|
}
|
|
159
163
|
}
|
|
160
164
|
`;
|
|
165
|
+
const README_MD = `# <%= displayName %>
|
|
166
|
+
|
|
167
|
+
<%= description %>
|
|
168
|
+
|
|
169
|
+
<!-- readme:generated:start (derived from the manifest; edit outside this block) -->
|
|
170
|
+
<!-- readme:generated:end -->
|
|
171
|
+
`;
|
|
172
|
+
const CHANGELOG_MD = `# Changelog
|
|
173
|
+
|
|
174
|
+
All notable changes to this package are documented in this file.
|
|
175
|
+
|
|
176
|
+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
|
|
177
|
+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
|
178
|
+
|
|
179
|
+
## [Unreleased]
|
|
180
|
+
|
|
181
|
+
### Added
|
|
182
|
+
|
|
183
|
+
- Initial release.
|
|
184
|
+
`;
|
|
161
185
|
const TSCONFIG = `{
|
|
162
186
|
"extends": "../../tsconfig.base.json",
|
|
163
187
|
"compilerOptions": {
|
|
@@ -63,7 +63,7 @@ export type ${typeName} = InferProvider<typeof ${exportName}>
|
|
|
63
63
|
'Hand-edit packages/types/src/capabilities/index.ts (re-export + AnyCapability)',
|
|
64
64
|
'npm run codegen',
|
|
65
65
|
'Declare the cap by name in the addon manifest and implement the provider',
|
|
66
|
-
'Append ../planning/sessions/<YYYY-MM>.md (
|
|
66
|
+
'Append ../planning/sessions/<YYYY-MM>.md (private diary, not published); run npm run docs:check',
|
|
67
67
|
],
|
|
68
68
|
};
|
|
69
69
|
}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@camstack/develop",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.37",
|
|
4
4
|
"description": "CamStack developer tooling — catalogue, scaffold, validate, and example lookup shared by the CLI and MCP server.",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"camstack",
|
|
@@ -12,7 +12,12 @@
|
|
|
12
12
|
"license": "MIT",
|
|
13
13
|
"repository": {
|
|
14
14
|
"type": "git",
|
|
15
|
-
"url": "https://github.com/camstack/server"
|
|
15
|
+
"url": "https://github.com/camstack/server.git",
|
|
16
|
+
"directory": "packages/develop"
|
|
17
|
+
},
|
|
18
|
+
"homepage": "https://camstack-docs.zentik.app",
|
|
19
|
+
"bugs": {
|
|
20
|
+
"url": "https://github.com/camstack/server/issues"
|
|
16
21
|
},
|
|
17
22
|
"type": "module",
|
|
18
23
|
"main": "./dist/index.js",
|
|
@@ -32,7 +37,9 @@
|
|
|
32
37
|
},
|
|
33
38
|
"files": [
|
|
34
39
|
"dist",
|
|
35
|
-
"skills"
|
|
40
|
+
"skills",
|
|
41
|
+
"README.md",
|
|
42
|
+
"CHANGELOG.md"
|
|
36
43
|
],
|
|
37
44
|
"scripts": {
|
|
38
45
|
"build": "tsc -p tsconfig.build.json",
|
package/skills/camstack-addon.md
CHANGED
|
@@ -179,6 +179,22 @@ rest (sessions entry, an ADR for a rejected alternative, a package
|
|
|
179
179
|
`docs/addons/addon-provider-reolink.md`) follows the `camstack-docs`
|
|
180
180
|
ladder. `npm run docs:check` fails on a dead path.
|
|
181
181
|
|
|
182
|
+
**README and CHANGELOG.** Every published package carries both, and both are
|
|
183
|
+
in `files`. The README's derived block (what it provides, settings, placement,
|
|
184
|
+
requirements, docs) is written by `npm run readme:generate` from the manifest;
|
|
185
|
+
write the paragraph at the top by hand and run the command again after a
|
|
186
|
+
manifest change. A change to the package adds one line to the CHANGELOG:
|
|
187
|
+
|
|
188
|
+
```bash
|
|
189
|
+
npm run changelog:add -- <package> "<what changed for the operator>" --type fixed
|
|
190
|
+
```
|
|
191
|
+
|
|
192
|
+
One line, English, from the operator's side ("Cameras reconnect after a hub
|
|
193
|
+
restart", not "refactor reconnect loop"). `--type` is `added`, `changed`,
|
|
194
|
+
`fixed` or `removed`. The line lands under `## [Unreleased]`; the publish moves
|
|
195
|
+
it under the new version. A publish of a changed package with no entry fails
|
|
196
|
+
(`scripts/check-changelog-unreleased.ts`) and prints this command.
|
|
197
|
+
|
|
182
198
|
## 7. Ship it — and prove the new code is the code running
|
|
183
199
|
|
|
184
200
|
An addon runs from its DEPLOYED copy under `<dataDir>/addons/@camstack/<name>/`
|
package/skills/camstack-docs.md
CHANGED
|
@@ -38,7 +38,7 @@ adding one more file to one.
|
|
|
38
38
|
|
|
39
39
|
## What to write (stop at first yes)
|
|
40
40
|
|
|
41
|
-
1. Learned something expensive? →
|
|
41
|
+
1. Learned something expensive? → the session diary is private (`../planning/sessions/<YYYY-MM>.md` when this checkout has one). Include the wrong turns.
|
|
42
42
|
2. Chose between real alternatives? → new `docs/decisions/` record from
|
|
43
43
|
`template.md`. State a violable rule; put the failure in Context.
|
|
44
44
|
3. Changed how a whole subsystem behaves? → matching `docs/architecture/*.md`.
|