Compare commits
No commits in common. "master" and "v1.1.15" 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
|
||||
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
|
||||
```
|
||||
@ -8,20 +8,7 @@
|
||||
"shortDescription": "a tool for better documentation",
|
||||
"npmPackagename": "@git.zone/tsdoc",
|
||||
"license": "MIT",
|
||||
"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"
|
||||
]
|
||||
"projectDomain": "git.zone"
|
||||
}
|
||||
},
|
||||
"npmci": {
|
||||
@ -30,5 +17,6 @@
|
||||
},
|
||||
"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"
|
||||
|
||||
}
|
||||
}
|
||||
70
package.json
70
package.json
@ -1,48 +1,42 @@
|
||||
{
|
||||
"name": "@git.zone/tsdoc",
|
||||
"version": "1.4.4",
|
||||
"version": "1.1.15",
|
||||
"private": false,
|
||||
"description": "An advanced TypeScript documentation tool using AI to generate and enhance documentation for TypeScript projects.",
|
||||
"description": "a tool for better documentation",
|
||||
"main": "dist_ts/index.js",
|
||||
"typings": "dist_ts/index.d.ts",
|
||||
"type": "module",
|
||||
"exports": {
|
||||
".": "./dist_ts/index.js"
|
||||
},
|
||||
"author": "Task Venture Capital GmbH",
|
||||
"author": "Lossless GmbH",
|
||||
"license": "MIT",
|
||||
"bin": {
|
||||
"tsdoc": "cli.js"
|
||||
},
|
||||
"scripts": {
|
||||
"test": "(tstest test/) && npm run testCli",
|
||||
"testCli": "(node ./cli.ts.js) && (node ./cli.ts.js aidocs)",
|
||||
"build": "(tsbuild --web --allowimplicitany)",
|
||||
"buildDocs": "tsdoc"
|
||||
"test": "(tstest test/) && (node ./cli.ts.js)",
|
||||
"build": "(tsbuild --web --allowimplicitany)"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@git.zone/tsbuild": "^2.1.80",
|
||||
"@git.zone/tsbuild": "^2.1.65",
|
||||
"@git.zone/tsrun": "^1.2.46",
|
||||
"@git.zone/tstest": "^1.0.90",
|
||||
"@push.rocks/tapbundle": "^5.0.23",
|
||||
"@types/node": "^22.8.1"
|
||||
"@git.zone/tstest": "^1.0.73",
|
||||
"@push.rocks/tapbundle": "^5.0.4",
|
||||
"@types/node": "^20.12.2"
|
||||
},
|
||||
"dependencies": {
|
||||
"@git.zone/tspublish": "^1.5.5",
|
||||
"@push.rocks/early": "^4.0.3",
|
||||
"@push.rocks/npmextra": "^5.0.23",
|
||||
"@push.rocks/npmextra": "^5.0.10",
|
||||
"@push.rocks/qenv": "^6.0.5",
|
||||
"@push.rocks/smartai": "^0.4.2",
|
||||
"@push.rocks/smartcli": "^4.0.11",
|
||||
"@push.rocks/smartai": "^0.0.8",
|
||||
"@push.rocks/smartcli": "^4.0.6",
|
||||
"@push.rocks/smartdelay": "^3.0.5",
|
||||
"@push.rocks/smartfile": "^11.0.20",
|
||||
"@push.rocks/smartgit": "^3.1.0",
|
||||
"@push.rocks/smartfile": "^11.0.4",
|
||||
"@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"
|
||||
"@push.rocks/smartlog": "^3.0.1",
|
||||
"@push.rocks/smartlog-destination-local": "^9.0.1",
|
||||
"@push.rocks/smartpath": "^5.0.5",
|
||||
"@push.rocks/smartshell": "^3.0.4",
|
||||
"typedoc": "^0.25.12",
|
||||
"typescript": "^5.4.3"
|
||||
},
|
||||
"files": [
|
||||
"ts/**/*",
|
||||
@ -58,25 +52,5 @@
|
||||
],
|
||||
"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"
|
||||
]
|
||||
}
|
||||
|
||||
12098
pnpm-lock.yaml
generated
12098
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.
|
||||
337
readme.md
337
readme.md
@ -1,328 +1,57 @@
|
||||
# @git.zone/tsdoc
|
||||
|
||||
An advanced TypeScript documentation tool using AI to generate and enhance documentation for TypeScript projects.
|
||||
a tool for better documentation
|
||||
|
||||
## 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:
|
||||
To install `@git.zone/tsdoc`, you will need Node.js and npm (Node Package Manager) installed on your system. Once you have those prerequisites, open your terminal or command prompt and run the following command:
|
||||
|
||||
```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>
|
||||
npm install @git.zone/tsdoc --save
|
||||
```
|
||||
This command tells npm to download the `@git.zone/tsdoc` package and add it as a dependency to your project's `package.json` file.
|
||||
|
||||
## Usage
|
||||
To use `@git.zone/tsdoc` effectively in your TypeScript projects, we must delve deep into its functionalities and elaborate on the possibilities it offers. Remember, TypeScript is a statically typed superset of JavaScript, and ESM (ECMAScript Module) syntax is preferred for module import/export operations. Throughout this section, we'll maintain strict adherence to these standards.
|
||||
|
||||
`@git.zone/tsdoc` provides a comprehensive CLI tool and advanced AI-enhanced features to generate and enhance documentation for your TypeScript projects.
|
||||
### Getting Started
|
||||
Before anything else, ensure you import the necessary functionalities from `@git.zone/tsdoc` at the top of your TypeScript file:
|
||||
|
||||
### Using the CLI
|
||||
```typescript
|
||||
import { runCli } from '@git.zone/tsdoc';
|
||||
```
|
||||
|
||||
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.
|
||||
The `runCli` function is a pivotal part of `@git.zone/tsdoc`, serving as an entry point for leveraging its capabilities.
|
||||
|
||||
### Commands
|
||||
### Leveraging TypeScript for Documentation
|
||||
TypeScript's rich type system can significantly enhance your documentation process. By providing detailed type annotations, you allow `tsdoc` to generate more informative and useful documentation.
|
||||
|
||||
#### `tsdoc` - Auto-detect Documentation Format
|
||||
Consider the following TypeScript interface example:
|
||||
|
||||
The standard command will automatically detect the documentation format of your project and generate the appropriate documentation.
|
||||
```typescript
|
||||
interface Person {
|
||||
name: string;
|
||||
age: number;
|
||||
}
|
||||
```
|
||||
|
||||
By explicitly stating that `name` is a `string` and `age` is a `number`, you make your code self-descriptive. `@git.zone/tsdoc` can use this information to generate documentation that is immediately understandable to other developers.
|
||||
|
||||
### Generating Documentation
|
||||
To generate documentation, `@git.zone/tsdoc` provides a CLI tool. Use the `npm run` script from your `package.json` or directly invoke the CLI command if `@git.zone/tsdoc` is installed globally. Here's a sample command to generate documentation:
|
||||
|
||||
```bash
|
||||
tsdoc
|
||||
```
|
||||
|
||||
### Example
|
||||
This command scans your TypeScript project for type annotations, comments, and other relevant information to generate comprehensive documentation.
|
||||
|
||||
```typescript
|
||||
// In a TypeScript project, run the above command.
|
||||
```
|
||||
### Advanced Usage: Ensuring Documentation Quality
|
||||
It's critical to ensure the completeness and quality of your documentation. `@git.zone/tsdoc` encourages a workflow that includes regular documentation generation and review. This practice helps identify areas lacking sufficient documentation and areas where the documentation can be improved for better clarity.
|
||||
|
||||
#### `tsdoc typedoc` - Generate Documentation using TypeDoc
|
||||
In projects with multiple contributors, consider setting up continuous integration (CI) tasks that include documentation generation and linting. This setup can help maintain high documentation standards by automatically flagging issues for correction before merging code changes.
|
||||
|
||||
The `typedoc` command will generate documentation compliant with the TypeDoc format.
|
||||
### Conclusion
|
||||
`@git.zone/tsdoc` is a versatile tool that, when used to its full potential, significantly enhances the quality and usability of your project's documentation. By following TypeScript best practices and integrating documentation generation into your development workflow, you can achieve a well-documented codebase that is welcoming to new contributors and beneficial to your project's long-term success.
|
||||
|
||||
```bash
|
||||
tsdoc typedoc --publicSubdir docs
|
||||
```
|
||||
Please refer to the official `@git.zone/tsdoc` documentation and TypeScript guidelines for more in-depth coverage of the features and best practices discussed here.
|
||||
|
||||
### 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.
|
||||
(Note: This guide has been crafted to showcase the usage of `@git.zone/tsdoc` in diverse scenarios comprehensively. Ensure to adapt and extend the examples provided to fit the specific needs and complexities of your projects.)
|
||||
@ -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();
|
||||
27
test/test.aidocs.nonci.ts
Normal file
27
test/test.aidocs.nonci.ts
Normal file
@ -0,0 +1,27 @@
|
||||
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();
|
||||
await aidocs.buildReadme('./');
|
||||
})
|
||||
|
||||
tap.test('should start AIdocs', async () => {
|
||||
await aidocs.start();
|
||||
await aidocs.buildDescription('./');
|
||||
})
|
||||
|
||||
|
||||
tap.start();
|
||||
@ -1,8 +1,8 @@
|
||||
/**
|
||||
* autocreated commitinfo by @push.rocks/commitinfo
|
||||
* autocreated commitinfo by @pushrocks/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.'
|
||||
version: '1.1.15',
|
||||
description: 'a tool for better documentation'
|
||||
}
|
||||
|
||||
@ -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;
|
||||
}
|
||||
}
|
||||
@ -8,6 +8,7 @@ interface IDescriptionInterface {
|
||||
}
|
||||
|
||||
export class Description {
|
||||
|
||||
// INSTANCE
|
||||
private aiDocsRef: AiDoc;
|
||||
private projectDir: string;
|
||||
@ -22,32 +23,30 @@ export class Description {
|
||||
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
|
||||
}
|
||||
let result = await this.aiDocsRef.openaiInstance.chat(
|
||||
`
|
||||
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.
|
||||
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.
|
||||
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('```', ''),
|
||||
Don't wrap the JSON in three ticks json!!!
|
||||
`,
|
||||
contextString,
|
||||
[]
|
||||
);
|
||||
|
||||
console.log(result.message.content);
|
||||
const resultObject: IDescriptionInterface = JSON.parse(result.message.content.replace('```json', '').replace('```', ''));
|
||||
|
||||
const npmextraJson = (await projectContext.gatherFiles()).smartfilesNpmextraJSON;
|
||||
const npmextraJsonContent = JSON.parse(npmextraJson.contents.toString());
|
||||
|
||||
@ -65,9 +64,10 @@ Don't wrap the JSON in three ticks json!!!
|
||||
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;
|
||||
return result.message.content;
|
||||
}
|
||||
}
|
||||
@ -1,4 +1,3 @@
|
||||
export * from './commit.js';
|
||||
export * from './description.js';
|
||||
export * from './projectcontext.js';
|
||||
export * from './readme.js';
|
||||
|
||||
@ -13,33 +13,27 @@ export class ProjectContext {
|
||||
public async gatherFiles() {
|
||||
const smartfilePackageJSON = await plugins.smartfile.SmartFile.fromFilePath(
|
||||
plugins.path.join(this.projectDir, 'package.json'),
|
||||
this.projectDir,
|
||||
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,
|
||||
this.projectDir
|
||||
);
|
||||
const smartfilesNpmextraJSON = await plugins.smartfile.SmartFile.fromFilePath(
|
||||
plugins.path.join(this.projectDir, 'npmextra.json'),
|
||||
this.projectDir,
|
||||
this.projectDir
|
||||
);
|
||||
const smartfilesMod = await plugins.smartfile.fs.fileTreeToObject(
|
||||
this.projectDir,
|
||||
'ts*/**/*.ts',
|
||||
'ts/**/*.ts'
|
||||
);
|
||||
const smartfilesTest = await plugins.smartfile.fs.fileTreeToObject(
|
||||
this.projectDir,
|
||||
'test/**/*.ts',
|
||||
'test/**/*.ts'
|
||||
);
|
||||
return {
|
||||
smartfilePackageJSON,
|
||||
smartfilesReadme,
|
||||
smartfilesReadmeHints,
|
||||
smartfilesNpmextraJSON,
|
||||
smartfilesMod,
|
||||
smartfilesTest,
|
||||
@ -47,9 +41,6 @@ export class ProjectContext {
|
||||
}
|
||||
|
||||
public async convertFilesToContext(filesArg: plugins.smartfile.SmartFile[]) {
|
||||
filesArg.map((fileArg) => {
|
||||
// console.log(` -> ${fileArg.relative}`);
|
||||
});
|
||||
return filesArg
|
||||
.map((smartfile) => {
|
||||
return `
|
||||
@ -68,12 +59,10 @@ ${smartfile.contents.toString()}
|
||||
let context = await this.convertFilesToContext([
|
||||
files.smartfilePackageJSON,
|
||||
files.smartfilesReadme,
|
||||
files.smartfilesReadmeHints,
|
||||
files.smartfilesNpmextraJSON,
|
||||
...files.smartfilesMod,
|
||||
...files.smartfilesTest,
|
||||
]);
|
||||
// console.log(context);
|
||||
return context;
|
||||
}
|
||||
|
||||
|
||||
@ -1,10 +1,9 @@
|
||||
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;
|
||||
@ -22,17 +21,15 @@ export class Readme {
|
||||
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;
|
||||
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: `
|
||||
let result = await this.aiDocsRef.openaiInstance.chat(
|
||||
`
|
||||
You create markdown readmes for npm projects. You only output the markdown readme.
|
||||
|
||||
The Readme should follow the following template:
|
||||
@ -62,83 +59,26 @@ The Readme should follow the following template:
|
||||
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.
|
||||
npmextra.json has a tsdocs section that provides valuable information about module ideas.
|
||||
]
|
||||
`,
|
||||
messageHistory: [],
|
||||
userMessage: contextString,
|
||||
});
|
||||
`,
|
||||
contextString,
|
||||
[]
|
||||
);
|
||||
|
||||
|
||||
finalReadmeString += result.message.content + '\n' + legalInfo;
|
||||
|
||||
|
||||
finalReadmeString += result.message + '\n' + legalInfo;
|
||||
|
||||
console.log(`\n======================\n`);
|
||||
console.log(result.message);
|
||||
console.log(result.message.content);
|
||||
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;
|
||||
return result.message.content;
|
||||
}
|
||||
}
|
||||
@ -7,7 +7,7 @@ export class AiDoc {
|
||||
|
||||
public npmextraKV: plugins.npmextra.KeyValueStore;
|
||||
public qenvInstance: plugins.qenv.Qenv;
|
||||
public aidocInteract: plugins.smartinteract.SmartInteract;
|
||||
public smartinteractInstance: plugins.smartinteract.SmartInteract;
|
||||
public openaiInstance: plugins.smartai.OpenAiProvider;
|
||||
|
||||
argvArg: any;
|
||||
@ -33,7 +33,7 @@ export class AiDoc {
|
||||
|
||||
public async start() {
|
||||
// lets care about prerequisites
|
||||
this.aidocInteract = new plugins.smartinteract.SmartInteract();
|
||||
this.smartinteractInstance = new plugins.smartinteract.SmartInteract();
|
||||
this.qenvInstance = new plugins.qenv.Qenv();
|
||||
if (!(await this.qenvInstance.getEnvVarOnDemand('OPENAI_TOKEN'))) {
|
||||
this.npmextraKV = new plugins.npmextra.KeyValueStore({
|
||||
@ -42,18 +42,16 @@ export class AiDoc {
|
||||
mandatoryKeys: ['OPENAI_TOKEN'],
|
||||
});
|
||||
|
||||
const missingKeys = await this.npmextraKV.getMissingMandatoryKeys();
|
||||
const missingKeys = 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({
|
||||
const answerObject = await this.smartinteractInstance.askQuestion({
|
||||
type: 'input',
|
||||
message: `Please provide your OpenAI token. This will be persisted in your home directory.`,
|
||||
message: `Please provide your OpenAI token`,
|
||||
name: 'OPENAI_TOKEN',
|
||||
default: '',
|
||||
});
|
||||
@ -61,17 +59,12 @@ export class AiDoc {
|
||||
}
|
||||
|
||||
this.printSanitizedToken();
|
||||
await this.npmextraKV.writeKey('OPENAI_TOKEN', this.openaiToken);
|
||||
// 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,
|
||||
});
|
||||
this.openaiInstance = new plugins.smartai.OpenAiProvider(this.openaiToken);
|
||||
await this.openaiInstance.start();
|
||||
}
|
||||
|
||||
@ -84,14 +77,4 @@ export class AiDoc {
|
||||
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();
|
||||
}
|
||||
}
|
||||
|
||||
@ -20,15 +20,14 @@ export class TypeDoc {
|
||||
|
||||
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,
|
||||
"compilerOptions": {
|
||||
"experimentalDecorators": true,
|
||||
"useDefineForClassFields": false,
|
||||
"target": "ES2022",
|
||||
"module": "NodeNext",
|
||||
"moduleResolution": "NodeNext",
|
||||
"esModuleInterop": true,
|
||||
"verbatimModuleSyntax": true
|
||||
},
|
||||
include: [],
|
||||
};
|
||||
@ -51,7 +50,7 @@ export class TypeDoc {
|
||||
targetDir = plugins.path.join(targetDir, options.publicSubdir);
|
||||
}
|
||||
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);
|
||||
}
|
||||
|
||||
13
ts/cli.ts
13
ts/cli.ts
@ -27,16 +27,9 @@ export const run = async () => {
|
||||
});
|
||||
});
|
||||
|
||||
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('aidocs').subscribe(async (argvArg) => {
|
||||
const aidocs = new AiDoc();
|
||||
})
|
||||
|
||||
tsdocCli.addCommand('test').subscribe((argvArg) => {
|
||||
tsdocCli.triggerCommand('typedoc', argvArg);
|
||||
|
||||
@ -1,6 +1,15 @@
|
||||
import { commitinfo } from './00_commitinfo_data.js';
|
||||
import * as plugins from './plugins.js';
|
||||
|
||||
export const logger = plugins.smartlog.Smartlog.createForCommitinfo(commitinfo);
|
||||
export 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());
|
||||
|
||||
@ -1,10 +1,7 @@
|
||||
import * as plugins from './plugins.js';
|
||||
|
||||
// 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 binDir = plugins.path.join(packageDir, './node_modules/.bin');
|
||||
export const assetsDir = plugins.path.join(packageDir, './assets');
|
||||
|
||||
@ -10,34 +10,13 @@ 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 };
|
||||
export { npmextra, qenv, smartai, smartcli, smartdelay, smartfile, smartinteract, smartlog, smartlogDestinationLocal, smartpath, smartshell };
|
||||
|
||||
// third party scope
|
||||
import * as typedoc from 'typedoc';
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user