Compare commits

..

30 Commits

Author SHA1 Message Date
a0969912eb 1.1.14 2024-03-31 15:09:31 +02:00
39d64ffcf3 fix(core): update 2024-03-31 15:09:30 +02:00
529297bd09 1.1.13 2022-09-16 08:24:42 +02:00
4c16cb9c3e fix(core): update 2022-09-16 08:24:41 +02:00
3a6cdf5fb5 1.1.12 2022-09-16 08:22:57 +02:00
2460c89151 fix(core): update 2022-09-16 08:22:57 +02:00
3dae706a67 1.1.11 2022-09-16 08:17:29 +02:00
c150052380 fix(core): update 2022-09-16 08:17:28 +02:00
1d00a95885 1.1.10 2022-06-07 18:01:35 +02:00
d9bfba1b5f fix(core): update 2022-06-07 18:01:34 +02:00
c56db7d1d0 1.1.9 2022-06-07 17:54:00 +02:00
a2bcd1a1c5 fix(core): update 2022-06-07 17:54:00 +02:00
795ce9b014 1.1.8 2021-03-08 01:26:43 +00:00
9a84009f47 fix(core): update 2021-03-08 01:26:42 +00:00
6efe00abd9 1.1.7 2021-03-08 01:06:19 +00:00
d81b9dd213 fix(core): update 2021-03-08 01:06:18 +00:00
751a5b8630 1.1.6 2021-03-06 19:21:14 +00:00
3c9e421351 fix(core): update 2021-03-06 19:21:13 +00:00
fe05144a56 1.1.5 2021-01-29 20:50:18 +00:00
ad7035e5e3 fix(core): update 2021-01-29 20:50:18 +00:00
49601f3bac 1.1.4 2020-11-27 12:55:24 +00:00
6c13622b33 fix(core): update 2020-11-27 12:55:23 +00:00
9021e9ae39 1.1.3 2020-11-27 12:37:24 +00:00
7289b77398 fix(core): update 2020-11-27 12:37:23 +00:00
ae90b8297f 1.1.2 2020-11-27 12:02:58 +00:00
d75a65ee46 fix(core): update 2020-11-27 12:02:57 +00:00
c28ff5212e 1.1.1 2020-11-24 20:27:51 +00:00
97bf1e3990 fix(core): update 2020-11-24 20:27:51 +00:00
769a22057f 1.0.22 2020-11-24 20:24:31 +00:00
b5910b6557 fix(core): update 2020-11-24 20:24:30 +00:00
29 changed files with 5335 additions and 2059 deletions

4
.gitignore vendored
View File

@ -15,8 +15,6 @@ node_modules/
# builds # builds
dist/ dist/
dist_web/ dist_*/
dist_serve/
dist_ts_web/
# custom # custom

View File

@ -1,119 +0,0 @@
# gitzone ci_default
image: registry.gitlab.com/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
# ====================
testStable:
stage: test
script:
- npmci npm prepare
- npmci node install stable
- npmci npm install
- npmci npm test
coverage: /\d+.?\d+?\%\s*coverage/
tags:
- docker
- priv
testBuild:
stage: test
script:
- npmci npm prepare
- npmci node install stable
- npmci npm install
- npmci command npm run build
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
allow_failure: true
script:
- npmci command npm install -g tslint typescript
- npmci npm install
- npmci command "tslint -c tslint.json ./ts/**/*.ts"
tags:
- docker
- priv
trigger:
stage: metadata
script:
- npmci trigger
only:
- tags
tags:
- docker
- notpriv
pages:
image: hosttoday/ht-docker-dbase:npmci
services:
- docker:stable-dind
stage: metadata
script:
- npmci command npm install -g @gitzone/tsdoc
- npmci npm prepare
- npmci npm install
- npmci command tsdoc
tags:
- docker
- notpriv
only:
- tags
artifacts:
expire_in: 1 week
paths:
- public
allow_failure: true

13
.snyk
View File

@ -1,13 +0,0 @@
# Snyk (https://snyk.io) policy file, patches or ignores known vulnerabilities.
version: v1.13.5
# ignores vulnerabilities until expiry date; change duration by modifying expiry date
ignore:
SNYK-JS-MARKED-174116:
- typedoc > marked:
reason: None given
expires: '2019-06-13T06:50:33.594Z'
'npm:shelljs:20140723':
- typedoc > shelljs:
reason: None given
expires: '2019-06-13T06:50:33.594Z'
patch: {}

11
.vscode/launch.json vendored Normal file
View File

@ -0,0 +1,11 @@
{
"version": "0.2.0",
"configurations": [
{
"command": "npm test",
"name": "Run npm test",
"request": "launch",
"type": "node-terminal"
}
]
}

26
.vscode/settings.json vendored Normal file
View File

@ -0,0 +1,26 @@
{
"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"]
}
}
}
}
}
}
]
}

0
assets/.gitkeep Normal file
View File

View File

@ -1,7 +0,0 @@
{
"compilerOptions": {
"target": "es2017",
"module": "commonjs",
"esModuleInterop": true
}
}

4
cli.child.ts Normal file
View File

@ -0,0 +1,4 @@
#!/usr/bin/env node
process.env.CLI_CALL = 'true';
import * as cliTool from './ts/index.js';
cliTool.runCli();

3
cli.js
View File

@ -1,3 +1,4 @@
#!/usr/bin/env node #!/usr/bin/env node
process.env.CLI_CALL = 'true'; process.env.CLI_CALL = 'true';
require('./dist/index'); const cliTool = await import('./dist_ts/index.js');
cliTool.runCli();

View File

@ -1,4 +1,5 @@
#!/usr/bin/env node #!/usr/bin/env node
process.env.CLI_CALL = 'true'; process.env.CLI_CALL = 'true';
require('@gitzone/tsrun');
require('./ts/index'); import * as tsrun from '@git.zone/tsrun';
tsrun.runPath('./cli.child.js', import.meta.url);

View File

@ -1,11 +1,12 @@
{ {
"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": "@gitzone/tsdoc", "npmPackagename": "@git.zone/tsdoc",
"license": "MIT", "license": "MIT",
"projectDomain": "git.zone" "projectDomain": "git.zone"
} }

1696
package-lock.json generated

File diff suppressed because it is too large Load Diff

View File

@ -1,47 +1,55 @@
{ {
"name": "@gitzone/tsdoc", "name": "@git.zone/tsdoc",
"version": "1.0.23", "version": "1.1.14",
"private": false, "private": false,
"description": "a tool for better documentation", "description": "a tool for better documentation",
"main": "dist/index.js", "main": "dist_ts/index.js",
"typings": "dist/index.d.ts", "typings": "dist_ts/index.d.ts",
"type": "module",
"author": "Lossless GmbH", "author": "Lossless GmbH",
"license": "MIT", "license": "MIT",
"bin": { "bin": {
"tsdoc": "cli.js" "tsdoc": "cli.js"
}, },
"scripts": { "scripts": {
"test": "(tstest test/) && (node ./cli.ts.js) && rm -rf public/", "test": "(tstest test/) && (node ./cli.ts.js)",
"build": "(tsbuild)", "build": "(tsbuild --web --allowimplicitany)"
"format": "(gitzone format)"
}, },
"devDependencies": { "devDependencies": {
"@gitzone/tsbuild": "^2.1.17", "@git.zone/tsbuild": "^2.1.65",
"@gitzone/tstest": "^1.0.28", "@git.zone/tsrun": "^1.2.46",
"@pushrocks/tapbundle": "^3.0.13", "@git.zone/tstest": "^1.0.73",
"@types/node": "^12.7.12", "@push.rocks/tapbundle": "^5.0.4",
"tslint": "^5.20.0", "@types/node": "^20.12.2"
"tslint-config-prettier": "^1.15.0"
}, },
"dependencies": { "dependencies": {
"@pushrocks/early": "^3.0.3", "@push.rocks/early": "^4.0.3",
"@pushrocks/smartcli": "^3.0.7", "@push.rocks/npmextra": "^5.0.10",
"@pushrocks/smartfile": "^7.0.6", "@push.rocks/qenv": "^6.0.5",
"@pushrocks/smartlog": "^2.0.19", "@push.rocks/smartai": "^0.0.6",
"@pushrocks/smartlog-destination-local": "^8.0.2", "@push.rocks/smartcli": "^4.0.6",
"@pushrocks/smartshell": "^2.0.25", "@push.rocks/smartfile": "^11.0.4",
"typedoc": "^0.15.0", "@push.rocks/smartinteract": "^2.0.14",
"typescript": "^3.6.4" "@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": [ "files": [
"ts/*", "ts/**/*",
"ts_web/*", "ts_web/**/*",
"dist/*", "dist/**/*",
"dist_web/*", "dist_*/**/*",
"dist_ts_web/*", "dist_ts/**/*",
"assets/*", "dist_ts_web/**/*",
"assets/**/*",
"cli.js", "cli.js",
"npmextra.json", "npmextra.json",
"readme.md" "readme.md"
],
"browserslist": [
"last 1 chrome versions"
] ]
} }

5054
pnpm-lock.yaml generated Normal file

File diff suppressed because it is too large Load Diff

View File

@ -1,23 +1,36 @@
# @gitzone/tsdoc # @git.zone/tsdoc
a tool for better documentation a tool for better documentation
## Availabililty and Links ## Availabililty and Links
* [npmjs.org (npm package)](https://www.npmjs.com/package/@gitzone/tsdoc) * [npmjs.org (npm package)](https://www.npmjs.com/package/@git.zone/tsdoc)
* [gitlab.com (source)](https://gitlab.com/gitzone/tsdoc) * [gitlab.com (source)](https://gitlab.com/gitzone/tsdoc)
* [github.com (source mirror)](https://github.com/gitzone/tsdoc) * [github.com (source mirror)](https://github.com/gitzone/tsdoc)
* [docs (typedoc)](https://gitzone.gitlab.io/tsdoc/) * [docs (typedoc)](https://gitzone.gitlab.io/tsdoc/)
## Status for master ## Status for master
[![build status](https://gitlab.com/gitzone/tsdoc/badges/master/build.svg)](https://gitlab.com/gitzone/tsdoc/commits/master)
[![coverage report](https://gitlab.com/gitzone/tsdoc/badges/master/coverage.svg)](https://gitlab.com/gitzone/tsdoc/commits/master) Status Category | Status Badge
[![npm downloads per month](https://img.shields.io/npm/dm/@gitzone/tsdoc.svg)](https://www.npmjs.com/package/@gitzone/tsdoc) -- | --
[![Known Vulnerabilities](https://snyk.io/test/npm/@gitzone/tsdoc/badge.svg)](https://snyk.io/test/npm/@gitzone/tsdoc) GitLab Pipelines | [![pipeline status](https://gitlab.com/gitzone/tsdoc/badges/master/pipeline.svg)](https://lossless.cloud)
[![TypeScript](https://img.shields.io/badge/TypeScript->=%203.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/) GitLab Pipline Test Coverage | [![coverage report](https://gitlab.com/gitzone/tsdoc/badges/master/coverage.svg)](https://lossless.cloud)
[![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/) npm | [![npm downloads per month](https://badgen.net/npm/dy/@git.zone/tsdoc)](https://lossless.cloud)
[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-prettier-ff69b4.svg)](https://prettier.io/) Snyk | [![Known Vulnerabilities](https://badgen.net/snyk/gitzone/tsdoc)](https://lossless.cloud)
TypeScript Support | [![TypeScript](https://badgen.net/badge/TypeScript/>=%203.x/blue?icon=typescript)](https://lossless.cloud)
node Support | [![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
Code Style | [![Code Style](https://badgen.net/badge/style/prettier/purple)](https://lossless.cloud)
PackagePhobia (total standalone install weight) | [![PackagePhobia](https://badgen.net/packagephobia/install/@git.zone/tsdoc)](https://lossless.cloud)
PackagePhobia (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/@git.zone/tsdoc)](https://lossless.cloud)
BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/@git.zone/tsdoc)](https://lossless.cloud)
Platform support | [![Supports Windows 10](https://badgen.net/badge/supports%20Windows%2010/yes/green?icon=windows)](https://lossless.cloud) [![Supports Mac OS X](https://badgen.net/badge/supports%20Mac%20OS%20X/yes/green?icon=apple)](https://lossless.cloud)
## Usage ## Usage
Use TypeScript for best in class intellisense.
## Contribution
We are always happy for code contributions. If you are not the code contributing type that is ok. Still, maintaining Open Source repositories takes considerable time and thought. If you like the quality of what we do and our modules are useful to you we would appreciate a little monthly contribution: You can [contribute one time](https://lossless.link/contribute-onetime) or [contribute monthly](https://lossless.link/contribute). :)
For further information read the linked docs at the top of this readme. For further information read the linked docs at the top of this readme.
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh) > MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)

15
test/test.aidocs.ts Normal file
View File

@ -0,0 +1,15 @@
import { tap, expect } from '@push.rocks/tapbundle';
import * as tsdocs from '../ts/index.js';
let aidocs: tsdocs.AiDocs;
tap.test('should create an AIdocs class', async () => {
aidocs = new tsdocs.AiDocs();
expect(aidocs).toBeInstanceOf(tsdocs.AiDocs);
});
tap.test('should start AIdocs', async () => {})
tap.start();

View File

@ -1,5 +1,5 @@
import { expect, tap } from '@pushrocks/tapbundle'; import { expect, tap } from '@push.rocks/tapbundle';
import * as tsdoc from '../ts/index'; import * as tsdoc from '../ts/index.js';
tap.test('first test', async () => { tap.test('first test', async () => {
console.log('test'); console.log('test');

8
ts/00_commitinfo_data.ts Normal file
View File

@ -0,0 +1,8 @@
/**
* autocreated commitinfo by @pushrocks/commitinfo
*/
export const commitinfo = {
name: '@git.zone/tsdoc',
version: '1.1.14',
description: 'a tool for better documentation'
}

View File

@ -1,6 +1,12 @@
import * as early from '@pushrocks/early'; import * as early from '@push.rocks/early';
early.start('tsdoc'); early.start('tsdoc');
import * as plugins from './tsdoc.plugins'; import * as plugins from './tsdoc.plugins.js';
import * as cli from './tsdoc.cli'; import * as cli from './tsdoc.cli.js';
early.stop(); early.stop();
cli.run();
export const runCli = async () => {
await cli.run();
};
// exports
export * from './tsdoc.classes.aidocs.js';

View File

@ -0,0 +1,44 @@
import * as plugins from './tsdoc.plugins.js';
export class AiDocs {
private openaiToken: string;
public npmextraKV: plugins.npmextra.KeyValueStore;
public qenvInstance: plugins.qenv.Qenv;
public smartinteractInstance: plugins.smartinteract.SmartInteract;
public openaiInstance: plugins.smartai.OpenAiProvider;
constructor() {}
public async start() {
// lets care about prerequisites
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({
typeArg: 'userHomeDir',
identityArg: 'tsdoc',
mandatoryKeys: ['OPENAI_TOKEN']
});
const missingKeys = this.npmextraKV.getMissingMandatoryKeys();
if (missingKeys.length > 0) {
const answerObject = await this.smartinteractInstance.askQuestion({
type: 'input',
message: `Please provide your OpenAI token`,
name: 'OPENAI_TOKEN',
default: '',
});
this.openaiToken = answerObject.value
await this.npmextraKV.writeKey('OPENAI_TOKEN', this.openaiToken);
}
}
// lets assume we have an OPENAI_Token now
// we can now assemble the directory structure.
const smartfilesMod = plugins.smartfile.fs.fileTreeToObject(process.cwd(), 'ts/**/*.ts');
const smartfilesTest = plugins.smartfile.fs.fileTreeToObject(process.cwd(), 'test/**/*.ts');
console.log(smartfilesMod);
console.log(smartfilesTest);
}
}

View File

@ -1,63 +0,0 @@
import * as plugins from './tsdoc.plugins';
import * as paths from './tsdoc.paths';
export class MkDocs {
public smartshellInstance = new plugins.smartshell.Smartshell({
executor: 'bash',
pathDirectories: [paths.binDir]
});
public static async isMkDocsDir(dirPathArg: string): Promise<boolean> {
const result = await plugins.smartfile.fs.fileExists(
plugins.path.join(dirPathArg, 'mkdocs.yml')
);
return result;
}
public static async handleCommand(argvArg) {
const mkdocsInstance = new MkDocs(paths.cwd);
switch (true) {
case argvArg.serve:
await mkdocsInstance.serve();
break;
case argvArg.publish:
await mkdocsInstance.publish();
break;
default:
await mkdocsInstance.compile();
break;
}
}
// Instance
public typedocDirectory: string;
constructor(dirPathArg: string) {
this.typedocDirectory = dirPathArg;
}
public async update() {
await this.smartshellInstance.exec(
`docker pull registry.gitlab.com/hosttoday/ht-docker-mkdocs`
);
}
public async compile() {
await this.update();
await this.smartshellInstance.exec(`rm -rf public/`);
await this.smartshellInstance.exec(
`docker run --rm -p 8000:8000 -v ${paths.cwd}:/docs registry.gitlab.com/hosttoday/ht-docker-mkdocs build`
);
}
public async serve() {
await this.update();
await this.smartshellInstance.exec(
`docker run --rm -p 8000:8000 -v ${paths.cwd}:/docs registry.gitlab.com/hosttoday/ht-docker-mkdocs`
);
}
public async publish() {
await this.compile();
await this.smartshellInstance.exec(`gitzone commit`);
}
}

View File

@ -1,62 +0,0 @@
import * as plugins from './tsdoc.plugins';
import { MkDocs } from './tsdoc.classes.mkdocs';
import { TypeDoc } from './tsdoc.classes.typedoc';
import { logger } from './tsdoc.logging';
export type TDirectoryType = 'mkdocs' | 'typedoc';
export class TsDoc {
public smartshellInstance = new plugins.smartshell.Smartshell({
executor: 'bash'
});
public mkdocs: MkDocs;
public typedoc: TypeDoc;
public cwd: string;
public cwdDirType: TDirectoryType;
constructor(cwdArg: string) {
this.cwd = cwdArg;
this.mkdocs = new MkDocs(this.cwd);
this.typedoc = new TypeDoc(this.cwd);
}
public async buildDirectory() {
await this.detectDirectoryType();
if (this.cwdDirType === 'mkdocs') {
await this.mkdocs.compile();
} else if (this.cwdDirType === 'typedoc') {
await this.typedoc.compile();
}
await this.runAdditionalTasks();
}
private async detectDirectoryType () {
logger.log('warn', `Auto detecting environment!`);
switch (true) {
case await TypeDoc.isTypeDocDir(this.cwd):
logger.log('ok', `Detected TypeDoc compliant directory at ${this.cwd}`);
this.cwdDirType = 'typedoc';
break;
case await MkDocs.isMkDocsDir(this.cwd):
logger.log('ok', `Detected MkDocs compliant directory at ${this.cwd}`);
this.cwdDirType = 'mkdocs';
break;
default:
logger.log('error', `Cannot determine docs format at ${this.cwd}`);
}
}
/**
* runs additional tasks from package.json
*/
public async runAdditionalTasks() {
const packageJson = plugins.smartfile.fs.toObjectSync(plugins.path.join(this.cwd, 'package.json'));
if (packageJson.scripts.tsdoc) {
await this.smartshellInstance.exec('npm run tsdoc');
}
}
}

View File

@ -1,18 +1,15 @@
import * as plugins from './tsdoc.plugins'; import * as plugins from './tsdoc.plugins.js';
import * as paths from './tsdoc.paths'; import * as paths from './tsdoc.paths.js';
export class TypeDoc { export class TypeDoc {
public smartshellInstance = new plugins.smartshell.Smartshell({ public smartshellInstance = new plugins.smartshell.Smartshell({
executor: 'bash', executor: 'bash',
pathDirectories: [paths.binDir] pathDirectories: [paths.binDir],
}); });
// Static // Static
public static async isTypeDocDir(dirPathArg: string): Promise<boolean> { public static async isTypeDocDir(dirPathArg: string): Promise<boolean> {
const result = await plugins.smartfile.fs.fileExists( return true;
plugins.path.join(dirPathArg, 'mkdocs.yml')
);
return !result;
} }
// Instance // Instance
@ -21,9 +18,40 @@ export class TypeDoc {
this.typedocDirectory = dirPathArg; this.typedocDirectory = dirPathArg;
} }
public async compile() { public async compile(options?: { publicSubdir?: string }) {
const data = {
"compilerOptions": {
"experimentalDecorators": true,
"useDefineForClassFields": false,
"target": "ES2022",
"module": "NodeNext",
"moduleResolution": "NodeNext",
"esModuleInterop": true,
"verbatimModuleSyntax": 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( await this.smartshellInstance.exec(
`typedoc --tsconfig ${paths.tsconfigFile} --out public/ ts/` `typedoc --tsconfig ${paths.tsconfigFile} --out ${targetDir} ${startDirectory}/index.ts`
); );
plugins.smartfile.fs.remove(paths.tsconfigFile);
} }
} }

View File

@ -1,24 +1,38 @@
import * as plugins from './tsdoc.plugins'; import * as plugins from './tsdoc.plugins.js';
import * as paths from './tsdoc.paths'; import * as paths from './tsdoc.paths.js';
import { logger } from './tsdoc.logging'; import { logger } from './tsdoc.logging.js';
import { TypeDoc } from './tsdoc.classes.typedoc'; import { TypeDoc } from './tsdoc.classes.typedoc.js';
import { MkDocs } from './tsdoc.classes.mkdocs'; import { AiDocs } from './tsdoc.classes.aidocs.js';
import { TsDoc } from './tsdoc.classes.tsdoc';
export const run = async () => { export const run = async () => {
const tsdocCli = new plugins.smartcli.Smartcli(); const tsdocCli = new plugins.smartcli.Smartcli();
tsdocCli.standardTask().subscribe(async argvArg => { tsdocCli.standardCommand().subscribe(async (argvArg) => {
const tsdoc = new TsDoc(paths.cwd); logger.log('warn', `Auto detecting environment!`);
await tsdoc.buildDirectory(); 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('mkdocs').subscribe(async argvArg => { tsdocCli.addCommand('typedoc').subscribe(async (argvArg) => {
await MkDocs.handleCommand(argvArg); const typeDocInstance = new TypeDoc(paths.cwd);
await typeDocInstance.compile({
publicSubdir: argvArg.publicSubdir,
});
}); });
tsdocCli.addCommand('test').subscribe(argvArg => { tsdocCli.addCommand('aidocs').subscribe(async (argvArg) => {
const aidocs = new AiDocs();
})
tsdocCli.addCommand('test').subscribe((argvArg) => {
tsdocCli.triggerCommand('typedoc', argvArg);
process.on('exit', async () => { process.on('exit', async () => {
await plugins.smartfile.fs.remove(paths.publicDir); await plugins.smartfile.fs.remove(paths.publicDir);
}); });

View File

@ -1,4 +1,4 @@
import * as plugins from './tsdoc.plugins'; import * as plugins from './tsdoc.plugins.js';
export const logger = new plugins.smartlog.Smartlog({ export const logger = new plugins.smartlog.Smartlog({
logContext: { logContext: {
@ -7,9 +7,9 @@ export const logger = new plugins.smartlog.Smartlog({
containerName: 'Some Containername', containerName: 'Some Containername',
environment: 'local', environment: 'local',
runtime: 'node', runtime: 'node',
zone: 'gitzone' zone: 'gitzone',
}, },
minimumLogLevel: 'silly' minimumLogLevel: 'silly',
}); });
logger.addLogDestination(new plugins.smartlogDestinationLocal.DestinationLocal()); logger.addLogDestination(new plugins.smartlogDestinationLocal.DestinationLocal());

View File

@ -1,11 +1,13 @@
import * as plugins from './tsdoc.plugins'; import * as plugins from './tsdoc.plugins.js';
// dirs // dirs
export const packageDir = plugins.path.join(__dirname, '../'); export const packageDir = plugins.path.join(plugins.smartpath.get.dirnameFromImportMetaUrl(import.meta.url), '../');
export const cwd = process.cwd(); export const cwd = process.cwd();
export const binDir = plugins.path.join(packageDir, './node_modules/.bin'); export const binDir = plugins.path.join(packageDir, './node_modules/.bin');
export const assetsDir = plugins.path.join(packageDir, './assets'); export const assetsDir = plugins.path.join(packageDir, './assets');
export const publicDir = plugins.path.join(packageDir, './public'); export const publicDir = plugins.path.join(cwd, './public');
export const tsDir = plugins.path.join(cwd, './ts');
// files // files
export const tsconfigFile = plugins.path.join(assetsDir, './tsconfig.json'); export const tsconfigFile = plugins.path.join(assetsDir, './tsconfig.json');
export const typedocOptionsFile = plugins.path.join(assetsDir, './typedoc.json');

View File

@ -4,13 +4,18 @@ import * as path from 'path';
export { path }; export { path };
// pushrocks scope // pushrocks scope
import * as smartcli from '@pushrocks/smartcli'; import * as npmextra from '@push.rocks/npmextra';
import * as smartfile from '@pushrocks/smartfile'; import * as qenv from '@push.rocks/qenv';
import * as smartlog from '@pushrocks/smartlog'; import * as smartai from '@push.rocks/smartai';
import * as smartlogDestinationLocal from '@pushrocks/smartlog-destination-local'; import * as smartcli from '@push.rocks/smartcli';
import * as smartshell from '@pushrocks/smartshell'; import * as smartfile from '@push.rocks/smartfile';
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';
export { smartcli, smartfile, smartlog, smartlogDestinationLocal, smartshell }; export { npmextra, qenv, smartai, smartcli, smartfile, smartinteract, smartlog, smartlogDestinationLocal, smartpath, smartshell };
// third party scope // third party scope
import * as typedoc from 'typedoc'; import * as typedoc from 'typedoc';

14
tsconfig.json Normal file
View File

@ -0,0 +1,14 @@
{
"compilerOptions": {
"experimentalDecorators": true,
"useDefineForClassFields": false,
"target": "ES2022",
"module": "NodeNext",
"moduleResolution": "NodeNext",
"esModuleInterop": true,
"verbatimModuleSyntax": true
},
"exclude": [
"dist_*/**/*.d.ts"
]
}

View File

@ -1,17 +0,0 @@
{
"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"
}