code regenerator. reapplies templates without losing custom changes
npm install geenee
[//]: # ( ns__file unit: standard, comp: README.md )
[//]: # ( ns__custom_start beginning )
[//]: # ( ns__custom_end beginning )
[//]: # ( ns__start_section intro )
[//]: # ( ns__custom_start description )
[//]: # ( ns__custom_end description )
[//]: # ( ns__custom_start afterDescription )
!geenee logo
Code Regenerator. Reapplies your template without losing your changes
[//]: # ( ns__custom_end afterDescription )
[//]: # ( ns__custom_start badges )
[//]: # ( ns__start_section usageSection )




[//]: # ( ns__custom_end badges )
[//]: # ( ns__end_section intro )
[//]: # ( ns__custom_start beforeToc )
[//]: # ( ns__custom_end beforeToc )
[//]: # ( ns__custom_start toc )
* :clipboard: Why
* :white_check_mark: Steps
* :bulb: A Funny Sample
* :wrench: Usage
* :zap: Commands
* :heavy_exclamation_mark: Help
[//]: # ( ns__custom_end toc )
[//]: # ( ns__custom_start usage )
geenee, you can reapply the template without losing your custom code!
settings if you haven't yet, and set or modify what you want to generate:
npx geenee $CODE_PATH
`
2. You should always check first to be sure that your changes will be safe:
`
npx geenee check $CODE_PATH
`
3. You should regenerate your code after you:
* update your template (follow the instructions with its README)
* update your settings file.
Here's the command:
`
npx geenee generate $CODE_PATH
`
4. After you generate, you should always run npm i to install everything.
If you would like to install geenee globally to save time, call:
`
npm i -g geenee
`
Then, you can simply call the commands directly using geenee instead of npx geenee .
See more complete instructions below in Usage.
:bulb: A Funny Sample
geenee is actually a recursive tool: geenee was generated by geenee! :smiley: It is based on the easy-oclif-cli template.
!geenee sample
:wrench: Usage
`sh-session
$ npm install -g geenee
$ geenee COMMAND
running command...
$ geenee (-v|--version|version)
geenee/0.1.24 win32-x64 node-v14.15.5
$ geenee --help [COMMAND]
USAGE
$ geenee COMMAND
...
`
[//]: # ( ns__custom_end usage )
[//]: # ( ns__end_section usageSection )
[//]: # ( ns__start_section commandsSection )
:zap: Commands
[//]: # ( ns__custom_start commands )
* geenee check CODE
* geenee generate CODE
* [geenee help [COMMAND]](#geenee-help-command)
* 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_
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_
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_
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...
``