From 1b6920aa47f39d3681a74eff5b798cfa0ec9e517 Mon Sep 17 00:00:00 2001 From: loripam Date: Mon, 8 Mar 2021 21:46:33 +0700 Subject: [PATCH] 0.1.18 --- README.md | 109 ++++++++++++++++++++++++++++++++++++++++++++++ package-lock.json | 2 +- package.json | 2 +- 3 files changed, 111 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index a31236b..86393cf 100644 --- a/README.md +++ b/README.md @@ -45,6 +45,13 @@ Code **Re**generator. Reapplies your template without losing your changes * [:zap: Commands](#a-namezap-commandsazap-commands) * [:heavy_exclamation_mark: Help](#a-nameheavy_exclamation_mark-helpaheavy_exclamation_mark-help) +* [:clipboard: Why](#a-nameclipboard-whyaclipboard-why) +* [:white_check_mark: Steps](#a-namewhite_check_mark-stepsawhite_check_mark-steps) +* [:bulb: A Funny Sample](#a-namebulb-a-funny-sampleabulb-a-funny-sample) +* [:wrench: Usage](#a-namewrench-usageawrench-usage) +* [:zap: Commands](#a-namezap-commandsazap-commands) +* [:heavy_exclamation_mark: Help](#a-nameheavy_exclamation_mark-helpaheavy_exclamation_mark-help) + [//]: # ( ns__custom_end toc ) @@ -98,6 +105,18 @@ $ npm install -g geenee $ geenee COMMAND running command... $ geenee (-v|--version|version) +geenee/0.1.18 win32-x64 node-v14.15.5 +$ geenee --help [COMMAND] +USAGE + $ geenee COMMAND +... +``` + +```sh-session +$ npm install -g geenee +$ geenee COMMAND +running command... +$ geenee (-v|--version|version) geenee/0.1.17 linux-x64 node-v15.8.0 $ geenee --help [COMMAND] USAGE @@ -140,6 +159,96 @@ EXAMPLE $ geenee check sampleCode ``` +_See code: [src/commands/check.ts](https://github.com/YizYah/geenee/blob/v0.1.18/src/commands/check.ts)_ + +## `geenee generate CODE` + +generates code based on a template and a settings file. To set the template, you need the template flag. + +``` +USAGE + $ geenee generate CODE + +ARGUMENTS + CODE path to the code base to generate + +OPTIONS + -h, --help show CLI help + + -n, --noSetup Do not update the startup routine (this is only relevant when the template flag is also + used). Saves a lot of time for a template developer. + + -t, --template=template Template directory. Will generate from the template, and will override any prior template or + template version used. + +EXAMPLE + $ geenee generate sampleCode -t sampleTemplate -n + You have executed the generate command... +``` + +_See code: [src/commands/generate.ts](https://github.com/YizYah/geenee/blob/v0.1.18/src/commands/generate.ts)_ + +## `geenee help [COMMAND]` + +display help for geenee + +``` +USAGE + $ geenee help [COMMAND] + +ARGUMENTS + COMMAND command to show help for + +OPTIONS + --all see all commands in CLI +``` + +_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v3.2.2/src/commands/help.ts)_ + +## `geenee settings CODE` + +change your settings for the next generation + +``` +USAGE + $ geenee settings CODE + +ARGUMENTS + CODE path to the code base + +OPTIONS + -h, --help show CLI help + +EXAMPLE + $ geenee settings sampleCode + You have executed the settings command... +``` + +_See code: [src/commands/settings.ts](https://github.com/YizYah/geenee/blob/v0.1.18/src/commands/settings.ts)_ + +* [`geenee check CODE`](#geenee-check-code) +* [`geenee generate CODE`](#geenee-generate-code) +* [`geenee help [COMMAND]`](#geenee-help-command) +* [`geenee settings CODE`](#geenee-settings-code) + +## `geenee check CODE` + +checks that the code has been entered safely, meaning that regeneration won't lose any changes + +``` +USAGE + $ geenee check CODE + +ARGUMENTS + CODE path to the code base to check + +OPTIONS + -h, --help show CLI help + +EXAMPLE + $ geenee check sampleCode +``` + _See code: [src/commands/check.ts](https://github.com/YizYah/geenee/blob/v0.1.17/src/commands/check.ts)_ ## `geenee generate CODE` diff --git a/package-lock.json b/package-lock.json index e1e2c9d..cbee988 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,6 +1,6 @@ { "name": "geenee", - "version": "0.1.17", + "version": "0.1.18", "lockfileVersion": 1, "requires": true, "dependencies": { diff --git a/package.json b/package.json index 64197a5..54a82b8 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "geenee", - "version": "0.1.17", + "version": "0.1.18", "description": "code regenerator. reapplies templates without losing custom changes", "main": "lib/index.ts", "scripts": {