@gandazgul/plannotator-pi-extension-compiled 0.19.17 → 0.19.27
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/README.md +40 -7
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -1,19 +1,52 @@
|
|
|
1
1
|
# @gandazgul/plannotator-pi-extension-compiled
|
|
2
2
|
|
|
3
|
-
Compiled wrapper around `@plannotator/pi-extension`
|
|
3
|
+
Compiled wrapper around `@plannotator/pi-extension` to support consumption from Deno and other environments that do not support direct TypeScript imports from npm packages.
|
|
4
4
|
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
-
|
|
8
|
-
|
|
5
|
+
## Why this exists
|
|
6
|
+
|
|
7
|
+
Deno (and some other runtimes) cannot directly import `.ts` files from within npm packages resolved via the `npm:` specifier. This package provides a pre-compiled version of the Plannotator Pi extension with patched imports for compatibility.
|
|
8
|
+
|
|
9
|
+
## Versioning Policy
|
|
10
|
+
|
|
11
|
+
This package **aligns its version numbers with the upstream `@plannotator/pi-extension` package**.
|
|
12
|
+
- If upstream is at `0.19.17`, this package will also be at `0.19.17`.
|
|
13
|
+
- A daily GitHub Action checks for new upstream releases and automatically builds/publishes an aligned version.
|
|
14
|
+
|
|
15
|
+
## Exports
|
|
16
|
+
|
|
17
|
+
- `@gandazgul/plannotator-pi-extension-compiled`: The main extension entry point.
|
|
18
|
+
- `@gandazgul/plannotator-pi-extension-compiled/server`: The plan review server implementation.
|
|
19
|
+
- `@gandazgul/plannotator-pi-extension-compiled/assets`: A module exporting `plannotatorHtml` as a string for in-process serving.
|
|
20
|
+
|
|
21
|
+
## Usage (Deno)
|
|
22
|
+
|
|
23
|
+
Add to your `deno.json`:
|
|
24
|
+
|
|
25
|
+
```json
|
|
26
|
+
{
|
|
27
|
+
"imports": {
|
|
28
|
+
"@gandazgul/plannotator-pi-extension-compiled": "npm:@gandazgul/plannotator-pi-extension-compiled@^0.19.17",
|
|
29
|
+
"@gandazgul/plannotator-pi-extension-compiled/server": "npm:@gandazgul/plannotator-pi-extension-compiled@^0.19.17/server",
|
|
30
|
+
"@gandazgul/plannotator-pi-extension-compiled/assets": "npm:@gandazgul/plannotator-pi-extension-compiled@^0.19.17/assets"
|
|
31
|
+
}
|
|
32
|
+
}
|
|
33
|
+
```
|
|
9
34
|
|
|
10
35
|
## Build
|
|
11
36
|
|
|
37
|
+
To build the project locally:
|
|
38
|
+
|
|
12
39
|
```bash
|
|
13
40
|
npm ci
|
|
14
41
|
npm run build
|
|
15
42
|
```
|
|
16
43
|
|
|
17
|
-
|
|
44
|
+
The build process uses `esbuild` to bundle the TypeScript source from `@plannotator/pi-extension` and patches Node.js built-in imports to use the `node:` prefix for Deno compatibility.
|
|
45
|
+
|
|
46
|
+
## Auto-Update Mechanism
|
|
18
47
|
|
|
19
|
-
|
|
48
|
+
This repository includes a GitHub Action ([`auto-update.yml`](.github/workflows/auto-update.yml)) that:
|
|
49
|
+
1. Runs daily at 06:00 UTC.
|
|
50
|
+
2. Checks the latest version of `@plannotator/pi-extension` on npm.
|
|
51
|
+
3. If a newer version is found, it updates `package.json`, performs a build, tags the release, and pushes to GitHub.
|
|
52
|
+
4. The tag push triggers the `npm-publish.yml` workflow to release to the npm registry.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@gandazgul/plannotator-pi-extension-compiled",
|
|
3
|
-
"version": "0.19.
|
|
3
|
+
"version": "0.19.27",
|
|
4
4
|
"description": "Compiled wrapper for @plannotator/pi-extension to support Deno consumption",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"repository": {
|
|
@@ -38,7 +38,7 @@
|
|
|
38
38
|
"@mariozechner/pi-tui": ">=0.53.0"
|
|
39
39
|
},
|
|
40
40
|
"devDependencies": {
|
|
41
|
-
"@plannotator/pi-extension": "0.19.
|
|
41
|
+
"@plannotator/pi-extension": "0.19.27",
|
|
42
42
|
"esbuild": "^0.25.0"
|
|
43
43
|
}
|
|
44
44
|
}
|