Compare commits
No commits in common. "master" and "v1.0.2" have entirely different histories.
@ -1,66 +0,0 @@
|
|||||||
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
|
|
||||||
@ -1,124 +0,0 @@
|
|||||||
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
|
|
||||||
10
.gitignore
vendored
10
.gitignore
vendored
@ -8,13 +8,13 @@ pages/
|
|||||||
# installs
|
# installs
|
||||||
node_modules/
|
node_modules/
|
||||||
|
|
||||||
# caches
|
# caches and builds
|
||||||
.yarn/
|
.yarn/
|
||||||
.cache/
|
.cache/
|
||||||
.rpt2_cache
|
|
||||||
|
|
||||||
# builds
|
|
||||||
dist/
|
dist/
|
||||||
dist_*/
|
dist_web/
|
||||||
|
dist_serve/
|
||||||
|
dist_ts_web/
|
||||||
|
|
||||||
# custom
|
# custom
|
||||||
|
mkdocs/originalrepo
|
||||||
|
|||||||
125
.gitlab-ci.yml
Normal file
125
.gitlab-ci.yml
Normal file
@ -0,0 +1,125 @@
|
|||||||
|
# gitzone standard
|
||||||
|
image: hosttoday/ht-docker-node:npmci
|
||||||
|
|
||||||
|
cache:
|
||||||
|
paths:
|
||||||
|
- .npmci_cache/
|
||||||
|
key: "$CI_BUILD_STAGE"
|
||||||
|
|
||||||
|
stages:
|
||||||
|
- security
|
||||||
|
- test
|
||||||
|
- release
|
||||||
|
- metadata
|
||||||
|
|
||||||
|
# ====================
|
||||||
|
# security stage
|
||||||
|
# ====================
|
||||||
|
mirror:
|
||||||
|
stage: security
|
||||||
|
script:
|
||||||
|
- npmci git mirror
|
||||||
|
tags:
|
||||||
|
- docker
|
||||||
|
- notpriv
|
||||||
|
|
||||||
|
snyk:
|
||||||
|
stage: security
|
||||||
|
script:
|
||||||
|
- npmci npm prepare
|
||||||
|
- npmci command npm install -g snyk
|
||||||
|
- npmci command npm install --ignore-scripts
|
||||||
|
- npmci command snyk test
|
||||||
|
tags:
|
||||||
|
- docker
|
||||||
|
- notpriv
|
||||||
|
|
||||||
|
# ====================
|
||||||
|
# test stage
|
||||||
|
# ====================
|
||||||
|
|
||||||
|
testLTS:
|
||||||
|
stage: test
|
||||||
|
script:
|
||||||
|
- npmci npm prepare
|
||||||
|
- npmci node install lts
|
||||||
|
- npmci npm install
|
||||||
|
- npmci npm test
|
||||||
|
coverage: /\d+.?\d+?\%\s*coverage/
|
||||||
|
tags:
|
||||||
|
- docker
|
||||||
|
- notpriv
|
||||||
|
|
||||||
|
testSTABLE:
|
||||||
|
stage: test
|
||||||
|
script:
|
||||||
|
- npmci npm prepare
|
||||||
|
- npmci node install stable
|
||||||
|
- npmci npm install
|
||||||
|
- npmci npm test
|
||||||
|
coverage: /\d+.?\d+?\%\s*coverage/
|
||||||
|
tags:
|
||||||
|
- docker
|
||||||
|
- notpriv
|
||||||
|
|
||||||
|
release:
|
||||||
|
stage: release
|
||||||
|
script:
|
||||||
|
- npmci node install stable
|
||||||
|
- npmci npm publish
|
||||||
|
only:
|
||||||
|
- tags
|
||||||
|
tags:
|
||||||
|
- docker
|
||||||
|
- notpriv
|
||||||
|
|
||||||
|
# ====================
|
||||||
|
# metadata stage
|
||||||
|
# ====================
|
||||||
|
codequality:
|
||||||
|
stage: metadata
|
||||||
|
image: docker:stable
|
||||||
|
allow_failure: true
|
||||||
|
services:
|
||||||
|
- docker:stable-dind
|
||||||
|
script:
|
||||||
|
- export SP_VERSION=$(echo "$CI_SERVER_VERSION" | sed 's/^\([0-9]*\)\.\([0-9]*\).*/\1-\2-stable/')
|
||||||
|
- docker run
|
||||||
|
--env SOURCE_CODE="$PWD"
|
||||||
|
--volume "$PWD":/code
|
||||||
|
--volume /var/run/docker.sock:/var/run/docker.sock
|
||||||
|
"registry.gitlab.com/gitlab-org/security-products/codequality:$SP_VERSION" /code
|
||||||
|
artifacts:
|
||||||
|
paths: [codeclimate.json]
|
||||||
|
tags:
|
||||||
|
- docker
|
||||||
|
- priv
|
||||||
|
|
||||||
|
trigger:
|
||||||
|
stage: metadata
|
||||||
|
script:
|
||||||
|
- npmci trigger
|
||||||
|
only:
|
||||||
|
- tags
|
||||||
|
tags:
|
||||||
|
- docker
|
||||||
|
- notpriv
|
||||||
|
|
||||||
|
pages:
|
||||||
|
image: hosttoday/ht-docker-node:npmci
|
||||||
|
stage: metadata
|
||||||
|
script:
|
||||||
|
- npmci command npm install -g typedoc typescript @gitzone/tsdoc
|
||||||
|
- npmci npm prepare
|
||||||
|
- npmci npm install
|
||||||
|
- npmci command typedoc --module "commonjs" --target "ES2016" --out public/ ts/
|
||||||
|
tags:
|
||||||
|
- docker
|
||||||
|
- notpriv
|
||||||
|
only:
|
||||||
|
- tags
|
||||||
|
artifacts:
|
||||||
|
expire_in: 1 week
|
||||||
|
paths:
|
||||||
|
- public
|
||||||
|
allow_failure: true
|
||||||
11
.vscode/launch.json
vendored
11
.vscode/launch.json
vendored
@ -1,11 +0,0 @@
|
|||||||
{
|
|
||||||
"version": "0.2.0",
|
|
||||||
"configurations": [
|
|
||||||
{
|
|
||||||
"command": "npm test",
|
|
||||||
"name": "Run npm test",
|
|
||||||
"request": "launch",
|
|
||||||
"type": "node-terminal"
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
|
||||||
26
.vscode/settings.json
vendored
26
.vscode/settings.json
vendored
@ -1,26 +0,0 @@
|
|||||||
{
|
|
||||||
"json.schemas": [
|
|
||||||
{
|
|
||||||
"fileMatch": ["/npmextra.json"],
|
|
||||||
"schema": {
|
|
||||||
"type": "object",
|
|
||||||
"properties": {
|
|
||||||
"npmci": {
|
|
||||||
"type": "object",
|
|
||||||
"description": "settings for npmci"
|
|
||||||
},
|
|
||||||
"gitzone": {
|
|
||||||
"type": "object",
|
|
||||||
"description": "settings for gitzone",
|
|
||||||
"properties": {
|
|
||||||
"projectType": {
|
|
||||||
"type": "string",
|
|
||||||
"enum": ["website", "element", "service", "npm", "wcc"]
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
|
||||||
109
changelog.md
109
changelog.md
@ -1,109 +0,0 @@
|
|||||||
# Changelog
|
|
||||||
|
|
||||||
## 2025-02-25 - 1.4.4 - fix(dependencies)
|
|
||||||
Update dependencies to latest versions
|
|
||||||
|
|
||||||
- Updated '@push.rocks/smartai' from '^0.0.17' to '^0.4.2'
|
|
||||||
- Updated 'typedoc' from '^0.26.1' to '^0.27.9'
|
|
||||||
|
|
||||||
## 2025-01-14 - 1.4.3 - fix(aidocs_classes)
|
|
||||||
Improve readme generation instructions to ensure correct markdown formatting.
|
|
||||||
|
|
||||||
- Added guidance to avoid using backticks at the beginning and end of readme generation to prevent markdown issues.
|
|
||||||
- Clarified that the output is directly written to readme.md and backticks should only be used for code blocks.
|
|
||||||
|
|
||||||
## 2024-10-28 - 1.4.2 - fix(cli)
|
|
||||||
Ensure async completion for aidoc readme and description generation
|
|
||||||
|
|
||||||
- Added await statements for asynchronous methods buildReadme and buildDescription in the aidoc command.
|
|
||||||
|
|
||||||
## 2024-10-28 - 1.4.1 - fix(readme)
|
|
||||||
Correct async call to getModuleSubDirs in readme generation.
|
|
||||||
|
|
||||||
- Fixed an issue with asynchronous handling in readme generation for submodules.
|
|
||||||
- Ensured that getModuleSubDirs function is called with await to handle promises properly.
|
|
||||||
|
|
||||||
## 2024-10-28 - 1.4.0 - feat(aidocs)
|
|
||||||
Added support for building readmes for sub-modules in aidocs
|
|
||||||
|
|
||||||
- Updated the `Readme` class to handle monorepo projects by generating readmes for sub-modules.
|
|
||||||
- Integrated `tspublish` to identify sub-modules for readme generation.
|
|
||||||
|
|
||||||
## 2024-06-24 - 1.3.12 - fix(aidocs)
|
|
||||||
Fix changelog generation by handling leading newlines
|
|
||||||
|
|
||||||
- Fixed handling of leading newlines in the changelog to ensure proper formatting.
|
|
||||||
|
|
||||||
## 2024-06-23 - 1.3.11 - fix(core)
|
|
||||||
Fixed new changelog formatting issue to retain consistent spacing.
|
|
||||||
|
|
||||||
- Adjusted the new changelog generation to ensure consistent spacing for improved readability.
|
|
||||||
|
|
||||||
## 2024-06-23 - 1.3.10 - fix(aidocs_classes)
|
|
||||||
Fix changelog format to remove extra newline
|
|
||||||
|
|
||||||
- Updated `ts/aidocs_classes/commit.ts` to fix the changelog format.
|
|
||||||
|
|
||||||
## 2024-06-23 - 1.3.9 - fix(aidoc)
|
|
||||||
Fix changelog generation by properly stripping markdown code fences
|
|
||||||
|
|
||||||
- Corrected the changelog generation code to ensure markdown code fences are properly stripped.
|
|
||||||
|
|
||||||
|
|
||||||
## 2024-06-23 - 1.3.8 - fix(changelog)
|
|
||||||
Fix changelog generation by properly stripping markdown code fences
|
|
||||||
|
|
||||||
- Corrected the changelog generation code to ensure markdown code fences are properly stripped.
|
|
||||||
|
|
||||||
## 2024-06-23 - 1.3.7 - fix(aidoc)
|
|
||||||
Update to include package-lock.json in uncommitted changes check
|
|
||||||
|
|
||||||
- Modified the getUncommittedDiff method call in commit.ts to include package-lock.json along with pnpm-lock.yaml
|
|
||||||
|
|
||||||
|
|
||||||
## 2024-06-23 - 1.3.6 - fix(commit)
|
|
||||||
Fixed issue with retrieving uncommitted diffs in git repository
|
|
||||||
|
|
||||||
- Revised logic to correctly handle uncommitted changes by using an array for `getUncommittedDiff` method
|
|
||||||
- Ensured proper handling and representation of uncommitted changes in the output
|
|
||||||
|
|
||||||
|
|
||||||
## 2024-06-23 - 1.3.5 - fix(aidocs_classes)
|
|
||||||
Refactor and enhance changelog formatting
|
|
||||||
|
|
||||||
- Updated the `commit.ts` file to improve the changelog formatting and ensure consistency.
|
|
||||||
- Enhanced the changelog instructions to include summarizing messages for omitted commits.
|
|
||||||
- Removed unnecessary console logging in `projectcontext.ts`.
|
|
||||||
|
|
||||||
|
|
||||||
```markdown
|
|
||||||
## 2024-06-23 - 1.3.3 - fix(aidocs_classes)
|
|
||||||
Fix changelog formatting issue in commit class
|
|
||||||
|
|
||||||
## 2024-06-23 - 1.3.2 - fix(aidocs_classes)
|
|
||||||
Fix minor bugs and update dependencies in aidocs_classes
|
|
||||||
|
|
||||||
## 2024-06-23 - 1.3.1 - fix(aidocs_classes)
|
|
||||||
Fix typo in INextCommitObject interface and update date format in changelog generation.
|
|
||||||
|
|
||||||
## 2024-06-23 - 1.3.0 - fix(aidocs_classes)
|
|
||||||
Fix typo in INextCommitObject interface
|
|
||||||
|
|
||||||
## 2024-06-23 - 1.2.4 - feat(core)
|
|
||||||
Added smarttime dependency and improved changelog generation
|
|
||||||
|
|
||||||
## 2024-06-23 - 1.2.3 - fix(logging)
|
|
||||||
Refactor logger initialization to use commitinfo data
|
|
||||||
|
|
||||||
## 2024-06-23 - 1.2.2 - fix(aidocs)
|
|
||||||
Fix bug in AiDoc class causing undefined token handling
|
|
||||||
|
|
||||||
## 2024-06-23 - 1.2.0 - fix(core)
|
|
||||||
Fixed usage of plugins in project context and readme generation
|
|
||||||
|
|
||||||
## 2024-06-23 - 1.1.42 - feat(aidocs_classes)
|
|
||||||
Enhance changelog generation by supporting complete generation in the absence of previous changelog files
|
|
||||||
|
|
||||||
## 2024-06-23 - 1.1.41 - fix(aidocs_classes)
|
|
||||||
Improve commit message generation by handling empty diffs and updating changelog instructions
|
|
||||||
```
|
|
||||||
@ -1,4 +0,0 @@
|
|||||||
#!/usr/bin/env node
|
|
||||||
process.env.CLI_CALL = 'true';
|
|
||||||
import * as cliTool from './ts/index.js';
|
|
||||||
cliTool.runCli();
|
|
||||||
4
cli.js
4
cli.js
@ -1,4 +0,0 @@
|
|||||||
#!/usr/bin/env node
|
|
||||||
process.env.CLI_CALL = 'true';
|
|
||||||
const cliTool = await import('./dist_ts/index.js');
|
|
||||||
cliTool.runCli();
|
|
||||||
@ -1,5 +0,0 @@
|
|||||||
#!/usr/bin/env node
|
|
||||||
process.env.CLI_CALL = 'true';
|
|
||||||
|
|
||||||
import * as tsrun from '@git.zone/tsrun';
|
|
||||||
tsrun.runPath('./cli.child.js', import.meta.url);
|
|
||||||
@ -1,34 +1,17 @@
|
|||||||
{
|
{
|
||||||
"gitzone": {
|
"gitzone": {
|
||||||
"projectType": "npm",
|
|
||||||
"module": {
|
"module": {
|
||||||
"githost": "gitlab.com",
|
"githost": "gitlab.com",
|
||||||
"gitscope": "gitzone",
|
"gitscope": "gitzone",
|
||||||
"gitrepo": "tsdoc",
|
"gitrepo": "tsdoc",
|
||||||
"shortDescription": "a tool for better documentation",
|
"shortDescription": "a tool for better documentation",
|
||||||
"npmPackagename": "@git.zone/tsdoc",
|
"npmPackagename": "@gitzone/tsdoc",
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"projectDomain": "git.zone",
|
"projectDomain": "git.zone"
|
||||||
"description": "An advanced TypeScript documentation tool using AI to generate and enhance documentation for TypeScript projects.",
|
|
||||||
"keywords": [
|
|
||||||
"TypeScript",
|
|
||||||
"documentation generation",
|
|
||||||
"AI-enhanced documentation",
|
|
||||||
"CLI tool",
|
|
||||||
"code analysis",
|
|
||||||
"automated documentation",
|
|
||||||
"developer tools",
|
|
||||||
"API documentation",
|
|
||||||
"technical writing",
|
|
||||||
"code quality improvement"
|
|
||||||
]
|
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"npmci": {
|
"npmci": {
|
||||||
"npmGlobalTools": [],
|
"npmGlobalTools": [],
|
||||||
"npmAccessLevel": "public"
|
"npmAccessLevel": "public"
|
||||||
},
|
|
||||||
"tsdoc": {
|
|
||||||
"legal": "\n## License and Legal Information\n\nThis repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository. \n\n**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.\n\n### Trademarks\n\nThis project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.\n\n### Company Information\n\nTask Venture Capital GmbH \nRegistered at District court Bremen HRB 35230 HB, Germany\n\nFor any legal inquiries or if you require further information, please contact us via email at hello@task.vc.\n\nBy using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.\n"
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
1710
package-lock.json
generated
Normal file
1710
package-lock.json
generated
Normal file
File diff suppressed because it is too large
Load Diff
92
package.json
92
package.json
@ -1,82 +1,28 @@
|
|||||||
{
|
{
|
||||||
"name": "@git.zone/tsdoc",
|
"name": "@gitzone/tsdoc",
|
||||||
"version": "1.4.4",
|
"version": "1.0.2",
|
||||||
"private": false,
|
"private": false,
|
||||||
"description": "An advanced TypeScript documentation tool using AI to generate and enhance documentation for TypeScript projects.",
|
"description": "a tool for better documentation",
|
||||||
"type": "module",
|
"main": "dist/index.js",
|
||||||
"exports": {
|
"typings": "dist/index.d.ts",
|
||||||
".": "./dist_ts/index.js"
|
"author": "Lossless GmbH",
|
||||||
},
|
|
||||||
"author": "Task Venture Capital GmbH",
|
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"bin": {
|
|
||||||
"tsdoc": "cli.js"
|
|
||||||
},
|
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"test": "(tstest test/) && npm run testCli",
|
"test": "(tstest test/)",
|
||||||
"testCli": "(node ./cli.ts.js) && (node ./cli.ts.js aidocs)",
|
"build": "(tsbuild)",
|
||||||
"build": "(tsbuild --web --allowimplicitany)",
|
"buildMkdocs": "(cd mkdocs/originalrepo && docker rmi -f mkdocs && docker build -t mkdocs .)",
|
||||||
"buildDocs": "tsdoc"
|
"format": "(gitzone format)"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@git.zone/tsbuild": "^2.1.80",
|
"@gitzone/tsbuild": "^2.0.22",
|
||||||
"@git.zone/tsrun": "^1.2.46",
|
"@gitzone/tstest": "^1.0.15",
|
||||||
"@git.zone/tstest": "^1.0.90",
|
"@pushrocks/tapbundle": "^3.0.7",
|
||||||
"@push.rocks/tapbundle": "^5.0.23",
|
"@types/node": "^12.0.0",
|
||||||
"@types/node": "^22.8.1"
|
"tslint": "^5.11.0",
|
||||||
|
"tslint-config-prettier": "^1.15.0"
|
||||||
},
|
},
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@git.zone/tspublish": "^1.5.5",
|
"@pushrocks/smartcli": "^3.0.7",
|
||||||
"@push.rocks/early": "^4.0.3",
|
"typedoc": "^0.14.2"
|
||||||
"@push.rocks/npmextra": "^5.0.23",
|
}
|
||||||
"@push.rocks/qenv": "^6.0.5",
|
|
||||||
"@push.rocks/smartai": "^0.4.2",
|
|
||||||
"@push.rocks/smartcli": "^4.0.11",
|
|
||||||
"@push.rocks/smartdelay": "^3.0.5",
|
|
||||||
"@push.rocks/smartfile": "^11.0.20",
|
|
||||||
"@push.rocks/smartgit": "^3.1.0",
|
|
||||||
"@push.rocks/smartinteract": "^2.0.15",
|
|
||||||
"@push.rocks/smartlog": "^3.0.7",
|
|
||||||
"@push.rocks/smartlog-destination-local": "^9.0.2",
|
|
||||||
"@push.rocks/smartpath": "^5.0.18",
|
|
||||||
"@push.rocks/smartshell": "^3.0.5",
|
|
||||||
"@push.rocks/smarttime": "^4.0.6",
|
|
||||||
"typedoc": "^0.27.9",
|
|
||||||
"typescript": "^5.5.2"
|
|
||||||
},
|
|
||||||
"files": [
|
|
||||||
"ts/**/*",
|
|
||||||
"ts_web/**/*",
|
|
||||||
"dist/**/*",
|
|
||||||
"dist_*/**/*",
|
|
||||||
"dist_ts/**/*",
|
|
||||||
"dist_ts_web/**/*",
|
|
||||||
"assets/**/*",
|
|
||||||
"cli.js",
|
|
||||||
"npmextra.json",
|
|
||||||
"readme.md"
|
|
||||||
],
|
|
||||||
"browserslist": [
|
|
||||||
"last 1 chrome versions"
|
|
||||||
],
|
|
||||||
"keywords": [
|
|
||||||
"TypeScript",
|
|
||||||
"documentation generation",
|
|
||||||
"AI-enhanced documentation",
|
|
||||||
"CLI tool",
|
|
||||||
"code analysis",
|
|
||||||
"automated documentation",
|
|
||||||
"developer tools",
|
|
||||||
"API documentation",
|
|
||||||
"technical writing",
|
|
||||||
"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"
|
|
||||||
}
|
}
|
||||||
|
|||||||
10568
pnpm-lock.yaml
generated
10568
pnpm-lock.yaml
generated
File diff suppressed because it is too large
Load Diff
@ -1,5 +0,0 @@
|
|||||||
* module needs to be installed globally
|
|
||||||
* alternatively can be used through npx, if installed locally
|
|
||||||
* cli parameters are concluded from ./ts/cli.ts
|
|
||||||
* this module is not intended for API use.
|
|
||||||
* Read carefully through the TypeScript files. Don't make stuff up.
|
|
||||||
328
readme.md
328
readme.md
@ -1,328 +0,0 @@
|
|||||||
# @git.zone/tsdoc
|
|
||||||
|
|
||||||
An advanced TypeScript documentation tool using AI to generate and enhance documentation for TypeScript projects.
|
|
||||||
|
|
||||||
## Install
|
|
||||||
|
|
||||||
To install `@git.zone/tsdoc`, you can either install it globally or use it with `npx`.
|
|
||||||
|
|
||||||
### Global Installation
|
|
||||||
|
|
||||||
You can install `@git.zone/tsdoc` globally on your system using npm:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
npm install -g @git.zone/tsdoc
|
|
||||||
```
|
|
||||||
|
|
||||||
### Usage with npx
|
|
||||||
|
|
||||||
If you prefer not to install it globally, you can use it with `npx`:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
npx @git.zone/tsdoc <command>
|
|
||||||
```
|
|
||||||
|
|
||||||
## Usage
|
|
||||||
|
|
||||||
`@git.zone/tsdoc` provides a comprehensive CLI tool and advanced AI-enhanced features to generate and enhance documentation for your TypeScript projects.
|
|
||||||
|
|
||||||
### Using the CLI
|
|
||||||
|
|
||||||
The primary interface for `@git.zone/tsdoc` is through its command-line tool. Below, we'll explore the different commands available and provide examples of how to use them.
|
|
||||||
|
|
||||||
### Commands
|
|
||||||
|
|
||||||
#### `tsdoc` - Auto-detect Documentation Format
|
|
||||||
|
|
||||||
The standard command will automatically detect the documentation format of your project and generate the appropriate documentation.
|
|
||||||
|
|
||||||
```bash
|
|
||||||
tsdoc
|
|
||||||
```
|
|
||||||
|
|
||||||
### Example
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
// In a TypeScript project, run the above command.
|
|
||||||
```
|
|
||||||
|
|
||||||
#### `tsdoc typedoc` - Generate Documentation using TypeDoc
|
|
||||||
|
|
||||||
The `typedoc` command will generate documentation compliant with the TypeDoc format.
|
|
||||||
|
|
||||||
```bash
|
|
||||||
tsdoc typedoc --publicSubdir docs
|
|
||||||
```
|
|
||||||
|
|
||||||
### Example
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import * as plugins from '@push.rocks/smartfile';
|
|
||||||
|
|
||||||
const tsconfigPath = plugins.path.join(__dirname, 'tsconfig.json');
|
|
||||||
const outputPath = plugins.path.join(__dirname, 'docs');
|
|
||||||
|
|
||||||
await plugins.smartshellInstance.exec(
|
|
||||||
`typedoc --tsconfig ${tsconfigPath} --out ${outputPath} index.ts`,
|
|
||||||
);
|
|
||||||
```
|
|
||||||
|
|
||||||
#### `tsdoc aidoc` - Generate AI-Enhanced Documentation
|
|
||||||
|
|
||||||
The `aidoc` command will use AI to generate an enhanced README and update your project description.
|
|
||||||
|
|
||||||
```bash
|
|
||||||
tsdoc aidoc
|
|
||||||
```
|
|
||||||
|
|
||||||
### Example
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import { AiDoc } from '@git.zone/tsdoc';
|
|
||||||
|
|
||||||
(async () => {
|
|
||||||
const aidoc = new AiDoc();
|
|
||||||
await aidoc.start();
|
|
||||||
await aidoc.buildReadme('./');
|
|
||||||
await aidoc.buildDescription('./');
|
|
||||||
})();
|
|
||||||
```
|
|
||||||
|
|
||||||
#### `tsdoc test` - Test Your Documentation Setup
|
|
||||||
|
|
||||||
The `test` command will test your current documentation setup, ensuring everything is configured correctly.
|
|
||||||
|
|
||||||
```bash
|
|
||||||
tsdoc test
|
|
||||||
```
|
|
||||||
|
|
||||||
### Example
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import * as plugins from '@git.zone/tsdoc';
|
|
||||||
|
|
||||||
await plugins.runCli().catch((err) => {
|
|
||||||
console.error(err);
|
|
||||||
process.exit(1);
|
|
||||||
});
|
|
||||||
```
|
|
||||||
|
|
||||||
## Features in Depth
|
|
||||||
|
|
||||||
### Using Plugins
|
|
||||||
|
|
||||||
`@git.zone/tsdoc` extensively uses plugins to extend its capabilities.
|
|
||||||
|
|
||||||
### Available Plugins
|
|
||||||
|
|
||||||
- **npmextra**: Manage npm project-related configurations.
|
|
||||||
- **qenv**: Environment variable management.
|
|
||||||
- **smartai**: AI integration.
|
|
||||||
- **smartcli**: CLI helper.
|
|
||||||
- **smartdelay**: Simple delay utility.
|
|
||||||
- **smartfile**: File system utilities.
|
|
||||||
- **smartinteract**: Interaction helper.
|
|
||||||
- **smartlog**: Logging utility.
|
|
||||||
- **smartlogDestinationLocal**: Local file destination for logging.
|
|
||||||
- **smartpath**: Path utilities.
|
|
||||||
- **smartshell**: Shell command execution.
|
|
||||||
- **typedoc**: Documentation generation.
|
|
||||||
|
|
||||||
### Example Usage of Plugins
|
|
||||||
|
|
||||||
#### Path Management
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import * as path from 'path';
|
|
||||||
|
|
||||||
const packageDir = path.join(__dirname, '../');
|
|
||||||
const cwd = process.cwd();
|
|
||||||
const binDir = path.join(packageDir, './node_modules/.bin');
|
|
||||||
const assetsDir = path.join(packageDir, './assets');
|
|
||||||
const publicDir = path.join(cwd, './public');
|
|
||||||
const tsDir = path.join(cwd, './ts');
|
|
||||||
const tsconfigFile = path.join(assetsDir, './tsconfig.json');
|
|
||||||
const typedocOptionsFile = path.join(assetsDir, './typedoc.json');
|
|
||||||
```
|
|
||||||
|
|
||||||
#### Logging
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import * as plugins from './plugins';
|
|
||||||
|
|
||||||
const logger = new plugins.smartlog.Smartlog({
|
|
||||||
logContext: {
|
|
||||||
company: 'Some Company',
|
|
||||||
companyunit: 'Some CompanyUnit',
|
|
||||||
containerName: 'Some Containername',
|
|
||||||
environment: 'local',
|
|
||||||
runtime: 'node',
|
|
||||||
zone: 'gitzone',
|
|
||||||
},
|
|
||||||
minimumLogLevel: 'silly',
|
|
||||||
});
|
|
||||||
|
|
||||||
logger.addLogDestination(new plugins.smartlogDestinationLocal.DestinationLocal());
|
|
||||||
```
|
|
||||||
|
|
||||||
## Advanced Usage
|
|
||||||
|
|
||||||
### Using `TypeDoc` Class
|
|
||||||
|
|
||||||
The `TypeDoc` class provides utility methods to compile TypeScript documentation.
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import { TypeDoc } from '@git.zone/tsdoc/classes.typedoc';
|
|
||||||
|
|
||||||
const typeDocInstance = new TypeDoc(paths.cwd);
|
|
||||||
|
|
||||||
await typeDocInstance.compile({
|
|
||||||
publicSubdir: 'docs',
|
|
||||||
});
|
|
||||||
```
|
|
||||||
|
|
||||||
### Using `AiDoc` Class
|
|
||||||
|
|
||||||
The `AiDoc` class integrates with AI services to enhance your documentation.
|
|
||||||
|
|
||||||
#### Initializing and Using AI
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import { AiDoc } from '@git.zone/tsdoc';
|
|
||||||
|
|
||||||
const aiDoc = new AiDoc({ OPENAI_TOKEN: 'your-openai-token' });
|
|
||||||
|
|
||||||
await aiDoc.start();
|
|
||||||
await aiDoc.buildReadme('./');
|
|
||||||
await aiDoc.buildDescription('./');
|
|
||||||
```
|
|
||||||
|
|
||||||
#### Retrieving AI Tokens
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import * as plugins from '@git.zone/tsdoc/plugins';
|
|
||||||
|
|
||||||
const qenv = new plugins.qenv.Qenv();
|
|
||||||
const openaiToken = await qenv.getEnvVarOnDemand('OPENAI_TOKEN');
|
|
||||||
```
|
|
||||||
|
|
||||||
### Testing
|
|
||||||
|
|
||||||
The provided tests demonstrate how to verify the functionality of the `@git.zone/tsdoc` tool.
|
|
||||||
|
|
||||||
#### Example Test Script
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import { expect, tap } from '@push.rocks/tapbundle';
|
|
||||||
import * as tsdoc from '../ts/index';
|
|
||||||
|
|
||||||
tap.test('should create AiDoc instance', async () => {
|
|
||||||
const aidoc = new tsdoc.AiDoc({ OPENAI_TOKEN: 'dummy-token' });
|
|
||||||
expect(aidoc).toBeInstanceOf(tsdoc.AiDoc);
|
|
||||||
});
|
|
||||||
|
|
||||||
tap.test('should start AiDoc', async () => {
|
|
||||||
const aidoc = new tsdoc.AiDoc({ OPENAI_TOKEN: 'dummy-token' });
|
|
||||||
await aidoc.start();
|
|
||||||
await aidoc.buildReadme('./');
|
|
||||||
await aidoc.buildDescription('./');
|
|
||||||
});
|
|
||||||
|
|
||||||
tap.start();
|
|
||||||
```
|
|
||||||
|
|
||||||
### Internals
|
|
||||||
|
|
||||||
The `@git.zone/tsdoc` consists of several internal classes and utilities that streamline its functionality.
|
|
||||||
|
|
||||||
#### File Paths Management
|
|
||||||
|
|
||||||
Located in `ts/paths.ts`, the file defines various directories and file paths used by the tool.
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import * as plugins from './plugins';
|
|
||||||
|
|
||||||
export const packageDir = plugins.path.join(
|
|
||||||
plugins.smartpath.get.dirnameFromImportMetaUrl(import.meta.url),
|
|
||||||
'../',
|
|
||||||
);
|
|
||||||
export const cwd = process.cwd();
|
|
||||||
export const binDir = plugins.path.join(packageDir, './node_modules/.bin');
|
|
||||||
export const assetsDir = plugins.path.join(packageDir, './assets');
|
|
||||||
export const publicDir = plugins.path.join(cwd, './public');
|
|
||||||
export const tsDir = plugins.path.join(cwd, './ts');
|
|
||||||
export const tsconfigFile = plugins.path.join(assetsDir, './tsconfig.json');
|
|
||||||
export const typedocOptionsFile = plugins.path.join(assetsDir, './typedoc.json');
|
|
||||||
```
|
|
||||||
|
|
||||||
#### Utility Commands
|
|
||||||
|
|
||||||
Define utility commands that streamline various processes.
|
|
||||||
|
|
||||||
##### Example: SmartCLI Usage
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
// Import required modules and plugins
|
|
||||||
import * as plugins from './plugins';
|
|
||||||
import * as paths from './paths';
|
|
||||||
|
|
||||||
// TypeDoc and AiDoc classes
|
|
||||||
import { TypeDoc } from './classes.typedoc';
|
|
||||||
import { AiDoc } from './classes.aidoc';
|
|
||||||
|
|
||||||
// Export a run function
|
|
||||||
export const run = async () => {
|
|
||||||
const tsdocCli = new plugins.smartcli.Smartcli();
|
|
||||||
|
|
||||||
tsdocCli.standardCommand().subscribe(async (argvArg) => {
|
|
||||||
switch (true) {
|
|
||||||
case await TypeDoc.isTypeDocDir(paths.cwd):
|
|
||||||
tsdocCli.triggerCommand('typedoc', argvArg);
|
|
||||||
break;
|
|
||||||
default:
|
|
||||||
console.error(`Cannot determine docs format at ${paths.cwd}`);
|
|
||||||
}
|
|
||||||
});
|
|
||||||
|
|
||||||
tsdocCli.addCommand('typedoc').subscribe(async (argvArg) => {
|
|
||||||
const typeDocInstance = new TypeDoc(paths.cwd);
|
|
||||||
await typeDocInstance.compile({
|
|
||||||
publicSubdir: argvArg.publicSubdir,
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
tsdocCli.addCommand('aidoc').subscribe(async (argvArg) => {
|
|
||||||
const aidocInstance = new AiDoc(argvArg);
|
|
||||||
await aidocInstance.start();
|
|
||||||
await aidocInstance.buildReadme(paths.cwd);
|
|
||||||
await aidocInstance.buildDescription(paths.cwd);
|
|
||||||
});
|
|
||||||
|
|
||||||
tsdocCli.startParse();
|
|
||||||
};
|
|
||||||
```
|
|
||||||
|
|
||||||
By leveraging these functionalities, you can configure and extend `@git.zone/tsdoc` to fit your specific documentation generation needs.
|
|
||||||
|
|
||||||
### Further Enhancements
|
|
||||||
|
|
||||||
The `@git.zone/tsdoc` tool is designed to be extensible. Explore the source files and plugins to add more functionality or integrate with other tools as needed. This README provides an extensive overview of the commands and features but it's always beneficial to dive into the source code to understand the intricacies and potential customizations. Happy documenting!
|
|
||||||
|
|
||||||
## License and Legal Information
|
|
||||||
|
|
||||||
This repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository.
|
|
||||||
|
|
||||||
**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.
|
|
||||||
|
|
||||||
### Trademarks
|
|
||||||
|
|
||||||
This project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.
|
|
||||||
|
|
||||||
### Company Information
|
|
||||||
|
|
||||||
Task Venture Capital GmbH
|
|
||||||
Registered at District court Bremen HRB 35230 HB, Germany
|
|
||||||
|
|
||||||
For any legal inquiries or if you require further information, please contact us via email at hello@task.vc.
|
|
||||||
|
|
||||||
By using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.
|
|
||||||
@ -1,39 +0,0 @@
|
|||||||
import { tap, expect } from '@push.rocks/tapbundle';
|
|
||||||
import * as qenv from '@push.rocks/qenv';
|
|
||||||
let testQenv = new qenv.Qenv('./', '.nogit/');
|
|
||||||
|
|
||||||
import * as tsdocs from '../ts/index.js';
|
|
||||||
|
|
||||||
let aidocs: tsdocs.AiDoc;
|
|
||||||
|
|
||||||
tap.test('should create an AIdocs class', async () => {
|
|
||||||
aidocs = new tsdocs.AiDoc({
|
|
||||||
OPENAI_TOKEN: await testQenv.getEnvVarOnDemand('OPENAI_TOKEN'),
|
|
||||||
});
|
|
||||||
expect(aidocs).toBeInstanceOf(tsdocs.AiDoc);
|
|
||||||
});
|
|
||||||
|
|
||||||
tap.test('should start AIdocs', async () => {
|
|
||||||
await aidocs.start();
|
|
||||||
});
|
|
||||||
|
|
||||||
tap.skip.test('should start AIdocs', async () => {
|
|
||||||
await aidocs.buildReadme('./');
|
|
||||||
});
|
|
||||||
|
|
||||||
tap.skip.test('should start AIdocs', async () => {
|
|
||||||
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();
|
|
||||||
10
test/test.ts
10
test/test.ts
@ -1,8 +1,8 @@
|
|||||||
import { expect, tap } from '@push.rocks/tapbundle';
|
import { expect, tap } from '@pushrocks/tapbundle';
|
||||||
import * as tsdoc from '../ts/index.js';
|
import * as tsdoc from '../ts/index'
|
||||||
|
|
||||||
tap.test('first test', async () => {
|
tap.test('first test', async () => {
|
||||||
console.log('test');
|
console.log(tsdoc.standardExport)
|
||||||
});
|
})
|
||||||
|
|
||||||
tap.start();
|
tap.start()
|
||||||
|
|||||||
@ -1,8 +0,0 @@
|
|||||||
/**
|
|
||||||
* autocreated commitinfo by @push.rocks/commitinfo
|
|
||||||
*/
|
|
||||||
export const commitinfo = {
|
|
||||||
name: '@git.zone/tsdoc',
|
|
||||||
version: '1.4.4',
|
|
||||||
description: 'An advanced TypeScript documentation tool using AI to generate and enhance documentation for TypeScript projects.'
|
|
||||||
}
|
|
||||||
@ -1,134 +0,0 @@
|
|||||||
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.
|
|
||||||
recommendedNextVersionDetails: string[]; // detailed bullet points for the changelog
|
|
||||||
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 diffStringArray = await gitRepo.getUncommittedDiff([
|
|
||||||
'pnpm-lock.yaml',
|
|
||||||
'package-lock.json',
|
|
||||||
]);
|
|
||||||
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:
|
|
||||||
|
|
||||||
${diffStringArray[0] ? diffStringArray.join('\n\n') : '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:
|
|
||||||
|
|
||||||
interface {
|
|
||||||
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.
|
|
||||||
recommendedNextVersionDetails: string[]; // detailed bullet points for the changelog
|
|
||||||
recommendedNextVersion: string; // the recommended next version of the project, x.x.x
|
|
||||||
}
|
|
||||||
|
|
||||||
For the recommendedNextVersionDetails, please only add a detail entries to the array if it has an obvious value to the reader.
|
|
||||||
|
|
||||||
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('```', '')
|
|
||||||
);
|
|
||||||
|
|
||||||
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);
|
|
||||||
}
|
|
||||||
|
|
||||||
if (!previousChangelog) {
|
|
||||||
// lets build the changelog based on that
|
|
||||||
const commitMessages = await gitRepo.getAllCommitMessages();
|
|
||||||
console.log(JSON.stringify(commitMessages, null, 2));
|
|
||||||
let result2 = await this.aiDocsRef.openaiInstance.chat({
|
|
||||||
messageHistory: [],
|
|
||||||
systemMessage: `
|
|
||||||
You are building a changelog.md file for the project.
|
|
||||||
Omit commits and versions that lack relevant changes, but make sure to mention them as a range with a summarizing message instead.
|
|
||||||
|
|
||||||
A changelog entry should look like this:
|
|
||||||
|
|
||||||
## yyyy-mm-dd - x.x.x - scope here
|
|
||||||
main descriptiom here
|
|
||||||
|
|
||||||
- detailed bullet points follow
|
|
||||||
|
|
||||||
You are given:
|
|
||||||
* the commit messages of the project
|
|
||||||
|
|
||||||
Only return the changelog file, so it can be written directly to changelog.md`,
|
|
||||||
userMessage: `
|
|
||||||
Here are the commit messages:
|
|
||||||
|
|
||||||
${JSON.stringify(commitMessages, null, 2)}
|
|
||||||
`,
|
|
||||||
});
|
|
||||||
|
|
||||||
previousChangelog = await plugins.smartfile.SmartFile.fromString(
|
|
||||||
previousChangelogPath,
|
|
||||||
result2.message.replaceAll('```markdown', '').replaceAll('```', ''),
|
|
||||||
'utf8'
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
let oldChangelog = previousChangelog.contents.toString().replace('# Changelog\n\n', '');
|
|
||||||
if (oldChangelog.startsWith('\n')) {
|
|
||||||
oldChangelog = oldChangelog.replace('\n', '');
|
|
||||||
}
|
|
||||||
let newDateString = new plugins.smarttime.ExtendedDate().exportToHyphedSortableDate();
|
|
||||||
let newChangelog = `# Changelog\n\n${`## ${newDateString} - {{nextVersion}} - {{nextVersionScope}}
|
|
||||||
{{nextVersionMessage}}
|
|
||||||
|
|
||||||
{{nextVersionDetails}}`}\n\n${oldChangelog}`;
|
|
||||||
resultObject.changelog = newChangelog;
|
|
||||||
|
|
||||||
return resultObject;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@ -1,73 +0,0 @@
|
|||||||
import type { AiDoc } from '../classes.aidoc.js';
|
|
||||||
import * as plugins from '../plugins.js';
|
|
||||||
import { ProjectContext } from './projectcontext.js';
|
|
||||||
|
|
||||||
interface IDescriptionInterface {
|
|
||||||
description: string;
|
|
||||||
keywords: string[];
|
|
||||||
}
|
|
||||||
|
|
||||||
export class Description {
|
|
||||||
// INSTANCE
|
|
||||||
private aiDocsRef: AiDoc;
|
|
||||||
private projectDir: string;
|
|
||||||
|
|
||||||
constructor(aiDocsRef: AiDoc, projectDirArg: string) {
|
|
||||||
this.aiDocsRef = aiDocsRef;
|
|
||||||
this.projectDir = projectDirArg;
|
|
||||||
}
|
|
||||||
|
|
||||||
public async build() {
|
|
||||||
// we can now assemble the directory structure.
|
|
||||||
const projectContext = new ProjectContext(this.projectDir);
|
|
||||||
const contextString = await projectContext.update();
|
|
||||||
|
|
||||||
let result = await this.aiDocsRef.openaiInstance.chat({
|
|
||||||
systemMessage: `
|
|
||||||
You create a json adhering the following interface:
|
|
||||||
{
|
|
||||||
description: string; // a sensible short, one sentence description of the project
|
|
||||||
keywords: string[]; // an array of tags that describe the project
|
|
||||||
}
|
|
||||||
|
|
||||||
The description should be based on what you understand from the project's files.
|
|
||||||
The keywords should be based on use cases you see from the files.
|
|
||||||
Don't be cheap about the way you think.
|
|
||||||
|
|
||||||
Important: Answer only in valid JSON.
|
|
||||||
You answer should be parseable with JSON.parse() without modifying anything.
|
|
||||||
|
|
||||||
Don't wrap the JSON in three ticks json!!!
|
|
||||||
`,
|
|
||||||
messageHistory: [],
|
|
||||||
userMessage: contextString,
|
|
||||||
});
|
|
||||||
|
|
||||||
console.log(result.message);
|
|
||||||
const resultObject: IDescriptionInterface = JSON.parse(
|
|
||||||
result.message.replace('```json', '').replace('```', ''),
|
|
||||||
);
|
|
||||||
|
|
||||||
const npmextraJson = (await projectContext.gatherFiles()).smartfilesNpmextraJSON;
|
|
||||||
const npmextraJsonContent = JSON.parse(npmextraJson.contents.toString());
|
|
||||||
|
|
||||||
npmextraJsonContent.gitzone.module.description = resultObject.description;
|
|
||||||
npmextraJsonContent.gitzone.module.keywords = resultObject.keywords;
|
|
||||||
|
|
||||||
npmextraJson.contents = Buffer.from(JSON.stringify(npmextraJsonContent, null, 2));
|
|
||||||
await npmextraJson.write();
|
|
||||||
|
|
||||||
// do the same with packageJson
|
|
||||||
const packageJson = (await projectContext.gatherFiles()).smartfilePackageJSON;
|
|
||||||
const packageJsonContent = JSON.parse(packageJson.contents.toString());
|
|
||||||
packageJsonContent.description = resultObject.description;
|
|
||||||
packageJsonContent.keywords = resultObject.keywords;
|
|
||||||
packageJson.contents = Buffer.from(JSON.stringify(packageJsonContent, null, 2));
|
|
||||||
await packageJson.write();
|
|
||||||
|
|
||||||
console.log(`\n======================\n`);
|
|
||||||
console.log(JSON.stringify(resultObject, null, 2));
|
|
||||||
console.log(`\n======================\n`);
|
|
||||||
return result.message;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@ -1,4 +0,0 @@
|
|||||||
export * from './commit.js';
|
|
||||||
export * from './description.js';
|
|
||||||
export * from './projectcontext.js';
|
|
||||||
export * from './readme.js';
|
|
||||||
@ -1,84 +0,0 @@
|
|||||||
import * as plugins from '../plugins.js';
|
|
||||||
|
|
||||||
export class ProjectContext {
|
|
||||||
public static async fromDir(dirArg: string) {}
|
|
||||||
|
|
||||||
// INSTANCE
|
|
||||||
public projectDir: string;
|
|
||||||
|
|
||||||
constructor(projectDirArg: string) {
|
|
||||||
this.projectDir = projectDirArg;
|
|
||||||
}
|
|
||||||
|
|
||||||
public async gatherFiles() {
|
|
||||||
const smartfilePackageJSON = await plugins.smartfile.SmartFile.fromFilePath(
|
|
||||||
plugins.path.join(this.projectDir, 'package.json'),
|
|
||||||
this.projectDir,
|
|
||||||
);
|
|
||||||
const smartfilesReadme = await plugins.smartfile.SmartFile.fromFilePath(
|
|
||||||
plugins.path.join(this.projectDir, 'readme.md'),
|
|
||||||
this.projectDir,
|
|
||||||
);
|
|
||||||
|
|
||||||
const smartfilesReadmeHints = await plugins.smartfile.SmartFile.fromFilePath(
|
|
||||||
plugins.path.join(this.projectDir, 'readme.hints.md'),
|
|
||||||
this.projectDir,
|
|
||||||
);
|
|
||||||
const smartfilesNpmextraJSON = await plugins.smartfile.SmartFile.fromFilePath(
|
|
||||||
plugins.path.join(this.projectDir, 'npmextra.json'),
|
|
||||||
this.projectDir,
|
|
||||||
);
|
|
||||||
const smartfilesMod = await plugins.smartfile.fs.fileTreeToObject(
|
|
||||||
this.projectDir,
|
|
||||||
'ts*/**/*.ts',
|
|
||||||
);
|
|
||||||
const smartfilesTest = await plugins.smartfile.fs.fileTreeToObject(
|
|
||||||
this.projectDir,
|
|
||||||
'test/**/*.ts',
|
|
||||||
);
|
|
||||||
return {
|
|
||||||
smartfilePackageJSON,
|
|
||||||
smartfilesReadme,
|
|
||||||
smartfilesReadmeHints,
|
|
||||||
smartfilesNpmextraJSON,
|
|
||||||
smartfilesMod,
|
|
||||||
smartfilesTest,
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
public async convertFilesToContext(filesArg: plugins.smartfile.SmartFile[]) {
|
|
||||||
filesArg.map((fileArg) => {
|
|
||||||
// console.log(` -> ${fileArg.relative}`);
|
|
||||||
});
|
|
||||||
return filesArg
|
|
||||||
.map((smartfile) => {
|
|
||||||
return `
|
|
||||||
====== START OF FILE ${smartfile.relative} ======
|
|
||||||
|
|
||||||
${smartfile.contents.toString()}
|
|
||||||
|
|
||||||
====== END OF FILE ${smartfile.relative} ======
|
|
||||||
`;
|
|
||||||
})
|
|
||||||
.join('\n');
|
|
||||||
}
|
|
||||||
|
|
||||||
private async buildContext(dirArg: string) {
|
|
||||||
const files = await this.gatherFiles();
|
|
||||||
let context = await this.convertFilesToContext([
|
|
||||||
files.smartfilePackageJSON,
|
|
||||||
files.smartfilesReadme,
|
|
||||||
files.smartfilesReadmeHints,
|
|
||||||
files.smartfilesNpmextraJSON,
|
|
||||||
...files.smartfilesMod,
|
|
||||||
...files.smartfilesTest,
|
|
||||||
]);
|
|
||||||
// console.log(context);
|
|
||||||
return context;
|
|
||||||
}
|
|
||||||
|
|
||||||
public async update() {
|
|
||||||
const result = await this.buildContext(this.projectDir);
|
|
||||||
return result;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@ -1,144 +0,0 @@
|
|||||||
import type { AiDoc } from '../classes.aidoc.js';
|
|
||||||
import * as plugins from '../plugins.js';
|
|
||||||
import * as paths from '../paths.js';
|
|
||||||
import { ProjectContext } from './projectcontext.js';
|
|
||||||
import { logger } from '../logging.js';
|
|
||||||
|
|
||||||
export class Readme {
|
|
||||||
// INSTANCE
|
|
||||||
private aiDocsRef: AiDoc;
|
|
||||||
private projectDir: string;
|
|
||||||
|
|
||||||
constructor(aiDocsRef: AiDoc, projectDirArg: string) {
|
|
||||||
this.aiDocsRef = aiDocsRef;
|
|
||||||
this.projectDir = projectDirArg;
|
|
||||||
}
|
|
||||||
|
|
||||||
public async build() {
|
|
||||||
let finalReadmeString = ``;
|
|
||||||
|
|
||||||
// we can now assemble the directory structure.
|
|
||||||
const projectContext = new ProjectContext(this.projectDir);
|
|
||||||
const contextString = await projectContext.update();
|
|
||||||
|
|
||||||
// lets first check legal before introducung any cost
|
|
||||||
const npmExtraJson = JSON.parse(
|
|
||||||
(await projectContext.gatherFiles()).smartfilesNpmextraJSON.contents.toString()
|
|
||||||
);
|
|
||||||
const legalInfo = npmExtraJson?.tsdoc?.legal;
|
|
||||||
if (!legalInfo) {
|
|
||||||
const error = new Error(`No legal information found in npmextra.json`);
|
|
||||||
console.log(error);
|
|
||||||
}
|
|
||||||
|
|
||||||
let result = await this.aiDocsRef.openaiInstance.chat({
|
|
||||||
systemMessage: `
|
|
||||||
You create markdown readmes for npm projects. You only output the markdown readme.
|
|
||||||
|
|
||||||
The Readme should follow the following template:
|
|
||||||
|
|
||||||
# Project Name
|
|
||||||
[
|
|
||||||
The name is the module name of package.json
|
|
||||||
The description is in the description field of package.json
|
|
||||||
]
|
|
||||||
|
|
||||||
## Install
|
|
||||||
[
|
|
||||||
Write a short text on how to install the project
|
|
||||||
]
|
|
||||||
|
|
||||||
## Usage
|
|
||||||
[
|
|
||||||
Give code examples here.
|
|
||||||
Construct sensible scenarios for the user.
|
|
||||||
Make sure to show a complete set of features of the module.
|
|
||||||
Don't omit use cases.
|
|
||||||
It does not matter how much time you need.
|
|
||||||
ALWAYS USE ESM SYNTAX AND TYPESCRIPT.
|
|
||||||
DON'T CHICKEN OUT. Write at least 4000 words. More if necessary.
|
|
||||||
If there is already a readme, take the Usage section as base. Remove outdated content, and expand and improve upon the valid parts.
|
|
||||||
Super important: Check for completenes.
|
|
||||||
Don't include any licensing information. This will be added in a later step.
|
|
||||||
Avoid "in conclusions".
|
|
||||||
|
|
||||||
Good to know:
|
|
||||||
* npmextra.json contains overall module information.
|
|
||||||
* readme.hints.md provides valuable hints about module ideas.
|
|
||||||
]
|
|
||||||
`,
|
|
||||||
messageHistory: [],
|
|
||||||
userMessage: contextString,
|
|
||||||
});
|
|
||||||
|
|
||||||
finalReadmeString += result.message + '\n' + legalInfo;
|
|
||||||
|
|
||||||
console.log(`\n======================\n`);
|
|
||||||
console.log(result.message);
|
|
||||||
console.log(`\n======================\n`);
|
|
||||||
|
|
||||||
const readme = (await projectContext.gatherFiles()).smartfilesReadme;
|
|
||||||
readme.contents = Buffer.from(finalReadmeString);
|
|
||||||
await readme.write();
|
|
||||||
|
|
||||||
// lets care about monorepo aspects
|
|
||||||
const tsPublishInstance = new plugins.tspublish.TsPublish();
|
|
||||||
const subModules = await tsPublishInstance.getModuleSubDirs(paths.cwd);
|
|
||||||
logger.log('info', `Found ${Object.keys(subModules).length} sub modules`);
|
|
||||||
for (const subModule of Object.keys(subModules)) {
|
|
||||||
logger.log('info', `Building readme for ${subModule}`);
|
|
||||||
const subModuleContextString = await projectContext.update();
|
|
||||||
let result = await this.aiDocsRef.openaiInstance.chat({
|
|
||||||
systemMessage: `
|
|
||||||
You create markdown readmes for npm projects. You only output the markdown readme.
|
|
||||||
|
|
||||||
IMPORTANT: YOU ARE NOW CREATING THE README FOR THE FOLLOWING SUB MODULE: ${subModule} !!!!!!!!!!!
|
|
||||||
The Sub Module will be published with the following data:
|
|
||||||
${JSON.stringify(plugins.smartfile.fs.toStringSync(plugins.path.join(paths.cwd, subModule, 'tspublish.json')), null, 2)}
|
|
||||||
|
|
||||||
|
|
||||||
The Readme should follow the following template:
|
|
||||||
|
|
||||||
# Project Name
|
|
||||||
[
|
|
||||||
The name is the module name of package.json
|
|
||||||
The description is in the description field of package.json
|
|
||||||
]
|
|
||||||
|
|
||||||
## Install
|
|
||||||
[
|
|
||||||
Write a short text on how to install the project
|
|
||||||
]
|
|
||||||
|
|
||||||
## Usage
|
|
||||||
[
|
|
||||||
Give code examples here.
|
|
||||||
Construct sensible scenarios for the user.
|
|
||||||
Make sure to show a complete set of features of the module.
|
|
||||||
Don't omit use cases.
|
|
||||||
It does not matter how much time you need.
|
|
||||||
ALWAYS USE ESM SYNTAX AND TYPESCRIPT.
|
|
||||||
DON'T CHICKEN OUT. Write at least 4000 words. More if necessary.
|
|
||||||
If there is already a readme, take the Usage section as base. Remove outdated content, and expand and improve upon the valid parts.
|
|
||||||
Super important: Check for completenes.
|
|
||||||
Don't include any licensing information. This will be added in a later step.
|
|
||||||
Avoid "in conclusions".
|
|
||||||
|
|
||||||
Good to know:
|
|
||||||
* npmextra.json contains overall module information.
|
|
||||||
* readme.hints.md provides valuable hints about module ideas.
|
|
||||||
* Your output lands directly in the readme.md file.
|
|
||||||
* Don't use \`\`\` at the beginning or the end. It'll cause problems. Only use it for codeblocks. You are directly writing markdown. No need to introduce it weirdly.
|
|
||||||
]
|
|
||||||
`,
|
|
||||||
messageHistory: [],
|
|
||||||
userMessage: subModuleContextString,
|
|
||||||
});
|
|
||||||
|
|
||||||
const subModuleReadmeString = result.message + '\n' + legalInfo;
|
|
||||||
await plugins.smartfile.memory.toFs(subModuleReadmeString, plugins.path.join(paths.cwd, subModule, 'readme.md'));
|
|
||||||
logger.log('success', `Built readme for ${subModule}`);
|
|
||||||
}
|
|
||||||
return result.message;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@ -1,97 +0,0 @@
|
|||||||
import * as plugins from './plugins.js';
|
|
||||||
|
|
||||||
import * as aiDocsClasses from './aidocs_classes/index.js';
|
|
||||||
|
|
||||||
export class AiDoc {
|
|
||||||
private openaiToken: string;
|
|
||||||
|
|
||||||
public npmextraKV: plugins.npmextra.KeyValueStore;
|
|
||||||
public qenvInstance: plugins.qenv.Qenv;
|
|
||||||
public aidocInteract: plugins.smartinteract.SmartInteract;
|
|
||||||
public openaiInstance: plugins.smartai.OpenAiProvider;
|
|
||||||
|
|
||||||
argvArg: any;
|
|
||||||
|
|
||||||
constructor(argvArg?: any) {
|
|
||||||
this.argvArg = argvArg;
|
|
||||||
}
|
|
||||||
|
|
||||||
private printSanitizedToken() {
|
|
||||||
// Check if the token length is greater than the sum of startLength and endLength
|
|
||||||
let printToken: string;
|
|
||||||
if (this.openaiToken.length > 6) {
|
|
||||||
// Extract the beginning and end parts of the token
|
|
||||||
const start = this.openaiToken.substring(0, 3);
|
|
||||||
const end = this.openaiToken.substring(this.openaiToken.length - 3);
|
|
||||||
printToken = `${start}...${end}`;
|
|
||||||
} else {
|
|
||||||
// If the token is not long enough, return it as is
|
|
||||||
printToken = this.openaiToken;
|
|
||||||
}
|
|
||||||
console.log(`OpenAI Token on record: ${printToken}`);
|
|
||||||
}
|
|
||||||
|
|
||||||
public async start() {
|
|
||||||
// lets care about prerequisites
|
|
||||||
this.aidocInteract = new plugins.smartinteract.SmartInteract();
|
|
||||||
this.qenvInstance = new plugins.qenv.Qenv();
|
|
||||||
if (!(await this.qenvInstance.getEnvVarOnDemand('OPENAI_TOKEN'))) {
|
|
||||||
this.npmextraKV = new plugins.npmextra.KeyValueStore({
|
|
||||||
typeArg: 'userHomeDir',
|
|
||||||
identityArg: 'tsdoc',
|
|
||||||
mandatoryKeys: ['OPENAI_TOKEN'],
|
|
||||||
});
|
|
||||||
|
|
||||||
const missingKeys = await this.npmextraKV.getMissingMandatoryKeys();
|
|
||||||
if (missingKeys.length > 0) {
|
|
||||||
// lets try argv
|
|
||||||
if (this.argvArg?.OPENAI_TOKEN) {
|
|
||||||
this.openaiToken = this.argvArg.OPENAI_TOKEN;
|
|
||||||
} else {
|
|
||||||
// lets try smartinteract
|
|
||||||
// wait for a second until OpenAI fixes punycode problem...
|
|
||||||
await plugins.smartdelay.delayFor(1000);
|
|
||||||
const answerObject = await this.aidocInteract.askQuestion({
|
|
||||||
type: 'input',
|
|
||||||
message: `Please provide your OpenAI token. This will be persisted in your home directory.`,
|
|
||||||
name: 'OPENAI_TOKEN',
|
|
||||||
default: '',
|
|
||||||
});
|
|
||||||
this.openaiToken = answerObject.value;
|
|
||||||
}
|
|
||||||
|
|
||||||
this.printSanitizedToken();
|
|
||||||
await this.npmextraKV.writeKey('OPENAI_TOKEN', this.openaiToken);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
if (!this.openaiToken) {
|
|
||||||
this.openaiToken = await this.npmextraKV.readKey('OPENAI_TOKEN');
|
|
||||||
}
|
|
||||||
|
|
||||||
// lets assume we have an OPENAI_Token now
|
|
||||||
this.openaiInstance = new plugins.smartai.OpenAiProvider({
|
|
||||||
openaiToken: this.openaiToken,
|
|
||||||
});
|
|
||||||
await this.openaiInstance.start();
|
|
||||||
}
|
|
||||||
|
|
||||||
public async buildReadme(projectDirArg: string) {
|
|
||||||
const readmeInstance = new aiDocsClasses.Readme(this, projectDirArg);
|
|
||||||
return await readmeInstance.build();
|
|
||||||
}
|
|
||||||
|
|
||||||
public async buildDescription(projectDirArg: string) {
|
|
||||||
const descriptionInstance = new aiDocsClasses.Description(this, projectDirArg);
|
|
||||||
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();
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@ -1,58 +0,0 @@
|
|||||||
import * as plugins from './plugins.js';
|
|
||||||
import * as paths from './paths.js';
|
|
||||||
|
|
||||||
export class TypeDoc {
|
|
||||||
public smartshellInstance = new plugins.smartshell.Smartshell({
|
|
||||||
executor: 'bash',
|
|
||||||
pathDirectories: [paths.binDir],
|
|
||||||
});
|
|
||||||
|
|
||||||
// Static
|
|
||||||
public static async isTypeDocDir(dirPathArg: string): Promise<boolean> {
|
|
||||||
return true;
|
|
||||||
}
|
|
||||||
|
|
||||||
// Instance
|
|
||||||
public typedocDirectory: string;
|
|
||||||
constructor(dirPathArg) {
|
|
||||||
this.typedocDirectory = dirPathArg;
|
|
||||||
}
|
|
||||||
|
|
||||||
public async compile(options?: { publicSubdir?: string }) {
|
|
||||||
const data = {
|
|
||||||
compilerOptions: {
|
|
||||||
experimentalDecorators: true,
|
|
||||||
useDefineForClassFields: false,
|
|
||||||
target: 'ES2022',
|
|
||||||
module: 'NodeNext',
|
|
||||||
moduleResolution: 'NodeNext',
|
|
||||||
esModuleInterop: true,
|
|
||||||
verbatimModuleSyntax: true,
|
|
||||||
skipLibCheck: true,
|
|
||||||
},
|
|
||||||
include: [],
|
|
||||||
};
|
|
||||||
let startDirectory = '';
|
|
||||||
if (plugins.smartfile.fs.isDirectory(plugins.path.join(paths.cwd, './ts'))) {
|
|
||||||
data.include.push(plugins.path.join(paths.cwd, './ts/**/*'));
|
|
||||||
startDirectory = 'ts';
|
|
||||||
}
|
|
||||||
|
|
||||||
if (plugins.smartfile.fs.isDirectory(plugins.path.join(paths.cwd, './ts_web'))) {
|
|
||||||
data.include.push(plugins.path.join(paths.cwd, './ts_web/**/*'));
|
|
||||||
if (!startDirectory) {
|
|
||||||
startDirectory = 'ts_web';
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
await plugins.smartfile.memory.toFs(JSON.stringify(data), paths.tsconfigFile);
|
|
||||||
let targetDir = paths.publicDir;
|
|
||||||
if (options?.publicSubdir) {
|
|
||||||
targetDir = plugins.path.join(targetDir, options.publicSubdir);
|
|
||||||
}
|
|
||||||
await this.smartshellInstance.exec(
|
|
||||||
`typedoc --tsconfig ${paths.tsconfigFile} --out ${targetDir} ${startDirectory}/index.ts`,
|
|
||||||
);
|
|
||||||
plugins.smartfile.fs.remove(paths.tsconfigFile);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
49
ts/cli.ts
49
ts/cli.ts
@ -1,49 +0,0 @@
|
|||||||
import * as plugins from './plugins.js';
|
|
||||||
import * as paths from './paths.js';
|
|
||||||
import { logger } from './logging.js';
|
|
||||||
|
|
||||||
import { TypeDoc } from './classes.typedoc.js';
|
|
||||||
import { AiDoc } from './classes.aidoc.js';
|
|
||||||
|
|
||||||
export const run = async () => {
|
|
||||||
const tsdocCli = new plugins.smartcli.Smartcli();
|
|
||||||
|
|
||||||
tsdocCli.standardCommand().subscribe(async (argvArg) => {
|
|
||||||
logger.log('warn', `Auto detecting environment!`);
|
|
||||||
switch (true) {
|
|
||||||
case await TypeDoc.isTypeDocDir(paths.cwd):
|
|
||||||
logger.log('ok', `Detected TypeDoc compliant directory at ${paths.cwd}`);
|
|
||||||
tsdocCli.triggerCommand('typedoc', argvArg);
|
|
||||||
break;
|
|
||||||
default:
|
|
||||||
logger.log('error', `Cannot determine docs format at ${paths.cwd}`);
|
|
||||||
}
|
|
||||||
});
|
|
||||||
|
|
||||||
tsdocCli.addCommand('typedoc').subscribe(async (argvArg) => {
|
|
||||||
const typeDocInstance = new TypeDoc(paths.cwd);
|
|
||||||
await typeDocInstance.compile({
|
|
||||||
publicSubdir: argvArg.publicSubdir,
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
tsdocCli.addCommand('aidoc').subscribe(async (argvArg) => {
|
|
||||||
const aidocInstance = new AiDoc();
|
|
||||||
await aidocInstance.start();
|
|
||||||
logger.log('info', `Generating new readme...`);
|
|
||||||
logger.log('info', `This may take some time...`);
|
|
||||||
await aidocInstance.buildReadme(paths.cwd);
|
|
||||||
logger.log('info', `Generating new keywords...`);
|
|
||||||
logger.log('info', `This may take some time...`);
|
|
||||||
await aidocInstance.buildDescription(paths.cwd);
|
|
||||||
});
|
|
||||||
|
|
||||||
tsdocCli.addCommand('test').subscribe((argvArg) => {
|
|
||||||
tsdocCli.triggerCommand('typedoc', argvArg);
|
|
||||||
process.on('exit', async () => {
|
|
||||||
await plugins.smartfile.fs.remove(paths.publicDir);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
tsdocCli.startParse();
|
|
||||||
};
|
|
||||||
14
ts/index.ts
14
ts/index.ts
@ -1,12 +1,4 @@
|
|||||||
import * as early from '@push.rocks/early';
|
import * as plugins from './tsdoc.plugins';
|
||||||
early.start('tsdoc');
|
|
||||||
import * as plugins from './plugins.js';
|
|
||||||
import * as cli from './cli.js';
|
|
||||||
early.stop();
|
|
||||||
|
|
||||||
export const runCli = async () => {
|
import * as cli from './tsdoc.cli';
|
||||||
await cli.run();
|
cli.run();
|
||||||
};
|
|
||||||
|
|
||||||
// exports
|
|
||||||
export * from './classes.aidoc.js';
|
|
||||||
@ -1,6 +0,0 @@
|
|||||||
import { commitinfo } from './00_commitinfo_data.js';
|
|
||||||
import * as plugins from './plugins.js';
|
|
||||||
|
|
||||||
export const logger = plugins.smartlog.Smartlog.createForCommitinfo(commitinfo);
|
|
||||||
|
|
||||||
logger.addLogDestination(new plugins.smartlogDestinationLocal.DestinationLocal());
|
|
||||||
16
ts/paths.ts
16
ts/paths.ts
@ -1,16 +0,0 @@
|
|||||||
import * as plugins from './plugins.js';
|
|
||||||
|
|
||||||
// dirs
|
|
||||||
export const packageDir = plugins.path.join(
|
|
||||||
plugins.smartpath.get.dirnameFromImportMetaUrl(import.meta.url),
|
|
||||||
'../',
|
|
||||||
);
|
|
||||||
export const cwd = process.cwd();
|
|
||||||
export const binDir = plugins.path.join(packageDir, './node_modules/.bin');
|
|
||||||
export const assetsDir = plugins.path.join(packageDir, './assets');
|
|
||||||
export const publicDir = plugins.path.join(cwd, './public');
|
|
||||||
export const tsDir = plugins.path.join(cwd, './ts');
|
|
||||||
|
|
||||||
// files
|
|
||||||
export const tsconfigFile = plugins.path.join(assetsDir, './tsconfig.json');
|
|
||||||
export const typedocOptionsFile = plugins.path.join(assetsDir, './typedoc.json');
|
|
||||||
@ -1,45 +0,0 @@
|
|||||||
// node native
|
|
||||||
import * as path from 'path';
|
|
||||||
|
|
||||||
export { path };
|
|
||||||
|
|
||||||
// pushrocks scope
|
|
||||||
import * as npmextra from '@push.rocks/npmextra';
|
|
||||||
import * as qenv from '@push.rocks/qenv';
|
|
||||||
import * as smartai from '@push.rocks/smartai';
|
|
||||||
import * as smartcli from '@push.rocks/smartcli';
|
|
||||||
import * as smartdelay from '@push.rocks/smartdelay';
|
|
||||||
import * as smartfile from '@push.rocks/smartfile';
|
|
||||||
import * as smartgit from '@push.rocks/smartgit';
|
|
||||||
import * as smartinteract from '@push.rocks/smartinteract';
|
|
||||||
import * as smartlog from '@push.rocks/smartlog';
|
|
||||||
import * as smartlogDestinationLocal from '@push.rocks/smartlog-destination-local';
|
|
||||||
import * as smartpath from '@push.rocks/smartpath';
|
|
||||||
import * as smartshell from '@push.rocks/smartshell';
|
|
||||||
import * as smarttime from '@push.rocks/smarttime';
|
|
||||||
|
|
||||||
export {
|
|
||||||
npmextra,
|
|
||||||
qenv,
|
|
||||||
smartai,
|
|
||||||
smartcli,
|
|
||||||
smartdelay,
|
|
||||||
smartfile,
|
|
||||||
smartgit,
|
|
||||||
smartinteract,
|
|
||||||
smartlog,
|
|
||||||
smartlogDestinationLocal,
|
|
||||||
smartpath,
|
|
||||||
smartshell,
|
|
||||||
smarttime,
|
|
||||||
};
|
|
||||||
|
|
||||||
// @git.zone scope
|
|
||||||
import * as tspublish from '@git.zone/tspublish';
|
|
||||||
|
|
||||||
export { tspublish };
|
|
||||||
|
|
||||||
// third party scope
|
|
||||||
import * as typedoc from 'typedoc';
|
|
||||||
|
|
||||||
export { typedoc };
|
|
||||||
2
ts/tsdoc.classes.typedoc.ts
Normal file
2
ts/tsdoc.classes.typedoc.ts
Normal file
@ -0,0 +1,2 @@
|
|||||||
|
import * as plugins from './tsdoc.plugins';
|
||||||
|
|
||||||
16
ts/tsdoc.cli.ts
Normal file
16
ts/tsdoc.cli.ts
Normal file
@ -0,0 +1,16 @@
|
|||||||
|
import * as plugins from './tsdoc.plugins';
|
||||||
|
|
||||||
|
export const run = async () => {
|
||||||
|
const tsdocCli = new plugins.smartcli.Smartcli();
|
||||||
|
tsdocCli.addCommand('typedoc').subscribe(async argvArg => {
|
||||||
|
|
||||||
|
});
|
||||||
|
|
||||||
|
tsdocCli.addCommand('mkdocs').subscribe(async argvArg => {
|
||||||
|
|
||||||
|
});
|
||||||
|
|
||||||
|
tsdocCli.standardTask().subscribe(async argvArg => {
|
||||||
|
|
||||||
|
})
|
||||||
|
}
|
||||||
13
ts/tsdoc.plugins.ts
Normal file
13
ts/tsdoc.plugins.ts
Normal file
@ -0,0 +1,13 @@
|
|||||||
|
// pushrocks scope
|
||||||
|
import * as smartcli from '@pushrocks/smartcli';
|
||||||
|
|
||||||
|
export {
|
||||||
|
smartcli
|
||||||
|
};
|
||||||
|
|
||||||
|
// third party scope
|
||||||
|
import * as typedoc from 'typedoc';
|
||||||
|
|
||||||
|
export {
|
||||||
|
typedoc
|
||||||
|
};
|
||||||
@ -1,14 +0,0 @@
|
|||||||
{
|
|
||||||
"compilerOptions": {
|
|
||||||
"experimentalDecorators": true,
|
|
||||||
"useDefineForClassFields": false,
|
|
||||||
"target": "ES2022",
|
|
||||||
"module": "NodeNext",
|
|
||||||
"moduleResolution": "NodeNext",
|
|
||||||
"esModuleInterop": true,
|
|
||||||
"verbatimModuleSyntax": true
|
|
||||||
},
|
|
||||||
"exclude": [
|
|
||||||
"dist_*/**/*.d.ts"
|
|
||||||
]
|
|
||||||
}
|
|
||||||
17
tslint.json
Normal file
17
tslint.json
Normal file
@ -0,0 +1,17 @@
|
|||||||
|
{
|
||||||
|
"extends": ["tslint:latest", "tslint-config-prettier"],
|
||||||
|
"rules": {
|
||||||
|
"semicolon": [true, "always"],
|
||||||
|
"no-console": false,
|
||||||
|
"ordered-imports": false,
|
||||||
|
"object-literal-sort-keys": false,
|
||||||
|
"member-ordering": {
|
||||||
|
"options":{
|
||||||
|
"order": [
|
||||||
|
"static-method"
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"defaultSeverity": "warning"
|
||||||
|
}
|
||||||
Loading…
x
Reference in New Issue
Block a user