Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/flarebyte/baldrick-whisker
Code generator for Elm and Typescript using templates
https://github.com/flarebyte/baldrick-whisker
handlebars npm-cli template-engine
Last synced: 27 days ago
JSON representation
Code generator for Elm and Typescript using templates
- Host: GitHub
- URL: https://github.com/flarebyte/baldrick-whisker
- Owner: flarebyte
- License: mit
- Created: 2022-05-27T07:55:12.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-12-06T09:31:29.000Z (almost 2 years ago)
- Last Synced: 2024-10-12T13:33:49.622Z (about 1 month ago)
- Topics: handlebars, npm-cli, template-engine
- Language: TypeScript
- Homepage:
- Size: 189 KB
- Stars: 0
- Watchers: 2
- 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
# Baldrick-whisker
 
> Code generator for Elm and Typescript using templates
## Usage
### Options
```bash
Usage: baldrick-whisker [options] [command]
CLI to generate code using templates
Options:
- V, --version output the version
number
- h, --help display help for
command
Commands:
object Convert source files to
JSON or YAML
render [options] Render a template
help [command] display help for command
```
Convert source files to JSON or YAML
```bash
Usage: baldrick-whisker object [options]
Convert source files to JSON or YAML
Arguments:
destination the path to the JSON or YAML destination file
sources the path to the input filenames (JSON, YAML, Elm)
Options:
- h, --help display help for command
```
Render a template
```bash
Usage: baldrick-whisker render [options]
Render a template
Arguments:
source the path to source file in JSON or YAML
template the path to the Handlebars template
destination the path to the destination file (elm, ...)
Options:
- -diff Only display the difference in the console
- cfg, --config Configuration as a JSON line
- h, --help display help for command
```
Please note that a filename can also be github filename such as
`github:flarebyte:baldrick-whisker:package.json`.
You can check the `script/cli-test.sh` shell script for some examples.
### Template
#### ifSatisfy
> Check if a condition is satisfied before executing the block
```handlebars
{{#ifSatisfy "equals" keywords "mustache"}}
Will display if the word mustache is in the list of keywords
{{/ifSatisfy}}
```
```handlebars
{{#ifSatisfy "not equals" keywords "mustache"}}
Will display if the word mustache is not in the list of keywords
{{/ifSatisfy}}
```
```handlebars
{{#ifSatisfy "contains" description "Elm"}}
Will display if the word Elm is in the description
{{/ifSatisfy}}
```
```handlebars
{{#ifSatisfy "contains ignore-case" description "Elm OR Python"}}
Will display if the words Elm or Python is in the description ignoring the
case
{{/ifSatisfy}}
```
```handlebars
{{#ifSatisfy "starts-with ignore-space" description "Code generator"}}
Will display if the description starts with Code generator ignoring any spaces
{{/ifSatisfy}}
```
```handlebars
{{#ifSatisfy "not ends-with" description "templates"}}
Will display if the description does not ends with templates
{{/ifSatisfy}}
```
```handlebars
{{#ifSatisfy "contains ignore-punctuation" description "Code&generator"}}
Will display if the description contains "Code generator" ignoring any
punctuation
{{/ifSatisfy}}
```
#### listJoin
> Join a list with a separator
```handlebars
|{{#listJoin "|" keywords}} {{this}} {{/listJoin}}|
```
```handlebars
{{#listJoin ', newline' params}}
* {{paramName}} ==> {{paramType}} ==> {{upperCamelCase
paramType}}{{/listJoin}}
{{/each}}
```
#### String transformers
| Function | input | output |
| -------------------------- | ---------- | ---------- |
| `{{upperFirstChar value}}` | baldrick | Baldrick |
| `{{lowerFirstChar value}}` | Baldrick | baldrick |
| `{{upperCamelCase value}}` | great idea | GreatIdea |
| `{{lowerCamelCase value}}` | great idea | greatIdea |
| `{{toTitle value}}` | GreatIdea | Great idea |
| `{{dasherize value}}` | GreatIdea | great-idea |
## Documentation and links
- [Code Maintenance](MAINTENANCE.md)
- [Code Of Conduct](CODE_OF_CONDUCT.md)
- [Api for baldrick-whisker](API.md)
- [Contributing](CONTRIBUTING.md)
- [Glossary](GLOSSARY.md)
- [Diagram for the code base](INTERNAL.md)
- [Vocabulary used in the code base](CODE_VOCABULARY.md)
- [Architectural Decision Records](DECISIONS.md)
- [Contributors](https://github.com/flarebyte/baldrick-whisker/graphs/contributors)
- [Dependencies](https://github.com/flarebyte/baldrick-whisker/network/dependencies)
## Installation
This package is [ESM
only](https://blog.sindresorhus.com/get-ready-for-esm-aa53530b3f77).
```bash
yarn global add baldrick-whisker
baldrick-whisker --help
```
Or alternatively run it:
```bash
npx baldrick-whisker --help
```
If you want to tun the latest version from github. Mostly useful for dev:
```bash
git clone [email protected]:flarebyte/baldrick-whisker.git
yarn global add `pwd`
```