Compare commits

...

30 Commits

Author SHA1 Message Date
499baebc18 1.2.1 2024-06-23 16:46:11 +02:00
01fc0d0c6e fix(core): Fixed usage of plugins in project context and readme generation 2024-06-23 16:46:10 +02:00
b6c9cea5d1 1.2.0 2024-06-23 16:45:21 +02:00
a949039192 feat(aidocs_classes): Enhance changelog generation by supporting complete generation in the absence of previous changelog files 2024-06-23 16:45:20 +02:00
11bde9d756 1.1.42 2024-06-23 16:43:24 +02:00
eac26521c6 fix(aidoc_classes): Improve commit message generation by handling empty diffs and updating changelog instructions 2024-06-23 16:43:23 +02:00
e1323569f5 1.1.41 2024-06-23 13:49:15 +02:00
41e4bd6689 fix(aidoc_classes): Improve commit message generation by handling empty diffs and updating changelog instructions 2024-06-23 13:49:14 +02:00
164a58ec59 1.1.40 2024-06-23 13:04:48 +02:00
e1c0f82fe8 fix(core): update 2024-06-23 13:04:47 +02:00
8a0046818b 1.1.39 2024-06-23 12:38:58 +02:00
97fa9db32f fix(core): update 2024-06-23 12:38:58 +02:00
d61de9b615 1.1.38 2024-06-23 12:27:27 +02:00
fba54035ea fix(core): update 2024-06-23 12:27:26 +02:00
9a3d8588a8 1.1.37 2024-06-23 12:20:07 +02:00
eb8f8fa70a fix(core): update 2024-06-23 12:20:06 +02:00
afe7b5e99e 1.1.36 2024-06-23 12:11:07 +02:00
e074562362 fix(core): update 2024-06-23 12:11:06 +02:00
240d6bb314 1.1.35 2024-06-23 12:03:26 +02:00
2d0839a1da fix(core): update 2024-06-23 12:03:25 +02:00
9f250ae2b3 1.1.34 2024-06-23 11:59:39 +02:00
1223bb8567 fix(core): update 2024-06-23 11:59:38 +02:00
9395cfc166 1.1.33 2024-06-22 21:21:53 +02:00
3b4c6bd97f fix(core): update 2024-06-22 21:21:52 +02:00
5d2c9e6158 1.1.32 2024-06-22 19:13:58 +02:00
89977038ec fix(core): update 2024-06-22 19:13:57 +02:00
b753c206b0 1.1.31 2024-06-22 13:20:56 +02:00
1965bd9b47 fix(core): update 2024-06-22 13:20:55 +02:00
138d71e8c5 1.1.30 2024-06-22 13:11:23 +02:00
15397e8609 fix(core): update 2024-06-22 13:11:22 +02:00
18 changed files with 868 additions and 210 deletions

View File

@ -0,0 +1,66 @@
name: Default (not tags)
on:
push:
tags-ignore:
- '**'
env:
IMAGE: code.foss.global/hosttoday/ht-docker-node:npmci
NPMCI_COMPUTED_REPOURL: https://${{gitea.repository_owner}}:${{secrets.GITEA_TOKEN}}@/${{gitea.repository}}.git
NPMCI_TOKEN_NPM: ${{secrets.NPMCI_TOKEN_NPM}}
NPMCI_TOKEN_NPM2: ${{secrets.NPMCI_TOKEN_NPM2}}
NPMCI_GIT_GITHUBTOKEN: ${{secrets.NPMCI_GIT_GITHUBTOKEN}}
NPMCI_URL_CLOUDLY: ${{secrets.NPMCI_URL_CLOUDLY}}
jobs:
security:
runs-on: ubuntu-latest
continue-on-error: true
container:
image: ${{ env.IMAGE }}
steps:
- uses: actions/checkout@v3
- name: Install pnpm and npmci
run: |
pnpm install -g pnpm
pnpm install -g @ship.zone/npmci
- name: Run npm prepare
run: npmci npm prepare
- name: Audit production dependencies
run: |
npmci command npm config set registry https://registry.npmjs.org
npmci command pnpm audit --audit-level=high --prod
continue-on-error: true
- name: Audit development dependencies
run: |
npmci command npm config set registry https://registry.npmjs.org
npmci command pnpm audit --audit-level=high --dev
continue-on-error: true
test:
if: ${{ always() }}
needs: security
runs-on: ubuntu-latest
container:
image: ${{ env.IMAGE }}
steps:
- uses: actions/checkout@v3
- name: Test stable
run: |
npmci node install stable
npmci npm install
npmci npm test
- name: Test build
run: |
npmci node install stable
npmci npm install
npmci npm build

View File

@ -0,0 +1,124 @@
name: Default (tags)
on:
push:
tags:
- '*'
env:
IMAGE: code.foss.global/hosttoday/ht-docker-node:npmci
NPMCI_COMPUTED_REPOURL: https://${{gitea.repository_owner}}:${{secrets.GITEA_TOKEN}}@/${{gitea.repository}}.git
NPMCI_TOKEN_NPM: ${{secrets.NPMCI_TOKEN_NPM}}
NPMCI_TOKEN_NPM2: ${{secrets.NPMCI_TOKEN_NPM2}}
NPMCI_GIT_GITHUBTOKEN: ${{secrets.NPMCI_GIT_GITHUBTOKEN}}
NPMCI_URL_CLOUDLY: ${{secrets.NPMCI_URL_CLOUDLY}}
jobs:
security:
runs-on: ubuntu-latest
continue-on-error: true
container:
image: ${{ env.IMAGE }}
steps:
- uses: actions/checkout@v3
- name: Prepare
run: |
pnpm install -g pnpm
pnpm install -g @ship.zone/npmci
npmci npm prepare
- name: Audit production dependencies
run: |
npmci command npm config set registry https://registry.npmjs.org
npmci command pnpm audit --audit-level=high --prod
continue-on-error: true
- name: Audit development dependencies
run: |
npmci command npm config set registry https://registry.npmjs.org
npmci command pnpm audit --audit-level=high --dev
continue-on-error: true
test:
if: ${{ always() }}
needs: security
runs-on: ubuntu-latest
container:
image: ${{ env.IMAGE }}
steps:
- uses: actions/checkout@v3
- name: Prepare
run: |
pnpm install -g pnpm
pnpm install -g @ship.zone/npmci
npmci npm prepare
- name: Test stable
run: |
npmci node install stable
npmci npm install
npmci npm test
- name: Test build
run: |
npmci node install stable
npmci npm install
npmci npm build
release:
needs: test
if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
runs-on: ubuntu-latest
container:
image: ${{ env.IMAGE }}
steps:
- uses: actions/checkout@v3
- name: Prepare
run: |
pnpm install -g pnpm
pnpm install -g @ship.zone/npmci
npmci npm prepare
- name: Release
run: |
npmci node install stable
npmci npm publish
metadata:
needs: test
if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
runs-on: ubuntu-latest
container:
image: ${{ env.IMAGE }}
continue-on-error: true
steps:
- uses: actions/checkout@v3
- name: Prepare
run: |
pnpm install -g pnpm
pnpm install -g @ship.zone/npmci
npmci npm prepare
- name: Code quality
run: |
npmci command npm install -g typescript
npmci npm install
- name: Trigger
run: npmci trigger
- name: Build docs and upload artifacts
run: |
npmci node install stable
npmci npm install
pnpm install -g @git.zone/tsdoc
npmci command tsdoc
continue-on-error: true

13
changelog.md Normal file
View File

@ -0,0 +1,13 @@
# Changelog
## 1.2.1
fix(core): Fixed usage of plugins in project context and readme generation
## 1.2.0
feat(aidocs_classes): Enhance changelog generation by supporting complete generation in the absence of previous changelog files
## 1.1.42
fix(aidoc_classes): Improve commit message generation by handling empty diffs and updating changelog instructions
## 1.1.41
fix(aidoc_classes): Improve commit message generation by handling empty diffs and updating changelog instructions

View File

@ -1,12 +1,13 @@
{ {
"name": "@git.zone/tsdoc", "name": "@git.zone/tsdoc",
"version": "1.1.29", "version": "1.2.1",
"private": false, "private": false,
"description": "An advanced TypeScript documentation tool using AI to generate and enhance documentation for TypeScript projects.", "description": "An advanced TypeScript documentation tool using AI to generate and enhance documentation for TypeScript projects.",
"main": "dist_ts/index.js",
"typings": "dist_ts/index.d.ts",
"type": "module", "type": "module",
"author": "Lossless GmbH", "exports": {
".": "./dist_ts/index.js"
},
"author": "Task Venture Capital GmbH",
"license": "MIT", "license": "MIT",
"bin": { "bin": {
"tsdoc": "cli.js" "tsdoc": "cli.js"
@ -14,30 +15,32 @@
"scripts": { "scripts": {
"test": "(tstest test/) && npm run testCli", "test": "(tstest test/) && npm run testCli",
"testCli": "(node ./cli.ts.js) && (node ./cli.ts.js aidocs)", "testCli": "(node ./cli.ts.js) && (node ./cli.ts.js aidocs)",
"build": "(tsbuild --web --allowimplicitany)" "build": "(tsbuild --web --allowimplicitany)",
"buildDocs": "tsdoc"
}, },
"devDependencies": { "devDependencies": {
"@git.zone/tsbuild": "^2.1.76", "@git.zone/tsbuild": "^2.1.80",
"@git.zone/tsrun": "^1.2.46", "@git.zone/tsrun": "^1.2.46",
"@git.zone/tstest": "^1.0.90", "@git.zone/tstest": "^1.0.90",
"@push.rocks/tapbundle": "^5.0.23", "@push.rocks/tapbundle": "^5.0.23",
"@types/node": "^20.12.12" "@types/node": "^20.14.8"
}, },
"dependencies": { "dependencies": {
"@push.rocks/early": "^4.0.3", "@push.rocks/early": "^4.0.3",
"@push.rocks/npmextra": "^5.0.13", "@push.rocks/npmextra": "^5.0.23",
"@push.rocks/qenv": "^6.0.5", "@push.rocks/qenv": "^6.0.5",
"@push.rocks/smartai": "^0.0.17", "@push.rocks/smartai": "^0.0.17",
"@push.rocks/smartcli": "^4.0.10", "@push.rocks/smartcli": "^4.0.11",
"@push.rocks/smartdelay": "^3.0.5", "@push.rocks/smartdelay": "^3.0.5",
"@push.rocks/smartfile": "^11.0.14", "@push.rocks/smartfile": "^11.0.20",
"@push.rocks/smartgit": "^3.0.4",
"@push.rocks/smartinteract": "^2.0.15", "@push.rocks/smartinteract": "^2.0.15",
"@push.rocks/smartlog": "^3.0.1", "@push.rocks/smartlog": "^3.0.7",
"@push.rocks/smartlog-destination-local": "^9.0.2", "@push.rocks/smartlog-destination-local": "^9.0.2",
"@push.rocks/smartpath": "^5.0.18", "@push.rocks/smartpath": "^5.0.18",
"@push.rocks/smartshell": "^3.0.5", "@push.rocks/smartshell": "^3.0.5",
"typedoc": "^0.25.13", "typedoc": "^0.26.0",
"typescript": "^5.4.5" "typescript": "^5.5.2"
}, },
"files": [ "files": [
"ts/**/*", "ts/**/*",
@ -65,5 +68,13 @@
"API documentation", "API documentation",
"technical writing", "technical writing",
"code quality improvement" "code quality improvement"
] ],
"repository": {
"type": "git",
"url": "git+https://gitlab.com/gitzone/tsdoc.git"
},
"bugs": {
"url": "https://gitlab.com/gitzone/tsdoc/issues"
},
"homepage": "https://gitlab.com/gitzone/tsdoc#readme"
} }

582
pnpm-lock.yaml generated

File diff suppressed because it is too large Load Diff

View File

@ -1,4 +1,5 @@
# @git.zone/tsdoc # @git.zone/tsdoc
An advanced TypeScript documentation tool using AI to generate and enhance documentation for TypeScript projects. An advanced TypeScript documentation tool using AI to generate and enhance documentation for TypeScript projects.
## Install ## Install
@ -62,7 +63,7 @@ const tsconfigPath = plugins.path.join(__dirname, 'tsconfig.json');
const outputPath = plugins.path.join(__dirname, 'docs'); const outputPath = plugins.path.join(__dirname, 'docs');
await plugins.smartshellInstance.exec( await plugins.smartshellInstance.exec(
`typedoc --tsconfig ${tsconfigPath} --out ${outputPath} index.ts` `typedoc --tsconfig ${tsconfigPath} --out ${outputPath} index.ts`,
); );
``` ```
@ -243,7 +244,7 @@ import * as plugins from './plugins';
export const packageDir = plugins.path.join( export const packageDir = plugins.path.join(
plugins.smartpath.get.dirnameFromImportMetaUrl(import.meta.url), plugins.smartpath.get.dirnameFromImportMetaUrl(import.meta.url),
'../' '../',
); );
export const cwd = process.cwd(); export const cwd = process.cwd();
export const binDir = plugins.path.join(packageDir, './node_modules/.bin'); export const binDir = plugins.path.join(packageDir, './node_modules/.bin');
@ -273,7 +274,7 @@ import { AiDoc } from './classes.aidoc';
export const run = async () => { export const run = async () => {
const tsdocCli = new plugins.smartcli.Smartcli(); const tsdocCli = new plugins.smartcli.Smartcli();
tsdocCli.standardCommand().subscribe(async argvArg => { tsdocCli.standardCommand().subscribe(async (argvArg) => {
switch (true) { switch (true) {
case await TypeDoc.isTypeDocDir(paths.cwd): case await TypeDoc.isTypeDocDir(paths.cwd):
tsdocCli.triggerCommand('typedoc', argvArg); tsdocCli.triggerCommand('typedoc', argvArg);
@ -283,14 +284,14 @@ export const run = async () => {
} }
}); });
tsdocCli.addCommand('typedoc').subscribe(async argvArg => { tsdocCli.addCommand('typedoc').subscribe(async (argvArg) => {
const typeDocInstance = new TypeDoc(paths.cwd); const typeDocInstance = new TypeDoc(paths.cwd);
await typeDocInstance.compile({ await typeDocInstance.compile({
publicSubdir: argvArg.publicSubdir publicSubdir: argvArg.publicSubdir,
}); });
}); });
tsdocCli.addCommand('aidoc').subscribe(async argvArg => { tsdocCli.addCommand('aidoc').subscribe(async (argvArg) => {
const aidocInstance = new AiDoc(argvArg); const aidocInstance = new AiDoc(argvArg);
await aidocInstance.start(); await aidocInstance.start();
await aidocInstance.buildReadme(paths.cwd); await aidocInstance.buildReadme(paths.cwd);

View File

@ -8,20 +8,32 @@ let aidocs: tsdocs.AiDoc;
tap.test('should create an AIdocs class', async () => { tap.test('should create an AIdocs class', async () => {
aidocs = new tsdocs.AiDoc({ aidocs = new tsdocs.AiDoc({
'OPENAI_TOKEN': await testQenv.getEnvVarOnDemand('OPENAI_TOKEN') OPENAI_TOKEN: await testQenv.getEnvVarOnDemand('OPENAI_TOKEN'),
}); });
expect(aidocs).toBeInstanceOf(tsdocs.AiDoc); expect(aidocs).toBeInstanceOf(tsdocs.AiDoc);
}); });
tap.test('should start AIdocs', async () => { tap.test('should start AIdocs', async () => {
await aidocs.start(); await aidocs.start();
});
tap.skip.test('should start AIdocs', async () => {
await aidocs.buildReadme('./'); await aidocs.buildReadme('./');
}) });
tap.test('should start AIdocs', async () => { tap.skip.test('should start AIdocs', async () => {
await aidocs.start();
await aidocs.buildDescription('./'); await aidocs.buildDescription('./');
}) });
tap.test('should build commit object', async () => {
const commitObject = await aidocs.buildNextCommitObject('./');
console.log(commitObject);
expect(commitObject).not.toBeUndefined();
expect(commitObject).toHaveProperty('recommendedNextVersion');
expect(commitObject).toHaveProperty('recommendedNextVersionLevel');
expect(commitObject).toHaveProperty('recommendedNextVersionScope');
expect(commitObject).toHaveProperty('recommendedNextVersionMessage');
})
tap.start(); tap.start();

View File

@ -1,8 +1,8 @@
/** /**
* autocreated commitinfo by @pushrocks/commitinfo * autocreated commitinfo by @push.rocks/commitinfo
*/ */
export const commitinfo = { export const commitinfo = {
name: '@git.zone/tsdoc', name: '@git.zone/tsdoc',
version: '1.1.29', version: '1.2.1',
description: 'An advanced TypeScript documentation tool using AI to generate and enhance documentation for TypeScript projects.' description: 'An advanced TypeScript documentation tool using AI to generate and enhance documentation for TypeScript projects.'
} }

115
ts/aidocs_classes/commit.ts Normal file
View File

@ -0,0 +1,115 @@
import * as plugins from '../plugins.js';
import { AiDoc } from '../classes.aidoc.js';
import { ProjectContext } from './projectcontext.js';
export interface INextCommitObject {
recommendedNextVersionLevel: 'fix' | 'feat' | 'BREAKING CHANGE'; // the recommended next version level of the project
recommendedNextVersionScope: string; // the recommended scope name of the next version, like "core" or "cli", or specific class names.
recommendedNextVersionMessage: string; // the commit message. Don't put fix() feat() or BREAKING CHANGE in the message. Please just the message itself.
recommendedNextVersion: string; // the recommended next version of the project, x.x.x
changelog?: string; // the changelog for the next version
}
export class Commit {
private aiDocsRef: AiDoc;
private projectDir: string;
constructor(aiDocsRef: AiDoc, projectDirArg: string) {
this.aiDocsRef = aiDocsRef;
this.projectDir = projectDirArg;
}
public async buildNextCommitObject(): Promise<INextCommitObject> {
const smartgitInstance = new plugins.smartgit.Smartgit();
await smartgitInstance.init();
const gitRepo = await plugins.smartgit.GitRepo.fromOpeningRepoDir(
smartgitInstance,
this.projectDir
);
const diffString = await gitRepo.getUncommittedDiff();
const projectContext = new ProjectContext(this.projectDir);
let contextString = await projectContext.update();
contextString = `
${contextString}
Below is the diff of the uncommitted changes. If nothing is changed, there are no changes:
${diffString || 'No changes.'}
`;
let result = await this.aiDocsRef.openaiInstance.chat({
systemMessage: `
You create a commit message for a git commit.
The commit message should be based on the files in the project.
You should not include any licensing information.
You should not include any personal information.
Important: Answer only in valid JSON.
Your answer should be parseable with JSON.parse() without modifying anything.
Here is the structure of the JSON you should return:
{
recommendedNextVersionLevel: 'fix' | 'feat' | 'BREAKING CHANGE'; // the recommended next version level of the project
recommendedNextVersionScope: string; // the recommended scope name of the next version, like "core" or "cli", or specific class names.
recommendedNextVersionMessage: string; // the commit message. Don't put fix() feat() or BREAKING CHANGE in the message. Please just the message itself.
recommendedNextVersion: string; // the recommended next version of the project, x.x.x
}
You are being given the files of the project. You should use them to create the commit message.
Also you are given a diff
`,
messageHistory: [],
userMessage: contextString,
});
// console.log(result.message);
const resultObject: INextCommitObject = JSON.parse(
result.message.replace('```json', '').replace('```', '')
);
// lets build the changelog based on that
const commitMessages = await gitRepo.getAllCommitMessages();
const previousChangelogPath = plugins.path.join(this.projectDir, 'changelog.md');
let previousChangelog: plugins.smartfile.SmartFile;
if (await plugins.smartfile.fs.fileExists(previousChangelogPath)) {
previousChangelog = await plugins.smartfile.SmartFile.fromFilePath(previousChangelogPath);
}
let result2 = await this.aiDocsRef.openaiInstance.chat({
messageHistory: [],
systemMessage: `
You are building a changelog file for the projext.
Omit commits and versions that lack relevant changes.
You are given
* the previous changelog file (if available)
* the commit messages of the project
Only return the changelog file, so it can be written directly to changelog.md
For the latest version, that is not yet part of the commit messages, add a placeholder entry that uses {{nextVersion}} and {{nextVersionMessage}} as variables to filled later.
Only output newer versions and their changes compared to ones already mentioned. We take of appending your output later.
If there is no previous changelog file, generate a complete changelog from commit messages with heading and everything + the placeholder section mentioned above.
`,
userMessage: `
The previous changelog file is:
${!previousChangelog ? 'No previous changelog file found' : previousChangelog.contents.toString()}
Here are the commit messages so far:
${commitMessages.join('\n\n')}
`,
});
if (previousChangelog) {
let newChangelog = result2.message;
newChangelog = newChangelog.replace('# Changelog\n\n', '');
let oldChangelog = previousChangelog.contents.toString().replace('# Changelog\n\n', '');
newChangelog = `# Changelog\n\n${newChangelog}\n\n${oldChangelog}`;
resultObject.changelog = newChangelog;
} else {
resultObject.changelog = result2.message;
}
return resultObject;
}
}

View File

@ -45,7 +45,7 @@ Don't wrap the JSON in three ticks json!!!
console.log(result.message); console.log(result.message);
const resultObject: IDescriptionInterface = JSON.parse( const resultObject: IDescriptionInterface = JSON.parse(
result.message.replace('```json', '').replace('```', '') result.message.replace('```json', '').replace('```', ''),
); );
const npmextraJson = (await projectContext.gatherFiles()).smartfilesNpmextraJSON; const npmextraJson = (await projectContext.gatherFiles()).smartfilesNpmextraJSON;

View File

@ -1,3 +1,4 @@
export * from './commit.js';
export * from './description.js'; export * from './description.js';
export * from './projectcontext.js'; export * from './projectcontext.js';
export * from './readme.js'; export * from './readme.js';

View File

@ -13,28 +13,28 @@ export class ProjectContext {
public async gatherFiles() { public async gatherFiles() {
const smartfilePackageJSON = await plugins.smartfile.SmartFile.fromFilePath( const smartfilePackageJSON = await plugins.smartfile.SmartFile.fromFilePath(
plugins.path.join(this.projectDir, 'package.json'), plugins.path.join(this.projectDir, 'package.json'),
this.projectDir this.projectDir,
); );
const smartfilesReadme = await plugins.smartfile.SmartFile.fromFilePath( const smartfilesReadme = await plugins.smartfile.SmartFile.fromFilePath(
plugins.path.join(this.projectDir, 'readme.md'), plugins.path.join(this.projectDir, 'readme.md'),
this.projectDir this.projectDir,
); );
const smartfilesReadmeHints = await plugins.smartfile.SmartFile.fromFilePath( const smartfilesReadmeHints = await plugins.smartfile.SmartFile.fromFilePath(
plugins.path.join(this.projectDir, 'readme.hints.md'), plugins.path.join(this.projectDir, 'readme.hints.md'),
this.projectDir this.projectDir,
); );
const smartfilesNpmextraJSON = await plugins.smartfile.SmartFile.fromFilePath( const smartfilesNpmextraJSON = await plugins.smartfile.SmartFile.fromFilePath(
plugins.path.join(this.projectDir, 'npmextra.json'), plugins.path.join(this.projectDir, 'npmextra.json'),
this.projectDir this.projectDir,
); );
const smartfilesMod = await plugins.smartfile.fs.fileTreeToObject( const smartfilesMod = await plugins.smartfile.fs.fileTreeToObject(
this.projectDir, this.projectDir,
'ts*/**/*.ts' 'ts*/**/*.ts',
); );
const smartfilesTest = await plugins.smartfile.fs.fileTreeToObject( const smartfilesTest = await plugins.smartfile.fs.fileTreeToObject(
this.projectDir, this.projectDir,
'test/**/*.ts' 'test/**/*.ts',
); );
return { return {
smartfilePackageJSON, smartfilePackageJSON,
@ -47,10 +47,10 @@ export class ProjectContext {
} }
public async convertFilesToContext(filesArg: plugins.smartfile.SmartFile[]) { public async convertFilesToContext(filesArg: plugins.smartfile.SmartFile[]) {
console.log(`Using the following files for the documentation:`) console.log(`Using the following files for the documentation:`);
filesArg.map(fileArg => { filesArg.map((fileArg) => {
console.log(` -> ${fileArg.relative}`); console.log(` -> ${fileArg.relative}`);
}) });
return filesArg return filesArg
.map((smartfile) => { .map((smartfile) => {
return ` return `

View File

@ -3,7 +3,6 @@ import * as plugins from '../plugins.js';
import { ProjectContext } from './projectcontext.js'; import { ProjectContext } from './projectcontext.js';
export class Readme { export class Readme {
// INSTANCE // INSTANCE
private aiDocsRef: AiDoc; private aiDocsRef: AiDoc;
private projectDir: string; private projectDir: string;
@ -21,8 +20,10 @@ export class Readme {
const contextString = await projectContext.update(); const contextString = await projectContext.update();
// lets first check legal before introducung any cost // lets first check legal before introducung any cost
const npmExtraJson = JSON.parse(((await projectContext.gatherFiles()).smartfilesNpmextraJSON).contents.toString()); const npmExtraJson = JSON.parse(
const legalInfo = npmExtraJson?.tsdoc?.legal (await projectContext.gatherFiles()).smartfilesNpmextraJSON.contents.toString(),
);
const legalInfo = npmExtraJson?.tsdoc?.legal;
if (!legalInfo) { if (!legalInfo) {
const error = new Error(`No legal information found in npmextra.json`); const error = new Error(`No legal information found in npmextra.json`);
console.log(error); console.log(error);
@ -68,11 +69,8 @@ The Readme should follow the following template:
userMessage: contextString, userMessage: contextString,
}); });
finalReadmeString += result.message + '\n' + legalInfo; finalReadmeString += result.message + '\n' + legalInfo;
console.log(`\n======================\n`); console.log(`\n======================\n`);
console.log(result.message); console.log(result.message);
console.log(`\n======================\n`); console.log(`\n======================\n`);

View File

@ -7,7 +7,7 @@ export class AiDoc {
public npmextraKV: plugins.npmextra.KeyValueStore; public npmextraKV: plugins.npmextra.KeyValueStore;
public qenvInstance: plugins.qenv.Qenv; public qenvInstance: plugins.qenv.Qenv;
public smartinteractInstance: plugins.smartinteract.SmartInteract; public aidocInteract: plugins.smartinteract.SmartInteract;
public openaiInstance: plugins.smartai.OpenAiProvider; public openaiInstance: plugins.smartai.OpenAiProvider;
argvArg: any; argvArg: any;
@ -33,7 +33,7 @@ export class AiDoc {
public async start() { public async start() {
// lets care about prerequisites // lets care about prerequisites
this.smartinteractInstance = new plugins.smartinteract.SmartInteract(); this.aidocInteract = new plugins.smartinteract.SmartInteract();
this.qenvInstance = new plugins.qenv.Qenv(); this.qenvInstance = new plugins.qenv.Qenv();
if (!(await this.qenvInstance.getEnvVarOnDemand('OPENAI_TOKEN'))) { if (!(await this.qenvInstance.getEnvVarOnDemand('OPENAI_TOKEN'))) {
this.npmextraKV = new plugins.npmextra.KeyValueStore({ this.npmextraKV = new plugins.npmextra.KeyValueStore({
@ -51,9 +51,9 @@ export class AiDoc {
// lets try smartinteract // lets try smartinteract
// wait for a second until OpenAI fixes punycode problem... // wait for a second until OpenAI fixes punycode problem...
await plugins.smartdelay.delayFor(1000); await plugins.smartdelay.delayFor(1000);
const answerObject = await this.smartinteractInstance.askQuestion({ const answerObject = await this.aidocInteract.askQuestion({
type: 'input', type: 'input',
message: `Please provide your OpenAI token`, message: `Please provide your OpenAI token. This will be persisted in your home directory.`,
name: 'OPENAI_TOKEN', name: 'OPENAI_TOKEN',
default: '', default: '',
}); });
@ -84,4 +84,14 @@ export class AiDoc {
const descriptionInstance = new aiDocsClasses.Description(this, projectDirArg); const descriptionInstance = new aiDocsClasses.Description(this, projectDirArg);
return await descriptionInstance.build(); return await descriptionInstance.build();
} }
public async buildNextCommitObject(projectDirArg: string) {
const commitInstance = new aiDocsClasses.Commit(this, projectDirArg);
return await commitInstance.buildNextCommitObject();
}
public async getProjectContext(projectDirArg: string) {
const projectContextInstance = new aiDocsClasses.ProjectContext(projectDirArg);
return await projectContextInstance.gatherFiles();
}
} }

View File

@ -20,15 +20,15 @@ export class TypeDoc {
public async compile(options?: { publicSubdir?: string }) { public async compile(options?: { publicSubdir?: string }) {
const data = { const data = {
"compilerOptions": { compilerOptions: {
"experimentalDecorators": true, experimentalDecorators: true,
"useDefineForClassFields": false, useDefineForClassFields: false,
"target": "ES2022", target: 'ES2022',
"module": "NodeNext", module: 'NodeNext',
"moduleResolution": "NodeNext", moduleResolution: 'NodeNext',
"esModuleInterop": true, esModuleInterop: true,
"verbatimModuleSyntax": true, verbatimModuleSyntax: true,
"skipLibCheck": true, skipLibCheck: true,
}, },
include: [], include: [],
}; };
@ -51,7 +51,7 @@ export class TypeDoc {
targetDir = plugins.path.join(targetDir, options.publicSubdir); targetDir = plugins.path.join(targetDir, options.publicSubdir);
} }
await this.smartshellInstance.exec( await this.smartshellInstance.exec(
`typedoc --tsconfig ${paths.tsconfigFile} --out ${targetDir} ${startDirectory}/index.ts` `typedoc --tsconfig ${paths.tsconfigFile} --out ${targetDir} ${startDirectory}/index.ts`,
); );
plugins.smartfile.fs.remove(paths.tsconfigFile); plugins.smartfile.fs.remove(paths.tsconfigFile);
} }

View File

@ -36,7 +36,7 @@ export const run = async () => {
logger.log('info', `Generating new keywords...`); logger.log('info', `Generating new keywords...`);
logger.log('info', `This may take some time...`); logger.log('info', `This may take some time...`);
aidocInstance.buildDescription(paths.cwd); aidocInstance.buildDescription(paths.cwd);
}) });
tsdocCli.addCommand('test').subscribe((argvArg) => { tsdocCli.addCommand('test').subscribe((argvArg) => {
tsdocCli.triggerCommand('typedoc', argvArg); tsdocCli.triggerCommand('typedoc', argvArg);

View File

@ -1,7 +1,10 @@
import * as plugins from './plugins.js'; import * as plugins from './plugins.js';
// dirs // dirs
export const packageDir = plugins.path.join(plugins.smartpath.get.dirnameFromImportMetaUrl(import.meta.url), '../'); export const packageDir = plugins.path.join(
plugins.smartpath.get.dirnameFromImportMetaUrl(import.meta.url),
'../',
);
export const cwd = process.cwd(); export const cwd = process.cwd();
export const binDir = plugins.path.join(packageDir, './node_modules/.bin'); export const binDir = plugins.path.join(packageDir, './node_modules/.bin');
export const assetsDir = plugins.path.join(packageDir, './assets'); export const assetsDir = plugins.path.join(packageDir, './assets');

View File

@ -10,13 +10,27 @@ import * as smartai from '@push.rocks/smartai';
import * as smartcli from '@push.rocks/smartcli'; import * as smartcli from '@push.rocks/smartcli';
import * as smartdelay from '@push.rocks/smartdelay'; import * as smartdelay from '@push.rocks/smartdelay';
import * as smartfile from '@push.rocks/smartfile'; import * as smartfile from '@push.rocks/smartfile';
import * as smartgit from '@push.rocks/smartgit';
import * as smartinteract from '@push.rocks/smartinteract'; import * as smartinteract from '@push.rocks/smartinteract';
import * as smartlog from '@push.rocks/smartlog'; import * as smartlog from '@push.rocks/smartlog';
import * as smartlogDestinationLocal from '@push.rocks/smartlog-destination-local'; import * as smartlogDestinationLocal from '@push.rocks/smartlog-destination-local';
import * as smartpath from '@push.rocks/smartpath'; import * as smartpath from '@push.rocks/smartpath';
import * as smartshell from '@push.rocks/smartshell'; import * as smartshell from '@push.rocks/smartshell';
export { npmextra, qenv, smartai, smartcli, smartdelay, smartfile, smartinteract, smartlog, smartlogDestinationLocal, smartpath, smartshell }; export {
npmextra,
qenv,
smartai,
smartcli,
smartdelay,
smartfile,
smartgit,
smartinteract,
smartlog,
smartlogDestinationLocal,
smartpath,
smartshell,
};
// third party scope // third party scope
import * as typedoc from 'typedoc'; import * as typedoc from 'typedoc';