Compare commits

..

20 Commits

Author SHA1 Message Date
44b81bb478 1.0.17 2019-05-28 11:32:39 +02:00
e1eb88e298 fix(core): update 2019-05-28 11:32:38 +02:00
50da9a5ce7 1.0.16 2019-05-27 16:11:11 +02:00
a2fd6998ee fix(core): update 2019-05-27 16:11:10 +02:00
d5908d4bc6 1.0.15 2019-05-27 15:50:10 +02:00
a34b77f469 fix(core): update 2019-05-27 15:50:10 +02:00
027b4ca26f 1.0.14 2019-05-27 13:14:58 +02:00
e9b8b3b6d9 fix(core): update 2019-05-27 13:14:58 +02:00
8d2c9e8241 1.0.13 2019-05-19 23:00:00 +02:00
b78b0ef599 fix(core): update 2019-05-19 22:59:59 +02:00
5a046a7667 1.0.12 2019-05-19 21:48:54 +02:00
b04f3be3db fix(core): update 2019-05-19 21:48:54 +02:00
d441f5b489 1.0.11 2019-05-15 21:42:30 +02:00
38f3ccb364 fix(core): update 2019-05-15 21:42:29 +02:00
0c7f50e3cc 1.0.10 2019-05-15 21:40:19 +02:00
7937cc8898 fix(core): update 2019-05-15 21:40:18 +02:00
1a7f33d22b 1.0.9 2019-05-15 21:25:02 +02:00
ea9dfa0e0d fix(core): update 2019-05-15 21:25:02 +02:00
755babdd75 1.0.8 2019-05-15 21:23:45 +02:00
4fa345d20e fix(core): update 2019-05-15 21:23:45 +02:00
6 changed files with 119 additions and 53 deletions

91
package-lock.json generated
View File

@ -1,6 +1,6 @@
{ {
"name": "@gitzone/tsdoc", "name": "@gitzone/tsdoc",
"version": "1.0.7", "version": "1.0.17",
"lockfileVersion": 1, "lockfileVersion": 1,
"requires": true, "requires": true,
"dependencies": { "dependencies": {
@ -61,19 +61,19 @@
} }
}, },
"@gitzone/tstest": { "@gitzone/tstest": {
"version": "1.0.20", "version": "1.0.23",
"resolved": "https://verdaccio.lossless.one/@gitzone%2ftstest/-/tstest-1.0.20.tgz", "resolved": "https://verdaccio.lossless.one/@gitzone%2ftstest/-/tstest-1.0.23.tgz",
"integrity": "sha512-nEHRDpmPOns47/LIJQ+y+CJDzjiS17UKJpl7PYok4EgNJJGqJUN5ilz2KVLPDcRd/7JiB7JYKujlf2UgFKadgQ==", "integrity": "sha512-iP+bCTVV+67MvWwM1l4AfQ0NuLP0xgsf2OTeUICq6I1zHm2bbGr7UuNZ2veBkx3fFb4A2Acs49bs5EkukYMi4Q==",
"dev": true, "dev": true,
"requires": { "requires": {
"@gitzone/tsrun": "^1.2.5", "@gitzone/tsrun": "^1.2.6",
"@pushrocks/consolecolor": "^2.0.1", "@pushrocks/consolecolor": "^2.0.1",
"@pushrocks/smartfile": "^7.0.2", "@pushrocks/smartfile": "^7.0.2",
"@pushrocks/smartlog": "^2.0.19", "@pushrocks/smartlog": "^2.0.19",
"@pushrocks/smartpromise": "^3.0.2", "@pushrocks/smartpromise": "^3.0.2",
"@pushrocks/smartshell": "^2.0.13", "@pushrocks/smartshell": "^2.0.20",
"@types/figures": "^2.0.0", "@types/figures": "^3.0.1",
"figures": "^2.0.0" "figures": "^3.0.0"
} }
}, },
"@pushrocks/consolecolor": { "@pushrocks/consolecolor": {
@ -165,6 +165,16 @@
} }
} }
}, },
"@pushrocks/smartexit": {
"version": "1.0.15",
"resolved": "https://verdaccio.lossless.one/@pushrocks%2fsmartexit/-/smartexit-1.0.15.tgz",
"integrity": "sha512-pvJBmF13spcDN+O8rSpYlKBOObyfW+omZKQr3hhSMT1VHMEYV8e/njsA19Cg4C2DfLPv+cRFFgPn27zJpleRsQ==",
"requires": {
"@pushrocks/lik": "^3.0.5",
"@pushrocks/smartdelay": "^2.0.3",
"@pushrocks/smartlog-source-ora": "^1.0.7"
}
},
"@pushrocks/smartfile": { "@pushrocks/smartfile": {
"version": "7.0.2", "version": "7.0.2",
"resolved": "https://verdaccio.lossless.one/@pushrocks%2fsmartfile/-/smartfile-7.0.2.tgz", "resolved": "https://verdaccio.lossless.one/@pushrocks%2fsmartfile/-/smartfile-7.0.2.tgz",
@ -212,6 +222,15 @@
"resolved": "https://verdaccio.lossless.one/@pushrocks%2fsmartlog-interfaces/-/smartlog-interfaces-2.0.5.tgz", "resolved": "https://verdaccio.lossless.one/@pushrocks%2fsmartlog-interfaces/-/smartlog-interfaces-2.0.5.tgz",
"integrity": "sha512-eLNlRpDwy3E+6v/B6fo/NiAo+UxBO3SxKgIIsgUGbWfVpsyUi0PG2xfVCdhJlhL1AsRRvKglfHSOB8qKE+XCLw==" "integrity": "sha512-eLNlRpDwy3E+6v/B6fo/NiAo+UxBO3SxKgIIsgUGbWfVpsyUi0PG2xfVCdhJlhL1AsRRvKglfHSOB8qKE+XCLw=="
}, },
"@pushrocks/smartlog-source-ora": {
"version": "1.0.7",
"resolved": "https://verdaccio.lossless.one/@pushrocks%2fsmartlog-source-ora/-/smartlog-source-ora-1.0.7.tgz",
"integrity": "sha512-lgpZ2rBLt9UGIdMb43cB9rxwtbu4RaNmdQnAYfNGxizGPuNtXw3WAzdHyS5tEJFZAbvMOiwNguQ6Bk1i2gaedw==",
"requires": {
"@pushrocks/smartlog-interfaces": "^2.0.5",
"ora": "^3.4.0"
}
},
"@pushrocks/smartparam": { "@pushrocks/smartparam": {
"version": "1.0.4", "version": "1.0.4",
"resolved": "https://verdaccio.lossless.one/@pushrocks%2fsmartparam/-/smartparam-1.0.4.tgz", "resolved": "https://verdaccio.lossless.one/@pushrocks%2fsmartparam/-/smartparam-1.0.4.tgz",
@ -268,20 +287,15 @@
} }
}, },
"@pushrocks/smartshell": { "@pushrocks/smartshell": {
"version": "2.0.13", "version": "2.0.22",
"resolved": "https://verdaccio.lossless.one/@pushrocks%2fsmartshell/-/smartshell-2.0.13.tgz", "resolved": "https://verdaccio.lossless.one/@pushrocks%2fsmartshell/-/smartshell-2.0.22.tgz",
"integrity": "sha512-jLfAhLxMVKAScKdln1QrQqBI7A7INhMNHIq28fJEBi0BNDUS0eerw4yMAnR4CRmcrh4xFp1z+ju1kaPO3I/4MA==", "integrity": "sha512-ChlRBOAhvSmxA6xfNoc1BHISV78IjvKwBP3w70r80rpQ09Bw/9ajlmGLmCDqe9aDqlaHe9HNTEPp68gNg69NBA==",
"requires": { "requires": {
"@pushrocks/smartpromise": "^2.0.5", "@pushrocks/smartdelay": "^2.0.3",
"@pushrocks/smartexit": "^1.0.15",
"@pushrocks/smartpromise": "^3.0.2",
"@types/which": "^1.3.1", "@types/which": "^1.3.1",
"which": "^1.3.1" "which": "^1.3.1"
},
"dependencies": {
"@pushrocks/smartpromise": {
"version": "2.0.5",
"resolved": "https://verdaccio.lossless.one/@pushrocks%2fsmartpromise/-/smartpromise-2.0.5.tgz",
"integrity": "sha512-9j/chLtIiNkR0MDw7Mpxg9slxAVvAQwUZuiaPYX5KpHdKxQaHLI1VZ8IN0vPhwlfgNO4i4vGXV0wB8BvSDj03g=="
}
} }
}, },
"@pushrocks/smarttime": { "@pushrocks/smarttime": {
@ -348,10 +362,13 @@
"integrity": "sha512-EaObqwIvayI5a8dCzhFrjKzVwKLxjoG9T6Ppd5CEo07LRKfQ8Yokw54r5+Wq7FaBQ+yXRvQAYPrHwya1/UFt9g==" "integrity": "sha512-EaObqwIvayI5a8dCzhFrjKzVwKLxjoG9T6Ppd5CEo07LRKfQ8Yokw54r5+Wq7FaBQ+yXRvQAYPrHwya1/UFt9g=="
}, },
"@types/figures": { "@types/figures": {
"version": "2.0.0", "version": "3.0.1",
"resolved": "https://verdaccio.lossless.one/@types%2ffigures/-/figures-2.0.0.tgz", "resolved": "https://verdaccio.lossless.one/@types%2ffigures/-/figures-3.0.1.tgz",
"integrity": "sha512-mcRgJ+ncKuNI+Dwac7omO18B8C8u+YBS+AU/oyLhEyjAnT3cUUThhHgZpbiIvu5ZqSvdD30BXtrqg9nxc3OKMg==", "integrity": "sha512-2OXodKWdNhYl+S+wCvlafqJbfMIVDfQZYX2wRyUOcRiEQpeJ9zU6cT7d+RbMpjS+/vmQ2cAUUL8gyGy1YxtLPw==",
"dev": true "dev": true,
"requires": {
"figures": "*"
}
}, },
"@types/form-data": { "@types/form-data": {
"version": "2.2.1", "version": "2.2.1",
@ -413,9 +430,9 @@
"integrity": "sha512-tHq6qdbT9U1IRSGf14CL0pUlULksvY9OZ+5eEgl1N7t+OA3tGvNpxJCzuKQlsNgCVwbAs670L1vcVQi8j9HjnA==" "integrity": "sha512-tHq6qdbT9U1IRSGf14CL0pUlULksvY9OZ+5eEgl1N7t+OA3tGvNpxJCzuKQlsNgCVwbAs670L1vcVQi8j9HjnA=="
}, },
"@types/node": { "@types/node": {
"version": "12.0.0", "version": "12.0.2",
"resolved": "https://verdaccio.lossless.one/@types%2fnode/-/node-12.0.0.tgz", "resolved": "https://verdaccio.lossless.one/@types%2fnode/-/node-12.0.2.tgz",
"integrity": "sha512-Jrb/x3HT4PTJp6a4avhmJCDEVrPdqLfl3e8GGMbpkGGdwAV5UGlIs4vVEfsHHfylZVOKZWpOqmqFH8CbfOZ6kg==" "integrity": "sha512-5tabW/i+9mhrfEOUcLDu2xBPsHJ+X5Orqy9FKpale3SjDA17j5AEpYq5vfy3oAeAHGcvANRCO3NV3d2D6q3NiA=="
}, },
"@types/shelljs": { "@types/shelljs": {
"version": "0.8.5", "version": "0.8.5",
@ -766,9 +783,9 @@
} }
}, },
"figures": { "figures": {
"version": "2.0.0", "version": "3.0.0",
"resolved": "https://verdaccio.lossless.one/figures/-/figures-2.0.0.tgz", "resolved": "https://verdaccio.lossless.one/figures/-/figures-3.0.0.tgz",
"integrity": "sha1-OrGi0qYsi/tDGgyUy3l6L84nyWI=", "integrity": "sha512-HKri+WoWoUgr83pehn/SIgLOMZ9nAWC6dcGj26RY2R4F50u4+RTUz0RCrUlOV3nKRAICW1UGzyb+kcX2qK1S/g==",
"dev": true, "dev": true,
"requires": { "requires": {
"escape-string-regexp": "^1.0.5" "escape-string-regexp": "^1.0.5"
@ -1512,16 +1529,24 @@
"integrity": "sha1-rifbOPZgp64uHDt9G8KQgZuFGeY=" "integrity": "sha1-rifbOPZgp64uHDt9G8KQgZuFGeY="
}, },
"ts-node": { "ts-node": {
"version": "8.1.0", "version": "8.2.0",
"resolved": "https://verdaccio.lossless.one/ts-node/-/ts-node-8.1.0.tgz", "resolved": "https://verdaccio.lossless.one/ts-node/-/ts-node-8.2.0.tgz",
"integrity": "sha512-34jpuOrxDuf+O6iW1JpgTRDFynUZ1iEqtYruBqh35gICNjN8x+LpVcPAcwzLPi9VU6mdA3ym+x233nZmZp445A==", "integrity": "sha512-m8XQwUurkbYqXrKqr3WHCW310utRNvV5OnRVeISeea7LoCWVcdfeB/Ntl8JYWFh+WRoUAdBgESrzKochQt7sMw==",
"dev": true, "dev": true,
"requires": { "requires": {
"arg": "^4.1.0", "arg": "^4.1.0",
"diff": "^3.1.0", "diff": "^4.0.1",
"make-error": "^1.1.1", "make-error": "^1.1.1",
"source-map-support": "^0.5.6", "source-map-support": "^0.5.6",
"yn": "^3.0.0" "yn": "^3.0.0"
},
"dependencies": {
"diff": {
"version": "4.0.1",
"resolved": "https://verdaccio.lossless.one/diff/-/diff-4.0.1.tgz",
"integrity": "sha512-s2+XdvhPCOF01LRQBC8hf4vhbVmI2CGS5aZnxLJlT5FtdhPCDFq80q++zK2KlrVorVDdL5BOGZ/VfLrVtYNF+Q==",
"dev": true
}
} }
}, },
"tslib": { "tslib": {

View File

@ -1,6 +1,6 @@
{ {
"name": "@gitzone/tsdoc", "name": "@gitzone/tsdoc",
"version": "1.0.7", "version": "1.0.17",
"private": false, "private": false,
"description": "a tool for better documentation", "description": "a tool for better documentation",
"main": "dist/index.js", "main": "dist/index.js",
@ -18,9 +18,9 @@
}, },
"devDependencies": { "devDependencies": {
"@gitzone/tsbuild": "^2.0.22", "@gitzone/tsbuild": "^2.0.22",
"@gitzone/tstest": "^1.0.15", "@gitzone/tstest": "^1.0.23",
"@pushrocks/tapbundle": "^3.0.7", "@pushrocks/tapbundle": "^3.0.7",
"@types/node": "^12.0.0", "@types/node": "^12.0.2",
"tslint": "^5.11.0", "tslint": "^5.11.0",
"tslint-config-prettier": "^1.15.0" "tslint-config-prettier": "^1.15.0"
}, },
@ -30,7 +30,7 @@
"@pushrocks/smartfile": "^7.0.2", "@pushrocks/smartfile": "^7.0.2",
"@pushrocks/smartlog": "^2.0.19", "@pushrocks/smartlog": "^2.0.19",
"@pushrocks/smartlog-destination-local": "^7.0.5", "@pushrocks/smartlog-destination-local": "^7.0.5",
"@pushrocks/smartshell": "^2.0.13", "@pushrocks/smartshell": "^2.0.22",
"typedoc": "^0.14.2", "typedoc": "^0.14.2",
"typescript": "^3.4.5" "typescript": "^3.4.5"
} }

View File

@ -14,25 +14,54 @@ export class MkDocs {
return result; 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 // Instance
public typedocDirectory: string; public typedocDirectory: string;
constructor(dirPathArg) { constructor(dirPathArg) {
this.typedocDirectory = dirPathArg; this.typedocDirectory = dirPathArg;
} }
public async update () { public async update() {
await this.smartshellInstance.exec(`docker pull registry.gitlab.com/hosttoday/ht-docker-mkdocs`); await this.smartshellInstance.exec(
`docker pull registry.gitlab.com/hosttoday/ht-docker-mkdocs`
);
} }
public async compile () { public async compile() {
await this.update(); await this.update();
await this.smartshellInstance.exec(`rm -rf public/`); await this.smartshellInstance.exec(`rm -rf public/`);
await this.smartshellInstance.exec(`docker run --rm -it -p 8000:8000 -v ${paths.cwd}:/docs registry.gitlab.com/hosttoday/ht-docker-mkdocs build`); await this.smartshellInstance.exec(
await this.smartshellInstance.exec(`gitzone commit`); `docker run --rm -p 8000:8000 -v ${
paths.cwd
}:/docs registry.gitlab.com/hosttoday/ht-docker-mkdocs build`
);
} }
public async serve () { public async serve() {
await this.update(); await this.update();
await this.smartshellInstance.exec(`docker run --rm -it -p 8000:8000 -v ${paths.cwd}:/docs registry.gitlab.com/hosttoday/ht-docker-mkdocs`); 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

@ -21,7 +21,9 @@ export class TypeDoc {
this.typedocDirectory = dirPathArg; this.typedocDirectory = dirPathArg;
} }
public async compile () { public async compile() {
await this.smartshellInstance.exec(`typedoc --module "commonjs" --target "ES2016" --out public/ ts/`); await this.smartshellInstance.exec(
`typedoc --module "commonjs" --target "ES2016" --out public/ ts/`
);
} }
} }

View File

@ -8,10 +8,13 @@ import { MkDocs } from './tsdoc.classes.mkdocs';
export const run = async () => { export const run = async () => {
const tsdocCli = new plugins.smartcli.Smartcli(); const tsdocCli = new plugins.smartcli.Smartcli();
tsdocCli.addCommand('typedoc').subscribe(async argvArg => { tsdocCli.addCommand('typedoc').subscribe(async argvArg => {
const typeDocInstance = new TypeDoc(paths.cwd);
await typeDocInstance.compile();
}); });
tsdocCli.addCommand('mkdocs').subscribe(async argvArg => {}); tsdocCli.addCommand('mkdocs').subscribe(async argvArg => {
await MkDocs.handleCommand(argvArg);
});
tsdocCli.standardTask().subscribe(async argvArg => { tsdocCli.standardTask().subscribe(async argvArg => {
logger.log('warn', `Auto detecting environment!`); logger.log('warn', `Auto detecting environment!`);
@ -19,16 +22,22 @@ export const run = async () => {
case await TypeDoc.isTypeDocDir(paths.cwd): case await TypeDoc.isTypeDocDir(paths.cwd):
logger.log('ok', `Detected TypeDoc compliant directory at ${paths.cwd}`); logger.log('ok', `Detected TypeDoc compliant directory at ${paths.cwd}`);
tsdocCli.trigger('typedoc'); tsdocCli.trigger('typedoc');
const typeDocInstance = new TypeDoc(paths.cwd);
await typeDocInstance.compile();
break; break;
case await MkDocs.isMkDocsDir(paths.cwd): case await MkDocs.isMkDocsDir(paths.cwd):
logger.log('ok', `Detected MkDocs compliant directory at ${paths.cwd}`); logger.log('ok', `Detected MkDocs compliant directory at ${paths.cwd}`);
tsdocCli.trigger('mkdocs');
break; break;
default: default:
logger.log('error', `Cannot determine docs format at ${paths.cwd}`); logger.log('error', `Cannot determine docs format at ${paths.cwd}`);
} }
}); });
tsdocCli.addCommand('test').subscribe(argvArg => {
tsdocCli.trigger('typedoc');
process.on('exit', async () => {
await plugins.smartfile.fs.remove(paths.publicDir);
});
});
tsdocCli.startParse(); tsdocCli.startParse();
}; };

View File

@ -3,3 +3,4 @@ import * as plugins from './tsdoc.plugins';
export const packageDir = plugins.path.join(__dirname, '../'); export const packageDir = plugins.path.join(__dirname, '../');
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 publicDir = plugins.path.join(packageDir, './public');