Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/minicli/command-stencil
A command to generate files based on minicli/stencil templates.
https://github.com/minicli/command-stencil
Last synced: 6 days ago
JSON representation
A command to generate files based on minicli/stencil templates.
- Host: GitHub
- URL: https://github.com/minicli/command-stencil
- Owner: minicli
- License: mit
- Created: 2022-06-20T15:47:32.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-06-21T10:12:12.000Z (over 2 years ago)
- Last Synced: 2024-11-19T20:53:05.236Z (about 1 month ago)
- Language: PHP
- Size: 31.3 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Minicli Stencil Command
Command implementation of [minicli/stencil](https://github.com/minicli/stencil). This command will generate files based on Stencil templates. It is useful for creating boilerplate files such as new classes and other documents that should follow a certain structure or template.
## Usage
First, import this command with Composer:
```shell
composer require minicli/command-stencil
```
Then, edit your app's config to include `@minicli/command-help` within your `app_path` definitions.
You'll also need to set the `stencilDir` config variable and point it to your Stencils directory. For instance:
```php
$app = new App([
'app_path' => [
__DIR__ . '/app/Command',
'@minicli/command-stencil'
],
'stencilDir' => __DIR__ . '/stencils',
'debug' => true
]);
```
You should now be able to run the `./minicli stencil` command.
### Testing templates
You can copy the example template from `vendor/minicli/command-stencil/stencils/example.tpl` to test it out:
```shell
cp ./vendor/minicli/command-stencil/stencils/example.tpl ./stencils
```
Then, run `./minicli stencil` with the template set to `example`, providing the expected variable `name`:
```shell
./minicli stencil template=example name=YourName
```
```shell
Hello YourName!%
```
### Output content to a file
Include an `output=full-path-to-file` to save the parsed content to a file:
```shell
./minicli stencil template=example name=YourName output=test.txt
```
```shell
Hello YourName!%
```
You should see a file named `test.txt` with the same output of the command. To suppress the command output, set `debug` to `false` in the app's configuration.