git.zone/tsdoc
3
0
Fork 0
Code Issues 1 Pull Requests Actions Packages Projects Releases Wiki Activity

fix(aidocs, config): migrate aidocs configuration handling from npmextra to smartconfig

Browse Source
This commit is contained in:
Jürgen Kunz
2026-03-24 15:07:49 +00:00
parent fc85f28f69
commit a3a0537ddc
9 changed files with 53 additions and 26 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
ts/00_commitinfo_data.ts
View File

@@ -3,6 +3,6 @@
*/
export const commitinfo = {
name: '@git.zone/tsdoc',
version: '2.0.0',
version: '2.0.1',
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.'
}

14
ts/aidocs_classes/description.ts
View File

@@ -79,15 +79,15 @@ Don't wrap the JSON in \`\`\`json\`\`\` - just return the raw JSON object.
const projectContext = new ProjectContext(this.projectDir);
const files = await projectContext.gatherFiles();
// Update npmextra.json
const npmextraJson = files.smartfilesNpmextraJSON;
const npmextraJsonContent = JSON.parse(npmextraJson.contents.toString());
// Update smartconfig.json
const smartconfigJson = files.smartfilesNpmextraJSON;
const smartconfigJsonContent = JSON.parse(smartconfigJson.contents.toString());
npmextraJsonContent['@git.zone/cli'].module.description = resultObject.description;
npmextraJsonContent['@git.zone/cli'].module.keywords = resultObject.keywords;
smartconfigJsonContent['@git.zone/cli'].module.description = resultObject.description;
smartconfigJsonContent['@git.zone/cli'].module.keywords = resultObject.keywords;
npmextraJson.contents = Buffer.from(JSON.stringify(npmextraJsonContent, null, 2));
await npmextraJson.write();
smartconfigJson.contents = Buffer.from(JSON.stringify(smartconfigJsonContent, null, 2));
await smartconfigJson.write();
// Update package.json
const packageJson = files.smartfilePackageJSON;

2
ts/aidocs_classes/projectcontext.ts
View File

@@ -27,7 +27,7 @@ export class ProjectContext {
this.projectDir,
);
const smartfilesNpmextraJSON = await plugins.smartfileFactory.fromFilePath(
plugins.path.join(this.projectDir, 'npmextra.json'),
plugins.path.join(this.projectDir, 'smartconfig.json'),
this.projectDir,
);
const smartfilesMod = await plugins.smartfileFactory.virtualDirectoryFromPath(

6
ts/aidocs_classes/readme.ts
View File

@@ -19,12 +19,12 @@ export class Readme {
// First check legal info before introducing any cost
const projectContext = new ProjectContext(this.projectDir);
const npmExtraJson = JSON.parse(
const smartconfigJson = JSON.parse(
(await projectContext.gatherFiles()).smartfilesNpmextraJSON.contents.toString()
);
const legalInfo = npmExtraJson?.['@git.zone/tsdoc']?.legal;
const legalInfo = smartconfigJson?.['@git.zone/tsdoc']?.legal;
if (!legalInfo) {
const error = new Error(`No legal information found in npmextra.json`);
const error = new Error(`No legal information found in smartconfig.json`);
console.log(error);
}

16
ts/classes.aidoc.ts
View File

@@ -5,7 +5,7 @@ import * as aiDocsClasses from './aidocs_classes/index.js';
export class AiDoc {
private openaiToken: string;
public npmextraKV: plugins.npmextra.KeyValueStore;
public smartconfigKV: plugins.npmextra.KeyValueStore;
public qenvInstance: plugins.qenv.Qenv;
public aidocInteract: plugins.smartinteract.SmartInteract;
public model: plugins.smartai.LanguageModelV3;
@@ -38,8 +38,8 @@ export class AiDoc {
if (!(await this.qenvInstance.getEnvVarOnDemand('OPENAI_TOKEN'))) {
// Migrate old KV store path to new path if needed
const homeDir = plugins.smartpath.get.home();
const oldKvPath = plugins.path.join(homeDir, '.npmextra/kv/tsdoc.json');
const newKvDir = plugins.path.join(homeDir, '.npmextra/kv/@git.zone');
const oldKvPath = plugins.path.join(homeDir, '.smartconfig/kv/tsdoc.json');
const newKvDir = plugins.path.join(homeDir, '.smartconfig/kv/@git.zone');
const newKvPath = plugins.path.join(newKvDir, 'tsdoc.json');
if (
await plugins.fsInstance.file(oldKvPath).exists() &&
@@ -52,13 +52,13 @@ export class AiDoc {
console.log('Migration complete: tsdoc.json -> @git.zone/tsdoc.json');
}
this.npmextraKV = new plugins.npmextra.KeyValueStore({
this.smartconfigKV = new plugins.npmextra.KeyValueStore({
typeArg: 'userHomeDir',
identityArg: '@git.zone/tsdoc',
mandatoryKeys: ['OPENAI_TOKEN'],
});
const missingKeys = await this.npmextraKV.getMissingMandatoryKeys();
const missingKeys = await this.smartconfigKV.getMissingMandatoryKeys();
if (missingKeys.length > 0) {
// lets try argv
if (this.argvArg?.OPENAI_TOKEN) {
@@ -77,11 +77,11 @@ export class AiDoc {
}
this.printSanitizedToken();
await this.npmextraKV.writeKey('OPENAI_TOKEN', this.openaiToken);
await this.smartconfigKV.writeKey('OPENAI_TOKEN', this.openaiToken);
}
}
if (!this.openaiToken && this.npmextraKV) {
this.openaiToken = await this.npmextraKV.readKey('OPENAI_TOKEN');
if (!this.openaiToken && this.smartconfigKV) {
this.openaiToken = await this.smartconfigKV.readKey('OPENAI_TOKEN');
}
// Create model using getModel()

2
ts/plugins.ts
View File

@@ -4,7 +4,7 @@ import * as path from 'path';
export { path };
// pushrocks scope
import * as npmextra from '@push.rocks/npmextra';
import * as npmextra from '@push.rocks/smartconfig';
import * as qenv from '@push.rocks/qenv';
import * as smartagent from '@push.rocks/smartagent';
import * as smartagentTools from '@push.rocks/smartagent/tools';