Skip to content

Commit

Permalink
0.1.20
Browse files Browse the repository at this point in the history
  • Loading branch information
loripam committed Mar 11, 2021
1 parent ffb662f commit 1d472f7
Show file tree
Hide file tree
Showing 3 changed files with 111 additions and 2 deletions.
109 changes: 109 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,13 @@ Code **Re**generator. Reapplies your template without losing your changes

[//]: # ( ns__custom_start toc )
<!-- toc -->
* [<a name="clipboard-why"></a>:clipboard: Why](#a-nameclipboard-whyaclipboard-why)
* [<a name="white_check_mark-steps"></a>:white_check_mark: Steps](#a-namewhite_check_mark-stepsawhite_check_mark-steps)
* [<a name="bulb-a-funny-sample"></a>:bulb: A Funny Sample](#a-namebulb-a-funny-sampleabulb-a-funny-sample)
* [<a name="wrench-usage"></a>:wrench: Usage](#a-namewrench-usageawrench-usage)
* [<a name="zap-commands"></a>:zap: Commands](#a-namezap-commandsazap-commands)
* [<a name="heavy_exclamation_mark-help"></a>:heavy_exclamation_mark: Help](#a-nameheavy_exclamation_mark-helpaheavy_exclamation_mark-help)
<!-- tocstop -->
* [:clipboard: Why](#clipboard-why)
* [:white_check_mark: Steps](#white_check_mark-steps)
* [:bulb: A Funny Sample](#bulb-a-funny-sample)
Expand Down Expand Up @@ -98,6 +105,18 @@ $ npm install -g geenee
$ geenee COMMAND
running command...
$ geenee (-v|--version|version)
geenee/0.1.20 win32-x64 node-v14.15.5
$ geenee --help [COMMAND]
USAGE
$ geenee COMMAND
...
```
<!-- usagestop -->
```sh-session
$ npm install -g geenee
$ geenee COMMAND
running command...
$ geenee (-v|--version|version)
geenee/0.1.19 win32-x64 node-v14.15.5
$ geenee --help [COMMAND]
USAGE
Expand Down Expand Up @@ -164,6 +183,96 @@ EXAMPLE
$ geenee check sampleCode
```

_See code: [src/commands/check.ts](https://github.com/YizYah/geenee/blob/v0.1.20/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.20/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.20/src/commands/settings.ts)_
<!-- commandsstop -->
* [`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.19/src/commands/check.ts)_

## `geenee generate CODE`
Expand Down
2 changes: 1 addition & 1 deletion package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "geenee",
"version": "0.1.19",
"version": "0.1.20",
"description": "code regenerator. reapplies templates without losing custom changes",
"main": "lib/index.ts",
"scripts": {
Expand Down

0 comments on commit 1d472f7

Please sign in to comment.