copykat
v0.1.5
Published
pounce on a great code base and build a generator based on it
Downloads
5
Readme
Build a generator that uses geenee based on a model code base.
To create your own generator, make a local copy of a code base that you like and then call copykat pounce $MODEL
and follow the directions.
The generators use geenee, a re-generator tool. That means that you can release your generator and then make changes as needed. Whenever you update it, your users can apply them without losing their custom changes. See more complete instructions below in Usage.
For an example, see easy-oclif-cli.
:wrench: Usage
(1) Create a Template with pounce
To create the template, define:
- MODEL_DIR a directory for the code that will be the basis for your generator
- TEMPLATE_DIR the directory for your template
Then, run
copycat pounce $MODEL_DIR -t $TEMPLATE_DIR
and follow the directions.
(2) Hone the results with chase
copycat chase $TEMPLATE_DIR
You will be directed through the process.
$ npm install -g copykat
$ copykat COMMAND
running command...
$ copykat (-v|--version|version)
copykat/0.1.5 win32-x64 node-v14.15.5
$ copykat --help [COMMAND]
USAGE
$ copykat COMMAND
...
$ npm install -g copykat
$ copykat COMMAND
running command...
$ copykat (-v|--version|version)
copykat/0.1.4 win32-x64 node-v14.15.5
$ copykat --help [COMMAND]
USAGE
$ copykat COMMAND
...
$ npm install -g copykat
$ copykat COMMAND
running command...
$ copykat (-v|--version|version)
copykat/0.1.3 linux-x64 node-v14.9.0
$ copykat --help [COMMAND]
USAGE
$ copykat COMMAND
...
:zap: Commands
copykat chase TEMPLATEDIR
compare generated code to your model, changing both until you've replicated the model with your template
USAGE
$ copykat chase TEMPLATEDIR
ARGUMENTS
TEMPLATEDIR the path to your template
OPTIONS
-h, --help show CLI help
EXAMPLE
$ copykat chase sampleTemplateDir
See code: src/commands/chase.ts
copykat help [COMMAND]
display help for copykat
USAGE
$ copykat help [COMMAND]
ARGUMENTS
COMMAND command to show help for
OPTIONS
--all see all commands in CLI
See code: @oclif/plugin-help
copykat pounce MODEL
specify a model code base and generate a template to build it
USAGE
$ copykat pounce MODEL
ARGUMENTS
MODEL path to a model code base from which you will generate your template
OPTIONS
-h, --help show CLI help
-t, --templateDir=templateDir path to the generator that you will build
EXAMPLE
$ copykat pounce sampleModel -t sampleTemplateDir
See code: src/commands/pounce.ts
copykat chase TEMPLATEDIR
compare generated code to your model, changing both until you've replicated the model with your template
USAGE
$ copykat chase TEMPLATEDIR
ARGUMENTS
TEMPLATEDIR the path to your template
OPTIONS
-h, --help show CLI help
EXAMPLE
$ copykat chase sampleTemplateDir
See code: src/commands/chase.ts
copykat help [COMMAND]
display help for copykat
USAGE
$ copykat help [COMMAND]
ARGUMENTS
COMMAND command to show help for
OPTIONS
--all see all commands in CLI
See code: @oclif/plugin-help
copykat pounce MODEL
specify a model code base and generate a template to build it
USAGE
$ copykat pounce MODEL
ARGUMENTS
MODEL path to a model code base from which you will generate your template
OPTIONS
-h, --help show CLI help
-t, --templateDir=templateDir path to the generator that you will build
EXAMPLE
$ copykat pounce sampleModel -t sampleTemplateDir
See code: src/commands/pounce.ts
copykat chase TEMPLATEDIR
compare generated code to your model, changing both until you've replicated the model with your template
USAGE
$ copykat chase TEMPLATEDIR
ARGUMENTS
TEMPLATEDIR the path to your template
OPTIONS
-h, --help show CLI help
EXAMPLE
$ copykat chase sampleTemplateDir
See code: src/commands/chase.ts
copykat help [COMMAND]
display help for copykat
USAGE
$ copykat help [COMMAND]
ARGUMENTS
COMMAND command to show help for
OPTIONS
--all see all commands in CLI
See code: @oclif/plugin-help
copykat pounce MODEL
specify a model code base and generate a template to build it
USAGE
$ copykat pounce MODEL
ARGUMENTS
MODEL path to a model code base from which you will generate your template
OPTIONS
-h, --help show CLI help
-t, --templateDir=templateDir path to the generator that you will build
EXAMPLE
$ copykat pounce sampleModel -t sampleTemplateDir
See code: src/commands/pounce.ts