From 7a43b7665acd95976fa4496c9e0bec891ae7e112 Mon Sep 17 00:00:00 2001 From: Aschen Date: Wed, 19 Jan 2022 06:05:54 +0100 Subject: [PATCH] 2.5.0 --- README.md | 37 ++++++++++++++++++++++++++++--------- package-lock.json | 2 +- package.json | 2 +- 3 files changed, 30 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 4b1660a..017284d 100644 --- a/README.md +++ b/README.md @@ -23,7 +23,7 @@ $ npm install -g kuzdoc $ kuzdoc COMMAND running command... $ kuzdoc (-v|--version|version) -kuzdoc/2.4.2 darwin-x64 node-v12.18.3 +kuzdoc/2.5.0 linux-x64 node-v14.17.0 $ kuzdoc --help [COMMAND] USAGE $ kuzdoc COMMAND @@ -39,6 +39,7 @@ USAGE * [`kuzdoc build-and-deploy`](#kuzdoc-build-and-deploy) * [`kuzdoc dead-links`](#kuzdoc-dead-links) * [`kuzdoc dev`](#kuzdoc-dev) +* [`kuzdoc generate:js FILEPATH`](#kuzdoc-generatejs-filepath) * [`kuzdoc help [COMMAND]`](#kuzdoc-help-command) * [`kuzdoc install`](#kuzdoc-install) * [`kuzdoc local-deploy`](#kuzdoc-local-deploy) @@ -58,7 +59,7 @@ DESCRIPTION NOTE: This command must be executed from the root of the framework meta-repo. ``` -_See code: [src/commands/add-repo.ts](https://github.com/kuzzleio/kuzdoc/blob/v2.4.2/src/commands/add-repo.ts)_ +_See code: [src/commands/add-repo.ts](https://github.com/kuzzleio/kuzdoc/blob/v2.5.0/src/commands/add-repo.ts)_ ## `kuzdoc add-section` @@ -75,7 +76,7 @@ DESCRIPTION NOTE: This command must be executed from the root of the framework meta-repo. ``` -_See code: [src/commands/add-section.ts](https://github.com/kuzzleio/kuzdoc/blob/v2.4.2/src/commands/add-section.ts)_ +_See code: [src/commands/add-section.ts](https://github.com/kuzzleio/kuzdoc/blob/v2.5.0/src/commands/add-section.ts)_ ## `kuzdoc build-and-deploy` @@ -116,7 +117,7 @@ DESCRIPTION be properly set. ``` -_See code: [src/commands/build-and-deploy.ts](https://github.com/kuzzleio/kuzdoc/blob/v2.4.2/src/commands/build-and-deploy.ts)_ +_See code: [src/commands/build-and-deploy.ts](https://github.com/kuzzleio/kuzdoc/blob/v2.5.0/src/commands/build-and-deploy.ts)_ ## `kuzdoc dead-links` @@ -145,7 +146,7 @@ DESCRIPTION The repository must be previously installed in the framework via the "install" command. ``` -_See code: [src/commands/dead-links.ts](https://github.com/kuzzleio/kuzdoc/blob/v2.4.2/src/commands/dead-links.ts)_ +_See code: [src/commands/dead-links.ts](https://github.com/kuzzleio/kuzdoc/blob/v2.5.0/src/commands/dead-links.ts)_ ## `kuzdoc dev` @@ -170,7 +171,25 @@ DESCRIPTION variable, or via the interactive prompt (only the installed repositories are listed). ``` -_See code: [src/commands/dev.ts](https://github.com/kuzzleio/kuzdoc/blob/v2.4.2/src/commands/dev.ts)_ +_See code: [src/commands/dev.ts](https://github.com/kuzzleio/kuzdoc/blob/v2.5.0/src/commands/dev.ts)_ + +## `kuzdoc generate:js FILEPATH` + +Generate the documentation of a class written in Typescript. + +``` +USAGE + $ kuzdoc generate:js FILEPATH + +ARGUMENTS + FILEPATH File containing the class to generate the doc + +OPTIONS + -h, --help show CLI help + --path=path [default: generated] Directory to write the doc +``` + +_See code: [src/commands/generate/js.ts](https://github.com/kuzzleio/kuzdoc/blob/v2.5.0/src/commands/generate/js.ts)_ ## `kuzdoc help [COMMAND]` @@ -187,7 +206,7 @@ OPTIONS --all see all commands in CLI ``` -_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v3.2.1/src/commands/help.ts)_ +_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v3.2.18/src/commands/help.ts)_ ## `kuzdoc install` @@ -235,7 +254,7 @@ DESCRIPTION repository is already present, the selected repository will be skipped and the folder will be left untouched. ``` -_See code: [src/commands/install.ts](https://github.com/kuzzleio/kuzdoc/blob/v2.4.2/src/commands/install.ts)_ +_See code: [src/commands/install.ts](https://github.com/kuzzleio/kuzdoc/blob/v2.5.0/src/commands/install.ts)_ ## `kuzdoc local-deploy` @@ -256,5 +275,5 @@ DESCRIPTION All the currently installed repositories will be built and deployed to the destination path. ``` -_See code: [src/commands/local-deploy.ts](https://github.com/kuzzleio/kuzdoc/blob/v2.4.2/src/commands/local-deploy.ts)_ +_See code: [src/commands/local-deploy.ts](https://github.com/kuzzleio/kuzdoc/blob/v2.5.0/src/commands/local-deploy.ts)_ diff --git a/package-lock.json b/package-lock.json index 6af0ca2..9a5afa9 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,6 +1,6 @@ { "name": "kuzdoc", - "version": "2.4.2", + "version": "2.5.0", "lockfileVersion": 1, "requires": true, "dependencies": { diff --git a/package.json b/package.json index 822008d..04f972a 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "kuzdoc", "description": "The CLI that helps build the Kuzzle Docs", - "version": "2.4.2", + "version": "2.5.0", "author": "The Kuzzle Team ", "bin": { "kuzdoc": "./bin/run"