@howaboua/pi-gpt-switcher 0.1.5 → 0.1.7
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 +13 -1
- package/README.md +14 -11
- package/codex-model-shortcuts.ts +91 -3
- package/config.ts +9 -10
- package/index.ts +0 -2
- package/package.json +63 -65
- package/biome.json +0 -31
- package/changelog.ts +0 -337
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,18 @@
|
|
|
1
1
|
# @howaboua/pi-gpt-switcher
|
|
2
2
|
|
|
3
|
+
## 0.1.7
|
|
4
|
+
|
|
5
|
+
- Requires Pi 1.5 or newer.
|
|
6
|
+
|
|
7
|
+
- Removed custom changelog suppression. Updates use Pi's native notices and `collapseChangelog`.
|
|
8
|
+
|
|
9
|
+
- `/sol` and `/astra` now select GPT-6.2 Sol and Astra, including without Codex Conversion.
|
|
10
|
+
- Context defaults are now 500K for Sol, Terra and Luna, and 256K for Astra. Existing preferences are preserved.
|
|
11
|
+
|
|
12
|
+
## 0.1.6
|
|
13
|
+
|
|
14
|
+
- Added `/terra` to switch to GPT-6.1 Terra with configurable context and reasoning defaults.
|
|
15
|
+
|
|
3
16
|
## 0.1.5
|
|
4
17
|
|
|
5
18
|
- Fixed model shortcuts rejecting configured context windows above their defaults.
|
|
@@ -11,7 +24,6 @@
|
|
|
11
24
|
## 0.1.3
|
|
12
25
|
|
|
13
26
|
- GPT-6 Sol and Luna now share Astra's Codex support.
|
|
14
|
-
|
|
15
27
|
- Removed `/terra`; use `/luna` instead.
|
|
16
28
|
- Added Responses Lite, non-destructive reasoning changes and terse context guidance for GPT-6 Sol and Luna.
|
|
17
29
|
- Image descriptions now use GPT-6 Luna directly instead of preferring older mini models.
|
package/README.md
CHANGED
|
@@ -2,11 +2,12 @@
|
|
|
2
2
|
|
|
3
3
|
Pi extension adding quick model commands:
|
|
4
4
|
|
|
5
|
-
| Command
|
|
6
|
-
|
|
|
7
|
-
| `/sol [reasoning]`
|
|
8
|
-
| `/
|
|
9
|
-
| `/
|
|
5
|
+
| Command | Model |
|
|
6
|
+
| -------------------- | ---------------------------- |
|
|
7
|
+
| `/sol [reasoning]` | `openai-codex/gpt-6.2-sol` |
|
|
8
|
+
| `/terra [reasoning]` | `openai-codex/gpt-6.1-terra` |
|
|
9
|
+
| `/luna [reasoning]` | `openai-codex/gpt-6-luna` |
|
|
10
|
+
| `/astra [reasoning]` | `openai-codex/gpt-6.2-astra` |
|
|
10
11
|
|
|
11
12
|
An explicit reasoning argument overrides the configured default. Valid arguments
|
|
12
13
|
are `off`, `minimal`, `low`, `medium`, `high`, `xhigh`, and `max`; for example,
|
|
@@ -19,9 +20,10 @@ agent directory:
|
|
|
19
20
|
|
|
20
21
|
```json
|
|
21
22
|
{
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
23
|
+
"sol": { "contextWindow": 500000, "reasoning": "high" },
|
|
24
|
+
"terra": { "contextWindow": 500000, "reasoning": "high" },
|
|
25
|
+
"luna": { "contextWindow": 500000, "reasoning": "xhigh" },
|
|
26
|
+
"astra": { "contextWindow": 256000, "reasoning": "low" }
|
|
25
27
|
}
|
|
26
28
|
```
|
|
27
29
|
|
|
@@ -31,7 +33,7 @@ provider catalogue. Context windows must be safe integers of at least 128k.
|
|
|
31
33
|
Values above the shortcut's default are accepted. Set a window supported by
|
|
32
34
|
your provider; this setting changes Pi's budget, not the provider's capacity.
|
|
33
35
|
|
|
34
|
-
Existing
|
|
36
|
+
Existing context and reasoning settings are preserved. Edit existing context windows to adopt the new defaults. Omitted shortcuts use their shipped defaults, and unknown entries are ignored.
|
|
35
37
|
|
|
36
38
|
## Install
|
|
37
39
|
|
|
@@ -51,10 +53,11 @@ The commands use Pi's model registry and normal provider authentication. If a
|
|
|
51
53
|
model is unavailable or the OpenAI Codex credentials are missing, the command
|
|
52
54
|
reports that instead of changing the current model.
|
|
53
55
|
|
|
56
|
+
GPT-6.2 shortcuts work with Pi's built-in Codex provider without another extension.
|
|
57
|
+
An extension-supplied native Codex provider keeps control of its model catalogue.
|
|
58
|
+
|
|
54
59
|
Pi clamps the requested reasoning level automatically if the selected model
|
|
55
60
|
supports fewer levels.
|
|
56
|
-
GPT-6.1 Sol supports `low`, `medium`, `high`, `xhigh`, and `max`.
|
|
57
|
-
An `off` or `minimal` request is clamped to `low`.
|
|
58
61
|
|
|
59
62
|
## Local development
|
|
60
63
|
|
package/codex-model-shortcuts.ts
CHANGED
|
@@ -4,7 +4,11 @@
|
|
|
4
4
|
* model availability checks remain in charge.
|
|
5
5
|
*/
|
|
6
6
|
|
|
7
|
-
import type {
|
|
7
|
+
import type {
|
|
8
|
+
ExtensionAPI,
|
|
9
|
+
ExtensionContext,
|
|
10
|
+
ProviderModelConfig,
|
|
11
|
+
} from "@earendil-works/pi-coding-agent";
|
|
8
12
|
import {
|
|
9
13
|
ensureGptSwitcherConfig,
|
|
10
14
|
type GptSwitcherConfig,
|
|
@@ -15,13 +19,92 @@ import {
|
|
|
15
19
|
} from "./config.js";
|
|
16
20
|
|
|
17
21
|
const MODELS = {
|
|
18
|
-
sol: { id: "gpt-6.
|
|
22
|
+
sol: { id: "gpt-6.2-sol", name: "GPT-6.2 Sol" },
|
|
23
|
+
terra: { id: "gpt-6.1-terra", name: "GPT-6.1 Terra" },
|
|
19
24
|
luna: { id: "gpt-6-luna", name: "GPT-6 Luna" },
|
|
20
|
-
astra: { id: "gpt-6-astra", name: "GPT-6 Astra" },
|
|
25
|
+
astra: { id: "gpt-6.2-astra", name: "GPT-6.2 Astra" },
|
|
21
26
|
} as const;
|
|
22
27
|
|
|
23
28
|
type Alias = keyof typeof MODELS & ShortcutAlias;
|
|
24
29
|
|
|
30
|
+
const SUPPLEMENTAL_MODELS: ProviderModelConfig[] = [
|
|
31
|
+
{
|
|
32
|
+
id: "gpt-6.2-sol",
|
|
33
|
+
name: "GPT-6.2 Sol",
|
|
34
|
+
contextWindow: 500_000,
|
|
35
|
+
cost: {
|
|
36
|
+
input: 2,
|
|
37
|
+
output: 10,
|
|
38
|
+
cacheRead: 0.1,
|
|
39
|
+
cacheWrite: 2.5,
|
|
40
|
+
tiers: [
|
|
41
|
+
{
|
|
42
|
+
inputTokensAbove: 272_000,
|
|
43
|
+
input: 4,
|
|
44
|
+
output: 15,
|
|
45
|
+
cacheRead: 0.2,
|
|
46
|
+
cacheWrite: 5,
|
|
47
|
+
},
|
|
48
|
+
],
|
|
49
|
+
},
|
|
50
|
+
},
|
|
51
|
+
{
|
|
52
|
+
id: "gpt-6.2-astra",
|
|
53
|
+
name: "GPT-6.2 Astra",
|
|
54
|
+
contextWindow: 272_000,
|
|
55
|
+
cost: {
|
|
56
|
+
input: 8,
|
|
57
|
+
output: 40,
|
|
58
|
+
cacheRead: 0.4,
|
|
59
|
+
cacheWrite: 10,
|
|
60
|
+
tiers: [
|
|
61
|
+
{
|
|
62
|
+
inputTokensAbove: 272_000,
|
|
63
|
+
input: 16,
|
|
64
|
+
output: 60,
|
|
65
|
+
cacheRead: 0.8,
|
|
66
|
+
cacheWrite: 20,
|
|
67
|
+
},
|
|
68
|
+
],
|
|
69
|
+
},
|
|
70
|
+
},
|
|
71
|
+
].map((model) => ({
|
|
72
|
+
...model,
|
|
73
|
+
api: "openai-codex-responses",
|
|
74
|
+
reasoning: true,
|
|
75
|
+
input: ["text", "image"],
|
|
76
|
+
maxTokens: 128_000,
|
|
77
|
+
thinkingLevelMap: { off: null, minimal: "low", xhigh: "xhigh", max: "max" },
|
|
78
|
+
compat: {
|
|
79
|
+
supportsOpenAIGrammarTools: true,
|
|
80
|
+
supportsMidConvoSystemMessages: true,
|
|
81
|
+
supportsAdditionalTools: true,
|
|
82
|
+
supportsToolSearch: true,
|
|
83
|
+
},
|
|
84
|
+
}));
|
|
85
|
+
|
|
86
|
+
function ensureShortcutModels(
|
|
87
|
+
registry: ExtensionContext["modelRegistry"],
|
|
88
|
+
): void {
|
|
89
|
+
const missing = SUPPLEMENTAL_MODELS.filter(
|
|
90
|
+
({ id }) => !registry.find("openai-codex", id),
|
|
91
|
+
);
|
|
92
|
+
// Pi's config registration removes a native extension provider. Never replace
|
|
93
|
+
// one: its catalogue, authentication and transport remain authoritative.
|
|
94
|
+
if (!missing.length || registry.getRegisteredNativeProvider("openai-codex"))
|
|
95
|
+
return;
|
|
96
|
+
const models = [
|
|
97
|
+
...registry.getAll(),
|
|
98
|
+
...registry.getModelsOfType("image"),
|
|
99
|
+
...registry.getModelsOfType("classifier"),
|
|
100
|
+
].filter(({ provider }) => provider === "openai-codex");
|
|
101
|
+
// A config model list replaces rather than appends. Preserve the complete
|
|
102
|
+
// current catalogue and all existing auth/stream configuration.
|
|
103
|
+
registry.registerProvider("openai-codex", {
|
|
104
|
+
models: [...models, ...missing],
|
|
105
|
+
});
|
|
106
|
+
}
|
|
107
|
+
|
|
25
108
|
function parseThinkingLevel(
|
|
26
109
|
args: string,
|
|
27
110
|
defaultThinkingLevel: ThinkingLevel,
|
|
@@ -40,6 +123,10 @@ export default function (
|
|
|
40
123
|
const getConfig = options.getConfig ?? readGptSwitcherConfig;
|
|
41
124
|
if (!options.getConfig) ensureGptSwitcherConfig();
|
|
42
125
|
|
|
126
|
+
pi.on("session_start", (_event, ctx) => {
|
|
127
|
+
ensureShortcutModels(ctx.modelRegistry);
|
|
128
|
+
});
|
|
129
|
+
|
|
43
130
|
for (const alias of Object.keys(MODELS) as Alias[]) {
|
|
44
131
|
const shortcut = MODELS[alias];
|
|
45
132
|
pi.registerCommand(alias, {
|
|
@@ -56,6 +143,7 @@ export default function (
|
|
|
56
143
|
}
|
|
57
144
|
|
|
58
145
|
const modelId = shortcut.id;
|
|
146
|
+
ensureShortcutModels(ctx.modelRegistry);
|
|
59
147
|
const model = ctx.modelRegistry.find("openai-codex", modelId);
|
|
60
148
|
|
|
61
149
|
if (!model) {
|
package/config.ts
CHANGED
|
@@ -2,7 +2,7 @@ import { existsSync, mkdirSync, readFileSync, writeFileSync } from "node:fs";
|
|
|
2
2
|
import { dirname, join } from "node:path";
|
|
3
3
|
import { getAgentDir } from "@earendil-works/pi-coding-agent";
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
const SHORTCUT_ALIASES = ["sol", "terra", "luna", "astra"] as const;
|
|
6
6
|
export type ShortcutAlias = (typeof SHORTCUT_ALIASES)[number];
|
|
7
7
|
export type ThinkingLevel =
|
|
8
8
|
| "off"
|
|
@@ -23,17 +23,18 @@ export const THINKING_LEVELS = new Set<ThinkingLevel>([
|
|
|
23
23
|
"max",
|
|
24
24
|
]);
|
|
25
25
|
|
|
26
|
-
|
|
26
|
+
type ShortcutDefaults = {
|
|
27
27
|
contextWindow: number;
|
|
28
28
|
reasoning: ThinkingLevel;
|
|
29
29
|
};
|
|
30
30
|
|
|
31
31
|
export type GptSwitcherConfig = Record<ShortcutAlias, ShortcutDefaults>;
|
|
32
32
|
|
|
33
|
-
|
|
34
|
-
sol: { contextWindow:
|
|
35
|
-
|
|
36
|
-
|
|
33
|
+
const DEFAULT_GPT_SWITCHER_CONFIG: GptSwitcherConfig = {
|
|
34
|
+
sol: { contextWindow: 500_000, reasoning: "high" },
|
|
35
|
+
terra: { contextWindow: 500_000, reasoning: "high" },
|
|
36
|
+
luna: { contextWindow: 500_000, reasoning: "xhigh" },
|
|
37
|
+
astra: { contextWindow: 256_000, reasoning: "low" },
|
|
37
38
|
};
|
|
38
39
|
|
|
39
40
|
const CONFIG_BASENAME = "pi-gpt-switcher.json";
|
|
@@ -82,7 +83,7 @@ function normalizeReasoning(
|
|
|
82
83
|
return fallback;
|
|
83
84
|
}
|
|
84
85
|
|
|
85
|
-
|
|
86
|
+
function normalizeGptSwitcherConfig(value: unknown): GptSwitcherConfig {
|
|
86
87
|
if (!isObject(value)) {
|
|
87
88
|
configurationError("configuration must be a JSON object; using defaults");
|
|
88
89
|
return structuredClone(DEFAULT_GPT_SWITCHER_CONFIG);
|
|
@@ -116,9 +117,7 @@ export function normalizeGptSwitcherConfig(value: unknown): GptSwitcherConfig {
|
|
|
116
117
|
) as GptSwitcherConfig;
|
|
117
118
|
}
|
|
118
119
|
|
|
119
|
-
|
|
120
|
-
agentDir: string = getAgentDir(),
|
|
121
|
-
): string {
|
|
120
|
+
function getGptSwitcherConfigPath(agentDir: string = getAgentDir()): string {
|
|
122
121
|
return join(agentDir, CONFIG_BASENAME);
|
|
123
122
|
}
|
|
124
123
|
|
package/index.ts
CHANGED
|
@@ -1,13 +1,11 @@
|
|
|
1
1
|
/** Pi package entry point for the Codex model shortcut extension. */
|
|
2
2
|
|
|
3
3
|
import type { ExtensionAPI } from "@earendil-works/pi-coding-agent";
|
|
4
|
-
import registerPackageChangelog from "./changelog.js";
|
|
5
4
|
import registerCodexModelShortcuts from "./codex-model-shortcuts.js";
|
|
6
5
|
|
|
7
6
|
export default function gptSwitcher(
|
|
8
7
|
pi: ExtensionAPI,
|
|
9
8
|
options: Parameters<typeof registerCodexModelShortcuts>[1] = {},
|
|
10
9
|
): void {
|
|
11
|
-
registerPackageChangelog(pi);
|
|
12
10
|
registerCodexModelShortcuts(pi, options);
|
|
13
11
|
}
|
package/package.json
CHANGED
|
@@ -1,67 +1,65 @@
|
|
|
1
1
|
{
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
"main": "index.ts",
|
|
66
|
-
"exports": "./index.ts"
|
|
2
|
+
"name": "@howaboua/pi-gpt-switcher",
|
|
3
|
+
"version": "0.1.7",
|
|
4
|
+
"description": "Quick Pi commands for switching between GPT Codex models and reasoning levels.",
|
|
5
|
+
"type": "module",
|
|
6
|
+
"license": "MIT",
|
|
7
|
+
"author": "Igor Warzocha",
|
|
8
|
+
"repository": {
|
|
9
|
+
"type": "git",
|
|
10
|
+
"url": "git+https://github.com/IgorWarzocha/howaboua-pi-stuff.git",
|
|
11
|
+
"directory": "packages/pi-gpt-switcher"
|
|
12
|
+
},
|
|
13
|
+
"bugs": {
|
|
14
|
+
"url": "https://github.com/IgorWarzocha/howaboua-pi-stuff/issues"
|
|
15
|
+
},
|
|
16
|
+
"homepage": "https://github.com/IgorWarzocha/howaboua-pi-stuff/tree/main/packages/pi-gpt-switcher#readme",
|
|
17
|
+
"keywords": [
|
|
18
|
+
"pi-package",
|
|
19
|
+
"pi-extension",
|
|
20
|
+
"pi-coding-agent",
|
|
21
|
+
"gpt-6",
|
|
22
|
+
"model-switching",
|
|
23
|
+
"reasoning-level"
|
|
24
|
+
],
|
|
25
|
+
"engines": {
|
|
26
|
+
"node": ">=20.6.0"
|
|
27
|
+
},
|
|
28
|
+
"publishConfig": {
|
|
29
|
+
"access": "public"
|
|
30
|
+
},
|
|
31
|
+
"files": [
|
|
32
|
+
"index.ts",
|
|
33
|
+
"codex-model-shortcuts.ts",
|
|
34
|
+
"config.ts",
|
|
35
|
+
"README.md",
|
|
36
|
+
"LICENSE",
|
|
37
|
+
"tsconfig.json",
|
|
38
|
+
"CHANGELOG.md"
|
|
39
|
+
],
|
|
40
|
+
"pi": {
|
|
41
|
+
"extensions": [
|
|
42
|
+
"./index.ts"
|
|
43
|
+
]
|
|
44
|
+
},
|
|
45
|
+
"peerDependencies": {
|
|
46
|
+
"@earendil-works/pi-coding-agent": ">=1.5.0",
|
|
47
|
+
"@earendil-works/pi-tui": ">=1.0.0"
|
|
48
|
+
},
|
|
49
|
+
"devDependencies": {
|
|
50
|
+
"@earendil-works/pi-coding-agent": "1.5.2",
|
|
51
|
+
"typescript": "^7.0.2",
|
|
52
|
+
"oxfmt": "^0.78.0"
|
|
53
|
+
},
|
|
54
|
+
"scripts": {
|
|
55
|
+
"check": "bun run lint && bun run typecheck",
|
|
56
|
+
"prepack": "bun run check",
|
|
57
|
+
"typecheck": "tsrs --noEmit",
|
|
58
|
+
"lint": "bun run format:check && oxlint --type-aware",
|
|
59
|
+
"format": "oxfmt --write '**/*.{js,cjs,mjs,jsx,ts,cts,mts,tsx,json,jsonc,json5,css}'",
|
|
60
|
+
"pack:dry": "npm pack --dry-run",
|
|
61
|
+
"format:check": "oxfmt --check '**/*.{js,cjs,mjs,jsx,ts,cts,mts,tsx,json,jsonc,json5,css}'"
|
|
62
|
+
},
|
|
63
|
+
"main": "index.ts",
|
|
64
|
+
"exports": "./index.ts"
|
|
67
65
|
}
|
package/biome.json
DELETED
|
@@ -1,31 +0,0 @@
|
|
|
1
|
-
{
|
|
2
|
-
"$schema": "https://biomejs.dev/schemas/2.5.10/schema.json",
|
|
3
|
-
"vcs": {
|
|
4
|
-
"enabled": true,
|
|
5
|
-
"clientKind": "git",
|
|
6
|
-
"useIgnoreFile": true
|
|
7
|
-
},
|
|
8
|
-
"files": {
|
|
9
|
-
"includes": [
|
|
10
|
-
"**",
|
|
11
|
-
"!node_modules",
|
|
12
|
-
"!dist",
|
|
13
|
-
"!coverage",
|
|
14
|
-
"!package-lock.json"
|
|
15
|
-
]
|
|
16
|
-
},
|
|
17
|
-
"formatter": {
|
|
18
|
-
"enabled": true,
|
|
19
|
-
"indentStyle": "tab"
|
|
20
|
-
},
|
|
21
|
-
"linter": {
|
|
22
|
-
"enabled": false
|
|
23
|
-
},
|
|
24
|
-
"javascript": {
|
|
25
|
-
"formatter": {
|
|
26
|
-
"quoteStyle": "double",
|
|
27
|
-
"semicolons": "always",
|
|
28
|
-
"trailingCommas": "all"
|
|
29
|
-
}
|
|
30
|
-
}
|
|
31
|
-
}
|
package/changelog.ts
DELETED
|
@@ -1,337 +0,0 @@
|
|
|
1
|
-
// Generated extension packages copy this file during changelog:extensions.
|
|
2
|
-
|
|
3
|
-
import { randomUUID } from "node:crypto";
|
|
4
|
-
import { readFileSync } from "node:fs";
|
|
5
|
-
import { mkdir, readFile, rename, rm, stat, writeFile } from "node:fs/promises";
|
|
6
|
-
import { dirname, join } from "node:path";
|
|
7
|
-
import { fileURLToPath } from "node:url";
|
|
8
|
-
import {
|
|
9
|
-
DynamicBorder,
|
|
10
|
-
type ExtensionAPI,
|
|
11
|
-
getAgentDir,
|
|
12
|
-
getMarkdownTheme,
|
|
13
|
-
} from "@earendil-works/pi-coding-agent";
|
|
14
|
-
import { Container, Markdown, Spacer, Text } from "@earendil-works/pi-tui";
|
|
15
|
-
|
|
16
|
-
const ENTRY_TYPE = "@howaboua/pi-stuff/changelog";
|
|
17
|
-
const REGISTRATION_CHANNEL = "@howaboua/pi-stuff/changelog/register/v1";
|
|
18
|
-
const STATE_FILENAME = "howaboua-pi-stuff-changelog.json";
|
|
19
|
-
const SUPPRESS_KEY = "suppress";
|
|
20
|
-
const LOCK_STALE_MS = 30_000;
|
|
21
|
-
const LOCK_TIMEOUT_MS = 2_000;
|
|
22
|
-
|
|
23
|
-
interface PackageMetadata {
|
|
24
|
-
name: string;
|
|
25
|
-
version: string;
|
|
26
|
-
}
|
|
27
|
-
|
|
28
|
-
interface PackageRegistration extends PackageMetadata {
|
|
29
|
-
changelogPath: string;
|
|
30
|
-
}
|
|
31
|
-
|
|
32
|
-
interface RegistrationEvent {
|
|
33
|
-
accept: () => void;
|
|
34
|
-
registration: PackageRegistration;
|
|
35
|
-
}
|
|
36
|
-
|
|
37
|
-
interface ChangelogEntry {
|
|
38
|
-
content: string;
|
|
39
|
-
version: string;
|
|
40
|
-
}
|
|
41
|
-
|
|
42
|
-
interface ChangelogEntryData {
|
|
43
|
-
markdown: string;
|
|
44
|
-
}
|
|
45
|
-
|
|
46
|
-
type ChangelogState = Record<string, boolean | string>;
|
|
47
|
-
|
|
48
|
-
function packageRegistration(): PackageRegistration {
|
|
49
|
-
const packageDirectory = fileURLToPath(new URL(".", import.meta.url));
|
|
50
|
-
const metadata = JSON.parse(
|
|
51
|
-
readFileSync(join(packageDirectory, "package.json"), "utf8"),
|
|
52
|
-
) as Partial<PackageMetadata>;
|
|
53
|
-
if (typeof metadata.name !== "string" || typeof metadata.version !== "string")
|
|
54
|
-
throw new Error(`Invalid package metadata in ${packageDirectory}`);
|
|
55
|
-
return {
|
|
56
|
-
name: metadata.name,
|
|
57
|
-
version: metadata.version,
|
|
58
|
-
changelogPath: join(packageDirectory, "CHANGELOG.md"),
|
|
59
|
-
};
|
|
60
|
-
}
|
|
61
|
-
|
|
62
|
-
function isRegistrationEvent(value: unknown): value is RegistrationEvent {
|
|
63
|
-
if (!value || typeof value !== "object") return false;
|
|
64
|
-
const event = value as Partial<RegistrationEvent>;
|
|
65
|
-
return (
|
|
66
|
-
typeof event.accept === "function" &&
|
|
67
|
-
typeof event.registration?.name === "string" &&
|
|
68
|
-
typeof event.registration.version === "string" &&
|
|
69
|
-
typeof event.registration.changelogPath === "string"
|
|
70
|
-
);
|
|
71
|
-
}
|
|
72
|
-
|
|
73
|
-
function parseChangelog(markdown: string): ChangelogEntry[] {
|
|
74
|
-
const entries: ChangelogEntry[] = [];
|
|
75
|
-
let currentLines: string[] = [];
|
|
76
|
-
let currentVersion: string | undefined;
|
|
77
|
-
|
|
78
|
-
for (const line of markdown.split("\n")) {
|
|
79
|
-
const version = line.match(/^##\s+\[?(\d+\.\d+\.\d+)\]?(?:\s.*)?$/)?.[1];
|
|
80
|
-
if (version) {
|
|
81
|
-
if (currentVersion)
|
|
82
|
-
entries.push({
|
|
83
|
-
content: currentLines.join("\n").trim(),
|
|
84
|
-
version: currentVersion,
|
|
85
|
-
});
|
|
86
|
-
currentVersion = version;
|
|
87
|
-
currentLines = [line];
|
|
88
|
-
} else if (currentVersion) {
|
|
89
|
-
currentLines.push(line);
|
|
90
|
-
}
|
|
91
|
-
}
|
|
92
|
-
|
|
93
|
-
if (currentVersion)
|
|
94
|
-
entries.push({
|
|
95
|
-
content: currentLines.join("\n").trim(),
|
|
96
|
-
version: currentVersion,
|
|
97
|
-
});
|
|
98
|
-
return entries;
|
|
99
|
-
}
|
|
100
|
-
|
|
101
|
-
function compareVersions(left: string, right: string): number {
|
|
102
|
-
const leftParts = left.split(".").map(Number);
|
|
103
|
-
const rightParts = right.split(".").map(Number);
|
|
104
|
-
for (let index = 0; index < 3; index++) {
|
|
105
|
-
const difference = (leftParts[index] ?? 0) - (rightParts[index] ?? 0);
|
|
106
|
-
if (difference !== 0) return difference;
|
|
107
|
-
}
|
|
108
|
-
return 0;
|
|
109
|
-
}
|
|
110
|
-
|
|
111
|
-
function isStableVersion(version: string): boolean {
|
|
112
|
-
return /^\d+\.\d+\.\d+$/.test(version);
|
|
113
|
-
}
|
|
114
|
-
|
|
115
|
-
function statePath(): string {
|
|
116
|
-
return join(getAgentDir(), STATE_FILENAME);
|
|
117
|
-
}
|
|
118
|
-
|
|
119
|
-
async function readState(path: string): Promise<ChangelogState> {
|
|
120
|
-
let text: string;
|
|
121
|
-
try {
|
|
122
|
-
text = await readFile(path, "utf8");
|
|
123
|
-
} catch (error) {
|
|
124
|
-
if ((error as NodeJS.ErrnoException).code === "ENOENT") return {};
|
|
125
|
-
throw error;
|
|
126
|
-
}
|
|
127
|
-
const parsed = JSON.parse(text) as unknown;
|
|
128
|
-
if (!parsed || typeof parsed !== "object" || Array.isArray(parsed))
|
|
129
|
-
throw new Error(`${path} must contain a JSON object`);
|
|
130
|
-
for (const [name, value] of Object.entries(parsed)) {
|
|
131
|
-
if (name === SUPPRESS_KEY) {
|
|
132
|
-
if (typeof value !== "boolean")
|
|
133
|
-
throw new Error(`${path} ${SUPPRESS_KEY} must be a boolean`);
|
|
134
|
-
} else if (typeof value !== "string") {
|
|
135
|
-
throw new Error(`${path} version for ${name} must be a string`);
|
|
136
|
-
}
|
|
137
|
-
}
|
|
138
|
-
return parsed as ChangelogState;
|
|
139
|
-
}
|
|
140
|
-
|
|
141
|
-
async function acquireLock(path: string): Promise<() => Promise<void>> {
|
|
142
|
-
const deadline = Date.now() + LOCK_TIMEOUT_MS;
|
|
143
|
-
while (true) {
|
|
144
|
-
try {
|
|
145
|
-
await mkdir(path);
|
|
146
|
-
return () => rm(path, { force: true, recursive: true });
|
|
147
|
-
} catch (error) {
|
|
148
|
-
if ((error as NodeJS.ErrnoException).code !== "EEXIST") throw error;
|
|
149
|
-
const info = await stat(path).catch(() => undefined);
|
|
150
|
-
if (info && Date.now() - info.mtimeMs > LOCK_STALE_MS) {
|
|
151
|
-
await rm(path, { force: true, recursive: true });
|
|
152
|
-
continue;
|
|
153
|
-
}
|
|
154
|
-
if (Date.now() >= deadline)
|
|
155
|
-
throw new Error(`Timed out waiting for ${path}`);
|
|
156
|
-
await new Promise((resolve) => setTimeout(resolve, 20));
|
|
157
|
-
}
|
|
158
|
-
}
|
|
159
|
-
}
|
|
160
|
-
|
|
161
|
-
async function writeState(path: string, state: ChangelogState): Promise<void> {
|
|
162
|
-
await mkdir(dirname(path), { mode: 0o700, recursive: true });
|
|
163
|
-
const temporaryPath = `${path}.${process.pid}.${randomUUID()}.tmp`;
|
|
164
|
-
try {
|
|
165
|
-
const ordered = Object.fromEntries(
|
|
166
|
-
Object.entries(state).sort(([left], [right]) =>
|
|
167
|
-
left.localeCompare(right),
|
|
168
|
-
),
|
|
169
|
-
);
|
|
170
|
-
await writeFile(temporaryPath, `${JSON.stringify(ordered, null, 2)}\n`, {
|
|
171
|
-
encoding: "utf8",
|
|
172
|
-
mode: 0o600,
|
|
173
|
-
});
|
|
174
|
-
await rename(temporaryPath, path);
|
|
175
|
-
} catch (error) {
|
|
176
|
-
await rm(temporaryPath, { force: true });
|
|
177
|
-
throw error;
|
|
178
|
-
}
|
|
179
|
-
}
|
|
180
|
-
|
|
181
|
-
function packageMarkdown(
|
|
182
|
-
registration: PackageRegistration,
|
|
183
|
-
entries: ChangelogEntry[],
|
|
184
|
-
): string {
|
|
185
|
-
const body = (entry: ChangelogEntry) =>
|
|
186
|
-
entry.content
|
|
187
|
-
.replace(/^##[^\n]*\n*/, "")
|
|
188
|
-
.replace(/^###\s+(?:Changes|Minor Changes|Patch Changes)\s*\n*/gim, "")
|
|
189
|
-
.replace(/^###\s+(.+)$/gm, "**$1**");
|
|
190
|
-
if (entries.length === 1) {
|
|
191
|
-
const [entry] = entries;
|
|
192
|
-
if (!entry) return "";
|
|
193
|
-
return `## ${registration.name} ${entry.version}\n\n${body(entry)}`;
|
|
194
|
-
}
|
|
195
|
-
return [
|
|
196
|
-
`## ${registration.name}`,
|
|
197
|
-
...entries.map((entry) => `**${entry.version}**\n\n${body(entry)}`),
|
|
198
|
-
].join("\n\n");
|
|
199
|
-
}
|
|
200
|
-
|
|
201
|
-
async function claimUpdates(
|
|
202
|
-
registrations: Iterable<PackageRegistration>,
|
|
203
|
-
): Promise<{ errors: string[]; markdown?: string }> {
|
|
204
|
-
const stableRegistrations = [...registrations]
|
|
205
|
-
.filter((registration) => isStableVersion(registration.version))
|
|
206
|
-
.sort((left, right) => left.name.localeCompare(right.name));
|
|
207
|
-
if (stableRegistrations.length === 0) return { errors: [] };
|
|
208
|
-
const path = statePath();
|
|
209
|
-
await mkdir(dirname(path), { mode: 0o700, recursive: true });
|
|
210
|
-
const release = await acquireLock(`${path}.lock`);
|
|
211
|
-
try {
|
|
212
|
-
const state = await readState(path);
|
|
213
|
-
const errors: string[] = [];
|
|
214
|
-
const sections: string[] = [];
|
|
215
|
-
let changed = false;
|
|
216
|
-
if (state[SUPPRESS_KEY] === true) {
|
|
217
|
-
for (const registration of stableRegistrations) {
|
|
218
|
-
const seenVersion = state[registration.name];
|
|
219
|
-
if (
|
|
220
|
-
typeof seenVersion !== "string" ||
|
|
221
|
-
compareVersions(registration.version, seenVersion) > 0
|
|
222
|
-
) {
|
|
223
|
-
state[registration.name] = registration.version;
|
|
224
|
-
changed = true;
|
|
225
|
-
}
|
|
226
|
-
}
|
|
227
|
-
if (changed) await writeState(path, state);
|
|
228
|
-
return { errors };
|
|
229
|
-
}
|
|
230
|
-
for (const registration of stableRegistrations) {
|
|
231
|
-
const seenVersion = state[registration.name];
|
|
232
|
-
if (
|
|
233
|
-
typeof seenVersion === "string" &&
|
|
234
|
-
compareVersions(registration.version, seenVersion) <= 0
|
|
235
|
-
)
|
|
236
|
-
continue;
|
|
237
|
-
try {
|
|
238
|
-
const entries = parseChangelog(
|
|
239
|
-
await readFile(registration.changelogPath, "utf8"),
|
|
240
|
-
).filter(
|
|
241
|
-
(entry) =>
|
|
242
|
-
compareVersions(entry.version, registration.version) <= 0 &&
|
|
243
|
-
(typeof seenVersion === "string"
|
|
244
|
-
? compareVersions(entry.version, seenVersion) > 0
|
|
245
|
-
: entry.version === registration.version),
|
|
246
|
-
);
|
|
247
|
-
if (entries.length === 0) {
|
|
248
|
-
errors.push(
|
|
249
|
-
`No ${registration.version} changelog entry found for ${registration.name}`,
|
|
250
|
-
);
|
|
251
|
-
continue;
|
|
252
|
-
}
|
|
253
|
-
sections.push(packageMarkdown(registration, entries));
|
|
254
|
-
state[registration.name] = registration.version;
|
|
255
|
-
changed = true;
|
|
256
|
-
} catch (error) {
|
|
257
|
-
errors.push(
|
|
258
|
-
`Could not read the ${registration.name} changelog: ${error instanceof Error ? error.message : String(error)}`,
|
|
259
|
-
);
|
|
260
|
-
}
|
|
261
|
-
}
|
|
262
|
-
if (changed) await writeState(path, state);
|
|
263
|
-
return {
|
|
264
|
-
errors,
|
|
265
|
-
...(sections.length > 0 ? { markdown: sections.join("\n\n") } : {}),
|
|
266
|
-
};
|
|
267
|
-
} finally {
|
|
268
|
-
await release();
|
|
269
|
-
}
|
|
270
|
-
}
|
|
271
|
-
|
|
272
|
-
function registerCoordinator(
|
|
273
|
-
pi: ExtensionAPI,
|
|
274
|
-
registration: PackageRegistration,
|
|
275
|
-
): void {
|
|
276
|
-
let accepted = false;
|
|
277
|
-
pi.events.emit(REGISTRATION_CHANNEL, {
|
|
278
|
-
registration,
|
|
279
|
-
accept: () => {
|
|
280
|
-
accepted = true;
|
|
281
|
-
},
|
|
282
|
-
} satisfies RegistrationEvent);
|
|
283
|
-
if (accepted) return;
|
|
284
|
-
|
|
285
|
-
const registrations = new Map([[registration.name, registration]]);
|
|
286
|
-
pi.events.on(REGISTRATION_CHANNEL, (value) => {
|
|
287
|
-
if (!isRegistrationEvent(value)) return;
|
|
288
|
-
registrations.set(value.registration.name, value.registration);
|
|
289
|
-
value.accept();
|
|
290
|
-
});
|
|
291
|
-
pi.registerEntryRenderer<ChangelogEntryData>(
|
|
292
|
-
ENTRY_TYPE,
|
|
293
|
-
(entry, _options, theme) => {
|
|
294
|
-
if (!entry.data) return undefined;
|
|
295
|
-
const container = new Container();
|
|
296
|
-
container.addChild(new DynamicBorder());
|
|
297
|
-
container.addChild(
|
|
298
|
-
new Text(theme.bold(theme.fg("accent", "What's New")), 1, 0),
|
|
299
|
-
);
|
|
300
|
-
container.addChild(new Spacer(1));
|
|
301
|
-
container.addChild(
|
|
302
|
-
new Markdown(entry.data.markdown.trim(), 1, 0, getMarkdownTheme()),
|
|
303
|
-
);
|
|
304
|
-
container.addChild(new Spacer(1));
|
|
305
|
-
container.addChild(new DynamicBorder());
|
|
306
|
-
return container;
|
|
307
|
-
},
|
|
308
|
-
);
|
|
309
|
-
pi.on("session_start", async (event, ctx) => {
|
|
310
|
-
if (event.reason === "reload" || ctx.mode !== "tui") return;
|
|
311
|
-
if (
|
|
312
|
-
ctx.sessionManager
|
|
313
|
-
.getEntries()
|
|
314
|
-
.some((entry) =>
|
|
315
|
-
["branch_summary", "compaction", "message"].includes(entry.type),
|
|
316
|
-
)
|
|
317
|
-
)
|
|
318
|
-
return;
|
|
319
|
-
try {
|
|
320
|
-
const update = await claimUpdates(registrations.values());
|
|
321
|
-
if (update.markdown)
|
|
322
|
-
pi.appendEntry<ChangelogEntryData>(ENTRY_TYPE, {
|
|
323
|
-
markdown: update.markdown,
|
|
324
|
-
});
|
|
325
|
-
for (const error of update.errors) ctx.ui.notify(error, "warning");
|
|
326
|
-
} catch (error) {
|
|
327
|
-
ctx.ui.notify(
|
|
328
|
-
`Could not update Howaboua changelog state: ${error instanceof Error ? error.message : String(error)}`,
|
|
329
|
-
"warning",
|
|
330
|
-
);
|
|
331
|
-
}
|
|
332
|
-
});
|
|
333
|
-
}
|
|
334
|
-
|
|
335
|
-
export default function howabouaPackageChangelog(pi: ExtensionAPI): void {
|
|
336
|
-
registerCoordinator(pi, packageRegistration());
|
|
337
|
-
}
|