@git.zone/tsdoc 1.11.3 → 1.12.0
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/dist_ts/00_commitinfo_data.js +1 -1
- package/dist_ts/aidocs_classes/commit.js +31 -3
- package/dist_ts/cli.js +0 -0
- package/package.json +13 -12
- package/readme.hints.md +10 -1
- package/ts/00_commitinfo_data.ts +1 -1
- package/ts/aidocs_classes/commit.ts +35 -2
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
*/
|
|
4
4
|
export const commitinfo = {
|
|
5
5
|
name: '@git.zone/tsdoc',
|
|
6
|
-
version: '1.
|
|
6
|
+
version: '1.12.0',
|
|
7
7
|
description: 'A comprehensive TypeScript documentation tool that leverages AI to generate and enhance project documentation, including dynamic README creation, API docs via TypeDoc, and smart commit message generation.'
|
|
8
8
|
};
|
|
9
9
|
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiMDBfY29tbWl0aW5mb19kYXRhLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vdHMvMDBfY29tbWl0aW5mb19kYXRhLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBOztHQUVHO0FBQ0gsTUFBTSxDQUFDLE1BQU0sVUFBVSxHQUFHO0lBQ3hCLElBQUksRUFBRSxpQkFBaUI7SUFDdkIsT0FBTyxFQUFFLFFBQVE7SUFDakIsV0FBVyxFQUFFLDhNQUE4TTtDQUM1TixDQUFBIn0=
|
|
@@ -3,6 +3,23 @@ import { AiDoc } from '../classes.aidoc.js';
|
|
|
3
3
|
import { ProjectContext } from './projectcontext.js';
|
|
4
4
|
import { DiffProcessor } from '../classes.diffprocessor.js';
|
|
5
5
|
import { logger } from '../logging.js';
|
|
6
|
+
// Token budget configuration for OpenAI API limits
|
|
7
|
+
const TOKEN_BUDGET = {
|
|
8
|
+
OPENAI_CONTEXT_LIMIT: 272000, // OpenAI's configured limit
|
|
9
|
+
SAFETY_MARGIN: 10000, // Buffer to avoid hitting exact limit
|
|
10
|
+
SMARTAGENT_OVERHEAD: 180000, // System msgs, tools, history, formatting
|
|
11
|
+
TASK_PROMPT_OVERHEAD: 2000, // Task prompt template size
|
|
12
|
+
};
|
|
13
|
+
/**
|
|
14
|
+
* Calculate max tokens available for diff content based on total budget
|
|
15
|
+
*/
|
|
16
|
+
function calculateMaxDiffTokens() {
|
|
17
|
+
const available = TOKEN_BUDGET.OPENAI_CONTEXT_LIMIT
|
|
18
|
+
- TOKEN_BUDGET.SAFETY_MARGIN
|
|
19
|
+
- TOKEN_BUDGET.SMARTAGENT_OVERHEAD
|
|
20
|
+
- TOKEN_BUDGET.TASK_PROMPT_OVERHEAD;
|
|
21
|
+
return Math.max(available, 30000);
|
|
22
|
+
}
|
|
6
23
|
export class Commit {
|
|
7
24
|
constructor(aiDocsRef, projectDirArg) {
|
|
8
25
|
this.aiDocsRef = aiDocsRef;
|
|
@@ -63,9 +80,12 @@ export class Commit {
|
|
|
63
80
|
console.log(` Total characters: ${totalChars.toLocaleString()}`);
|
|
64
81
|
console.log(` Estimated tokens: ${estimatedTokens.toLocaleString()}`);
|
|
65
82
|
console.log(` Exclusion patterns: ${excludePatterns.length}`);
|
|
83
|
+
// Calculate available tokens for diff based on total budget
|
|
84
|
+
const maxDiffTokens = calculateMaxDiffTokens();
|
|
85
|
+
console.log(`📊 Token budget: ${maxDiffTokens.toLocaleString()} tokens for diff (limit: ${TOKEN_BUDGET.OPENAI_CONTEXT_LIMIT.toLocaleString()}, overhead: ${(TOKEN_BUDGET.SMARTAGENT_OVERHEAD + TOKEN_BUDGET.TASK_PROMPT_OVERHEAD).toLocaleString()})`);
|
|
66
86
|
// Use DiffProcessor to intelligently handle large diffs
|
|
67
87
|
const diffProcessor = new DiffProcessor({
|
|
68
|
-
maxDiffTokens
|
|
88
|
+
maxDiffTokens, // Dynamic based on total budget
|
|
69
89
|
smallFileLines: 300, // Most source files are under 300 lines
|
|
70
90
|
mediumFileLines: 800, // Only very large files get head/tail treatment
|
|
71
91
|
sampleHeadLines: 75, // When sampling, show more context
|
|
@@ -81,6 +101,14 @@ export class Commit {
|
|
|
81
101
|
if (estimatedTokens > 50000) {
|
|
82
102
|
console.log(`✅ DiffProcessor reduced token usage: ${estimatedTokens.toLocaleString()} → ${processedDiff.totalTokens.toLocaleString()}`);
|
|
83
103
|
}
|
|
104
|
+
// Validate total tokens won't exceed limit
|
|
105
|
+
const totalEstimatedTokens = processedDiff.totalTokens
|
|
106
|
+
+ TOKEN_BUDGET.SMARTAGENT_OVERHEAD
|
|
107
|
+
+ TOKEN_BUDGET.TASK_PROMPT_OVERHEAD;
|
|
108
|
+
if (totalEstimatedTokens > TOKEN_BUDGET.OPENAI_CONTEXT_LIMIT - TOKEN_BUDGET.SAFETY_MARGIN) {
|
|
109
|
+
console.log(`⚠️ Warning: Estimated tokens (${totalEstimatedTokens.toLocaleString()}) approaching limit`);
|
|
110
|
+
console.log(` Consider splitting into smaller commits`);
|
|
111
|
+
}
|
|
84
112
|
}
|
|
85
113
|
else {
|
|
86
114
|
processedDiffString = 'No changes.';
|
|
@@ -147,7 +175,7 @@ Here is the structure of the JSON you must return:
|
|
|
147
175
|
{
|
|
148
176
|
"recommendedNextVersionLevel": "fix" | "feat" | "BREAKING CHANGE",
|
|
149
177
|
"recommendedNextVersionScope": "string",
|
|
150
|
-
"recommendedNextVersionMessage": "string",
|
|
178
|
+
"recommendedNextVersionMessage": "string (ONLY the description body WITHOUT the type(scope): prefix - e.g. 'bump dependency to ^1.2.6' NOT 'fix(deps): bump dependency to ^1.2.6')",
|
|
151
179
|
"recommendedNextVersionDetails": ["string"],
|
|
152
180
|
"recommendedNextVersion": "x.x.x"
|
|
153
181
|
}
|
|
@@ -248,4 +276,4 @@ ${JSON.stringify(commitMessages, null, 2)}
|
|
|
248
276
|
return resultObject;
|
|
249
277
|
}
|
|
250
278
|
}
|
|
251
|
-
//# sourceMappingURL=data:application/json;base64,
|
|
279
|
+
//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"commit.js","sourceRoot":"","sources":["../../ts/aidocs_classes/commit.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,OAAO,MAAM,eAAe,CAAC;AACzC,OAAO,EAAE,KAAK,EAAE,MAAM,qBAAqB,CAAC;AAC5C,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,EAAE,aAAa,EAAE,MAAM,6BAA6B,CAAC;AAC5D,OAAO,EAAE,MAAM,EAAE,MAAM,eAAe,CAAC;AAEvC,mDAAmD;AACnD,MAAM,YAAY,GAAG;IACnB,oBAAoB,EAAE,MAAM,EAAI,4BAA4B;IAC5D,aAAa,EAAE,KAAK,EAAa,sCAAsC;IACvE,mBAAmB,EAAE,MAAM,EAAM,0CAA0C;IAC3E,oBAAoB,EAAE,IAAI,EAAO,4BAA4B;CACrD,CAAC;AAEX;;GAEG;AACH,SAAS,sBAAsB;IAC7B,MAAM,SAAS,GAAG,YAAY,CAAC,oBAAoB;UAC/C,YAAY,CAAC,aAAa;UAC1B,YAAY,CAAC,mBAAmB;UAChC,YAAY,CAAC,oBAAoB,CAAC;IACtC,OAAO,IAAI,CAAC,GAAG,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;AACpC,CAAC;AAWD,MAAM,OAAO,MAAM;IAIjB,YAAY,SAAgB,EAAE,aAAqB;QACjD,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,UAAU,GAAG,aAAa,CAAC;IAClC,CAAC;IAEM,KAAK,CAAC,qBAAqB;QAChC,MAAM,gBAAgB,GAAG,IAAI,OAAO,CAAC,QAAQ,CAAC,QAAQ,EAAE,CAAC;QACzD,MAAM,gBAAgB,CAAC,IAAI,EAAE,CAAC;QAC9B,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,kBAAkB,CAC/D,gBAAgB,EAChB,IAAI,CAAC,UAAU,CAChB,CAAC;QAEF,0CAA0C;QAC1C,kDAAkD;QAClD,MAAM,eAAe,GAAG;YACtB,aAAa;YACb,gBAAgB;YAChB,mBAAmB;YACnB,qBAAqB;YACrB,WAAW;YACX,WAAW;YACX,WAAW;YAEX,kDAAkD;YAClD,SAAS;YACT,WAAW,EAAY,0BAA0B;YACjD,UAAU;YACV,UAAU;YACV,QAAQ;YACR,gBAAgB;YAEhB,yBAAyB;YACzB,aAAa;YACb,eAAe;YACf,aAAa;YACb,gBAAgB;YAChB,eAAe;YAEf,yBAAyB;YACzB,YAAY;YACZ,YAAY;YACZ,YAAY;YACZ,UAAU;YACV,UAAU;YACV,UAAU;YAEV,kBAAkB;YAClB,WAAW;YACX,UAAU;YACV,WAAW;YACX,gBAAgB;YAChB,aAAa;YACb,gBAAgB;SACjB,CAAC;QAEF,2EAA2E;QAC3E,MAAM,eAAe,GAAG,MAAM,OAAO,CAAC,kBAAkB,CAAC,eAAe,CAAC,CAAC;QAE1E,kDAAkD;QAClD,IAAI,mBAA2B,CAAC;QAEhC,IAAI,eAAe,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC/B,6CAA6C;YAC7C,MAAM,UAAU,GAAG,eAAe,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC;YACvD,MAAM,eAAe,GAAG,IAAI,CAAC,IAAI,CAAC,UAAU,GAAG,CAAC,CAAC,CAAC;YAElD,OAAO,CAAC,GAAG,CAAC,6BAA6B,CAAC,CAAC;YAC3C,OAAO,CAAC,GAAG,CAAC,qBAAqB,eAAe,CAAC,MAAM,EAAE,CAAC,CAAC;YAC3D,OAAO,CAAC,GAAG,CAAC,wBAAwB,UAAU,CAAC,cAAc,EAAE,EAAE,CAAC,CAAC;YACnE,OAAO,CAAC,GAAG,CAAC,wBAAwB,eAAe,CAAC,cAAc,EAAE,EAAE,CAAC,CAAC;YACxE,OAAO,CAAC,GAAG,CAAC,0BAA0B,eAAe,CAAC,MAAM,EAAE,CAAC,CAAC;YAEhE,4DAA4D;YAC5D,MAAM,aAAa,GAAG,sBAAsB,EAAE,CAAC;YAC/C,OAAO,CAAC,GAAG,CAAC,oBAAoB,aAAa,CAAC,cAAc,EAAE,4BAA4B,YAAY,CAAC,oBAAoB,CAAC,cAAc,EAAE,eAAe,CAAC,YAAY,CAAC,mBAAmB,GAAG,YAAY,CAAC,oBAAoB,CAAC,CAAC,cAAc,EAAE,GAAG,CAAC,CAAC;YAEvP,wDAAwD;YACxD,MAAM,aAAa,GAAG,IAAI,aAAa,CAAC;gBACtC,aAAa,EAAgB,gCAAgC;gBAC7D,cAAc,EAAE,GAAG,EAAU,wCAAwC;gBACrE,eAAe,EAAE,GAAG,EAAS,gDAAgD;gBAC7E,eAAe,EAAE,EAAE,EAAU,mCAAmC;gBAChE,eAAe,EAAE,EAAE,EAAU,mCAAmC;aACjE,CAAC,CAAC;YAEH,MAAM,aAAa,GAAG,aAAa,CAAC,YAAY,CAAC,eAAe,CAAC,CAAC;YAClE,mBAAmB,GAAG,aAAa,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;YAEpE,OAAO,CAAC,GAAG,CAAC,+BAA+B,CAAC,CAAC;YAC7C,OAAO,CAAC,GAAG,CAAC,kBAAkB,aAAa,CAAC,SAAS,CAAC,MAAM,QAAQ,CAAC,CAAC;YACtE,OAAO,CAAC,GAAG,CAAC,kBAAkB,aAAa,CAAC,eAAe,CAAC,MAAM,QAAQ,CAAC,CAAC;YAC5E,OAAO,CAAC,GAAG,CAAC,qBAAqB,aAAa,CAAC,YAAY,CAAC,MAAM,QAAQ,CAAC,CAAC;YAC5E,OAAO,CAAC,GAAG,CAAC,oBAAoB,aAAa,CAAC,WAAW,CAAC,cAAc,EAAE,EAAE,CAAC,CAAC;YAE9E,IAAI,eAAe,GAAG,KAAK,EAAE,CAAC;gBAC5B,OAAO,CAAC,GAAG,CAAC,wCAAwC,eAAe,CAAC,cAAc,EAAE,MAAM,aAAa,CAAC,WAAW,CAAC,cAAc,EAAE,EAAE,CAAC,CAAC;YAC1I,CAAC;YAED,2CAA2C;YAC3C,MAAM,oBAAoB,GAAG,aAAa,CAAC,WAAW;kBAClD,YAAY,CAAC,mBAAmB;kBAChC,YAAY,CAAC,oBAAoB,CAAC;YAEtC,IAAI,oBAAoB,GAAG,YAAY,CAAC,oBAAoB,GAAG,YAAY,CAAC,aAAa,EAAE,CAAC;gBAC1F,OAAO,CAAC,GAAG,CAAC,kCAAkC,oBAAoB,CAAC,cAAc,EAAE,qBAAqB,CAAC,CAAC;gBAC1G,OAAO,CAAC,GAAG,CAAC,4CAA4C,CAAC,CAAC;YAC5D,CAAC;QACH,CAAC;aAAM,CAAC;YACN,mBAAmB,GAAG,aAAa,CAAC;QACtC,CAAC;QAED,0DAA0D;QAC1D,MAAM,kBAAkB,GAAG,IAAI,OAAO,CAAC,UAAU,CAAC,qBAAqB,CAAC;YACtE,eAAe,EAAE,IAAI,CAAC,SAAS,CAAC,eAAe;YAC/C,eAAe,EAAE,QAAQ;YACzB,SAAS,EAAE,UAAU;YACrB,UAAU,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,QAAQ,EAAE,KAAK,CAAC,UAAU,CAAC;YACnE,oBAAoB,EAAE;;;;;;;;;;;;;;;;;;;;;;;;CAwB3B;SACI,CAAC,CAAC;QAEH,wDAAwD;QACxD,kBAAkB,CAAC,4BAA4B,CAAC,IAAI,CAAC,UAAU,EAAE;YAC/D,WAAW;YACX,iBAAiB;YACjB,SAAS;YACT,SAAS;YACT,WAAW;SACZ,CAAC,CAAC;QAEH,MAAM,kBAAkB,CAAC,KAAK,EAAE,CAAC;QAEjC,MAAM,gBAAgB,GAAG;;qBAER,IAAI,CAAC,UAAU;;;;;;;;;;;;;;;;;;;;;;;;;;;;EA4BlC,mBAAmB;;;CAGpB,CAAC;QAEE,MAAM,YAAY,GAAG,MAAM,kBAAkB,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC;QACpE,MAAM,kBAAkB,CAAC,IAAI,EAAE,CAAC;QAEhC,IAAI,CAAC,YAAY,CAAC,OAAO,EAAE,CAAC;YAC1B,MAAM,IAAI,KAAK,CAAC,qCAAqC,YAAY,CAAC,MAAM,EAAE,CAAC,CAAC;QAC9E,CAAC;QAED,uEAAuE;QACvE,IAAI,UAAU,GAAG,YAAY,CAAC,MAAM;aACjC,OAAO,CAAC,cAAc,EAAE,EAAE,CAAC;aAC3B,OAAO,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC;QAE3B,wCAAwC;QACxC,MAAM,SAAS,GAAG,UAAU,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;QAClD,IAAI,CAAC,SAAS,EAAE,CAAC;YACf,MAAM,IAAI,KAAK,CAAC,yCAAyC,UAAU,CAAC,SAAS,CAAC,CAAC,EAAE,GAAG,CAAC,KAAK,CAAC,CAAC;QAC9F,CAAC;QACD,UAAU,GAAG,SAAS,CAAC,CAAC,CAAC,CAAC;QAE1B,MAAM,YAAY,GAAsB,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;QAE/D,MAAM,qBAAqB,GAAG,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,cAAc,CAAC,CAAC;QACjF,IAAI,iBAA8C,CAAC;QACnD,IAAI,MAAM,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC;YAClE,iBAAiB,GAAG,MAAM,OAAO,CAAC,gBAAgB,CAAC,YAAY,CAAC,qBAAqB,CAAC,CAAC;QACzF,CAAC;QAED,IAAI,CAAC,iBAAiB,EAAE,CAAC;YACvB,yCAAyC;YACzC,MAAM,cAAc,GAAG,MAAM,OAAO,CAAC,oBAAoB,EAAE,CAAC;YAC5D,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,cAAc,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;YAErD,8EAA8E;YAC9E,MAAM,qBAAqB,GAAG,IAAI,OAAO,CAAC,UAAU,CAAC,qBAAqB,CAAC;gBACzE,eAAe,EAAE,IAAI,CAAC,SAAS,CAAC,eAAe;gBAC/C,eAAe,EAAE,QAAQ;gBACzB,SAAS,EAAE,aAAa;gBACxB,UAAU,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,QAAQ,EAAE,KAAK,CAAC,UAAU,CAAC;gBACnE,oBAAoB,EAAE;;;;;;;;;;;;;;CAc7B;aACM,CAAC,CAAC;YAEH,MAAM,qBAAqB,CAAC,KAAK,EAAE,CAAC;YAEpC,MAAM,mBAAmB,GAAG;;;;;;;;;;;;;;;;;;EAkBhC,IAAI,CAAC,SAAS,CAAC,cAAc,EAAE,IAAI,EAAE,CAAC,CAAC;CACxC,CAAC;YAEI,MAAM,eAAe,GAAG,MAAM,qBAAqB,CAAC,GAAG,CAAC,mBAAmB,CAAC,CAAC;YAC7E,MAAM,qBAAqB,CAAC,IAAI,EAAE,CAAC;YAEnC,IAAI,CAAC,eAAe,CAAC,OAAO,EAAE,CAAC;gBAC7B,MAAM,IAAI,KAAK,CAAC,gCAAgC,eAAe,CAAC,MAAM,EAAE,CAAC,CAAC;YAC5E,CAAC;YAED,iBAAiB,GAAG,OAAO,CAAC,gBAAgB,CAAC,UAAU,CACrD,qBAAqB,EACrB,eAAe,CAAC,MAAM,CAAC,UAAU,CAAC,aAAa,EAAE,EAAE,CAAC,CAAC,UAAU,CAAC,KAAK,EAAE,EAAE,CAAC,EAC1E,MAAM,CACP,CAAC;QACJ,CAAC;QAED,IAAI,YAAY,GAAG,iBAAiB,CAAC,QAAQ,CAAC,QAAQ,EAAE,CAAC,OAAO,CAAC,iBAAiB,EAAE,EAAE,CAAC,CAAC;QACxF,IAAI,YAAY,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;YAClC,YAAY,GAAG,YAAY,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;QAChD,CAAC;QACD,IAAI,aAAa,GAAG,IAAI,OAAO,CAAC,SAAS,CAAC,YAAY,EAAE,CAAC,0BAA0B,EAAE,CAAC;QACtF,IAAI,YAAY,GAAG,kBAAkB,MAAM,aAAa;;;uBAGrC,OAAO,YAAY,EAAE,CAAC;QACzC,YAAY,CAAC,SAAS,GAAG,YAAY,CAAC;QAEtC,OAAO,YAAY,CAAC;IACtB,CAAC;CACF"}
|
package/dist_ts/cli.js
CHANGED
|
File without changes
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@git.zone/tsdoc",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.12.0",
|
|
4
4
|
"private": false,
|
|
5
5
|
"description": "A comprehensive TypeScript documentation tool that leverages AI to generate and enhance project documentation, including dynamic README creation, API docs via TypeDoc, and smart commit message generation.",
|
|
6
6
|
"type": "module",
|
|
@@ -12,14 +12,20 @@
|
|
|
12
12
|
"bin": {
|
|
13
13
|
"tsdoc": "cli.js"
|
|
14
14
|
},
|
|
15
|
+
"scripts": {
|
|
16
|
+
"test": "(tstest test/ --verbose --logfile --timeout 600) && npm run testCli",
|
|
17
|
+
"testCli": "(node ./cli.ts.js) && (node ./cli.ts.js aidocs)",
|
|
18
|
+
"build": "(tsbuild --web --allowimplicitany)",
|
|
19
|
+
"buildDocs": "tsdoc"
|
|
20
|
+
},
|
|
15
21
|
"devDependencies": {
|
|
16
22
|
"@git.zone/tsbuild": "^4.0.2",
|
|
17
23
|
"@git.zone/tsrun": "^2.0.1",
|
|
18
|
-
"@git.zone/tstest": "^3.1.
|
|
19
|
-
"@types/node": "^25.0.
|
|
24
|
+
"@git.zone/tstest": "^3.1.4",
|
|
25
|
+
"@types/node": "^25.0.3"
|
|
20
26
|
},
|
|
21
27
|
"dependencies": {
|
|
22
|
-
"@git.zone/tspublish": "^1.
|
|
28
|
+
"@git.zone/tspublish": "^1.11.0",
|
|
23
29
|
"@push.rocks/early": "^4.0.4",
|
|
24
30
|
"@push.rocks/npmextra": "^5.3.3",
|
|
25
31
|
"@push.rocks/qenv": "^6.1.3",
|
|
@@ -28,7 +34,7 @@
|
|
|
28
34
|
"@push.rocks/smartcli": "^4.0.19",
|
|
29
35
|
"@push.rocks/smartdelay": "^3.0.5",
|
|
30
36
|
"@push.rocks/smartfile": "^13.1.2",
|
|
31
|
-
"@push.rocks/smartfs": "^1.
|
|
37
|
+
"@push.rocks/smartfs": "^1.3.1",
|
|
32
38
|
"@push.rocks/smartgit": "^3.3.1",
|
|
33
39
|
"@push.rocks/smartinteract": "^2.0.16",
|
|
34
40
|
"@push.rocks/smartlog": "^3.1.10",
|
|
@@ -75,10 +81,5 @@
|
|
|
75
81
|
"url": "https://gitlab.com/gitzone/tsdoc/issues"
|
|
76
82
|
},
|
|
77
83
|
"homepage": "https://gitlab.com/gitzone/tsdoc#readme",
|
|
78
|
-
"
|
|
79
|
-
|
|
80
|
-
"testCli": "(node ./cli.ts.js) && (node ./cli.ts.js aidocs)",
|
|
81
|
-
"build": "(tsbuild --web --allowimplicitany)",
|
|
82
|
-
"buildDocs": "tsdoc"
|
|
83
|
-
}
|
|
84
|
-
}
|
|
84
|
+
"packageManager": "pnpm@10.14.0+sha512.ad27a79641b49c3e481a16a805baa71817a04bbe06a38d17e60e2eaee83f6a146c6a688125f5792e48dd5ba30e7da52a5cda4c3992b9ccf333f9ce223af84748"
|
|
85
|
+
}
|
package/readme.hints.md
CHANGED
|
@@ -2,4 +2,13 @@
|
|
|
2
2
|
* alternatively can be used through npx, if installed locally
|
|
3
3
|
* cli parameters are concluded from ./ts/cli.ts
|
|
4
4
|
* this module is not intended for API use.
|
|
5
|
-
* Read carefully through the TypeScript files. Don't make stuff up.
|
|
5
|
+
* Read carefully through the TypeScript files. Don't make stuff up.
|
|
6
|
+
|
|
7
|
+
## Token Budgeting (commit.ts)
|
|
8
|
+
* OpenAI has a 272,000 token context limit
|
|
9
|
+
* The smartagent infrastructure adds ~180,000 tokens of overhead (system messages, tool descriptions, conversation history)
|
|
10
|
+
* TOKEN_BUDGET constants in commit.ts control the available tokens for diff content
|
|
11
|
+
* Dynamic calculation: 272K - 10K (safety) - 180K (overhead) - 2K (prompt) = 80K tokens for diff
|
|
12
|
+
* If token limit errors occur, consider:
|
|
13
|
+
- Splitting large commits into smaller ones
|
|
14
|
+
- Adjusting SMARTAGENT_OVERHEAD if actual overhead is different
|
package/ts/00_commitinfo_data.ts
CHANGED
|
@@ -3,6 +3,6 @@
|
|
|
3
3
|
*/
|
|
4
4
|
export const commitinfo = {
|
|
5
5
|
name: '@git.zone/tsdoc',
|
|
6
|
-
version: '1.
|
|
6
|
+
version: '1.12.0',
|
|
7
7
|
description: 'A comprehensive TypeScript documentation tool that leverages AI to generate and enhance project documentation, including dynamic README creation, API docs via TypeDoc, and smart commit message generation.'
|
|
8
8
|
}
|
|
@@ -4,6 +4,25 @@ import { ProjectContext } from './projectcontext.js';
|
|
|
4
4
|
import { DiffProcessor } from '../classes.diffprocessor.js';
|
|
5
5
|
import { logger } from '../logging.js';
|
|
6
6
|
|
|
7
|
+
// Token budget configuration for OpenAI API limits
|
|
8
|
+
const TOKEN_BUDGET = {
|
|
9
|
+
OPENAI_CONTEXT_LIMIT: 272000, // OpenAI's configured limit
|
|
10
|
+
SAFETY_MARGIN: 10000, // Buffer to avoid hitting exact limit
|
|
11
|
+
SMARTAGENT_OVERHEAD: 180000, // System msgs, tools, history, formatting
|
|
12
|
+
TASK_PROMPT_OVERHEAD: 2000, // Task prompt template size
|
|
13
|
+
} as const;
|
|
14
|
+
|
|
15
|
+
/**
|
|
16
|
+
* Calculate max tokens available for diff content based on total budget
|
|
17
|
+
*/
|
|
18
|
+
function calculateMaxDiffTokens(): number {
|
|
19
|
+
const available = TOKEN_BUDGET.OPENAI_CONTEXT_LIMIT
|
|
20
|
+
- TOKEN_BUDGET.SAFETY_MARGIN
|
|
21
|
+
- TOKEN_BUDGET.SMARTAGENT_OVERHEAD
|
|
22
|
+
- TOKEN_BUDGET.TASK_PROMPT_OVERHEAD;
|
|
23
|
+
return Math.max(available, 30000);
|
|
24
|
+
}
|
|
25
|
+
|
|
7
26
|
export interface INextCommitObject {
|
|
8
27
|
recommendedNextVersionLevel: 'fix' | 'feat' | 'BREAKING CHANGE'; // the recommended next version level of the project
|
|
9
28
|
recommendedNextVersionScope: string; // the recommended scope name of the next version, like "core" or "cli", or specific class names.
|
|
@@ -90,9 +109,13 @@ export class Commit {
|
|
|
90
109
|
console.log(` Estimated tokens: ${estimatedTokens.toLocaleString()}`);
|
|
91
110
|
console.log(` Exclusion patterns: ${excludePatterns.length}`);
|
|
92
111
|
|
|
112
|
+
// Calculate available tokens for diff based on total budget
|
|
113
|
+
const maxDiffTokens = calculateMaxDiffTokens();
|
|
114
|
+
console.log(`📊 Token budget: ${maxDiffTokens.toLocaleString()} tokens for diff (limit: ${TOKEN_BUDGET.OPENAI_CONTEXT_LIMIT.toLocaleString()}, overhead: ${(TOKEN_BUDGET.SMARTAGENT_OVERHEAD + TOKEN_BUDGET.TASK_PROMPT_OVERHEAD).toLocaleString()})`);
|
|
115
|
+
|
|
93
116
|
// Use DiffProcessor to intelligently handle large diffs
|
|
94
117
|
const diffProcessor = new DiffProcessor({
|
|
95
|
-
maxDiffTokens
|
|
118
|
+
maxDiffTokens, // Dynamic based on total budget
|
|
96
119
|
smallFileLines: 300, // Most source files are under 300 lines
|
|
97
120
|
mediumFileLines: 800, // Only very large files get head/tail treatment
|
|
98
121
|
sampleHeadLines: 75, // When sampling, show more context
|
|
@@ -111,6 +134,16 @@ export class Commit {
|
|
|
111
134
|
if (estimatedTokens > 50000) {
|
|
112
135
|
console.log(`✅ DiffProcessor reduced token usage: ${estimatedTokens.toLocaleString()} → ${processedDiff.totalTokens.toLocaleString()}`);
|
|
113
136
|
}
|
|
137
|
+
|
|
138
|
+
// Validate total tokens won't exceed limit
|
|
139
|
+
const totalEstimatedTokens = processedDiff.totalTokens
|
|
140
|
+
+ TOKEN_BUDGET.SMARTAGENT_OVERHEAD
|
|
141
|
+
+ TOKEN_BUDGET.TASK_PROMPT_OVERHEAD;
|
|
142
|
+
|
|
143
|
+
if (totalEstimatedTokens > TOKEN_BUDGET.OPENAI_CONTEXT_LIMIT - TOKEN_BUDGET.SAFETY_MARGIN) {
|
|
144
|
+
console.log(`⚠️ Warning: Estimated tokens (${totalEstimatedTokens.toLocaleString()}) approaching limit`);
|
|
145
|
+
console.log(` Consider splitting into smaller commits`);
|
|
146
|
+
}
|
|
114
147
|
} else {
|
|
115
148
|
processedDiffString = 'No changes.';
|
|
116
149
|
}
|
|
@@ -180,7 +213,7 @@ Here is the structure of the JSON you must return:
|
|
|
180
213
|
{
|
|
181
214
|
"recommendedNextVersionLevel": "fix" | "feat" | "BREAKING CHANGE",
|
|
182
215
|
"recommendedNextVersionScope": "string",
|
|
183
|
-
"recommendedNextVersionMessage": "string",
|
|
216
|
+
"recommendedNextVersionMessage": "string (ONLY the description body WITHOUT the type(scope): prefix - e.g. 'bump dependency to ^1.2.6' NOT 'fix(deps): bump dependency to ^1.2.6')",
|
|
184
217
|
"recommendedNextVersionDetails": ["string"],
|
|
185
218
|
"recommendedNextVersion": "x.x.x"
|
|
186
219
|
}
|