https://github.com/swiftgen/stencilswiftkit
A framework bringing additional nodes & filters to Stencil dedicated to Swift code generation
https://github.com/swiftgen/stencilswiftkit
Last synced: about 1 year ago
JSON representation
A framework bringing additional nodes & filters to Stencil dedicated to Swift code generation
- Host: GitHub
- URL: https://github.com/swiftgen/stencilswiftkit
- Owner: SwiftGen
- License: mit
- Created: 2017-01-01T22:40:30.000Z (over 9 years ago)
- Default Branch: stable
- Last Pushed: 2023-03-17T06:01:28.000Z (over 3 years ago)
- Last Synced: 2025-03-29T01:13:58.791Z (about 1 year ago)
- Language: Swift
- Size: 29 MB
- Stars: 299
- Watchers: 10
- Forks: 58
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# StencilSwiftKit
[](https://circleci.com/gh/SwiftGen/StencilSwiftKit/tree/stable)
[](https://img.shields.io/cocoapods/v/StencilSwiftKit.svg)
[](http://cocoadocs.org/docsets/StencilSwiftKit)
`StencilSwiftKit` is a framework bringing additional [Stencil](https://github.com/stencilproject/Stencil) nodes & filters dedicated to Swift code generation.
## Tags
* [Macro](Documentation/tag-macro.md) & [Call](Documentation/tag-call.md)
* `{% macro %}…{% endmacro %}`
* Defines a macro that will be replaced by the nodes inside of this block later when called
* `{% call %}`
* Calls a previously defined macro, passing it some arguments
* [Set](Documentation/tag-set.md)
* `{% set %}…{% endset %}`
* Renders the nodes inside this block immediately, and stores the result in the `` variable of the current context.
* [Import](Documentation/tag-import.md)
* `{% import "common.stencil" %}`
* Imports any macro & set definitions from `common.stencil` into the current context.
* [Map](Documentation/tag-map.md)
* `{% map into using %}…{% endmap %}`
* Apply a `map` operator to an array, and store the result into a new array variable `` in the current context.
* Inside the map loop, a `maploop` special variable is available (akin to the `forloop` variable in `for` nodes). It exposes `maploop.counter`, `maploop.first`, `maploop.last` and `maploop.item`.
## Filters
* [String filters](Documentation/filters-strings.md):
* `basename`: Get the filename from a path.
* `camelToSnakeCase`: Transforms text from camelCase to snake_case. By default it converts to lower case, unless a single optional argument is set to "false", "no" or "0".
* `contains`: Check if a string contains a specific substring.
* `dirname`: Get the path to the parent folder from a path.
* `escapeReservedKeywords`: Escape keywords reserved in the Swift language, by wrapping them inside backticks so that the can be used as regular escape keywords in Swift code.
* `hasPrefix` / `hasSuffix`: Check if a string starts/ends with a specific substring.
* `lowerFirstLetter`: Lowercases only the first letter of a string.
* `lowerFirstWord`: Lowercases only the first word of a string.
* `replace`: Replaces instances of a substring with a new string.
* `snakeToCamelCase`: Transforms text from snake_case to camelCase. By default it keeps leading underscores, unless a single optional argument is set to "true", "yes" or "1".
* `swiftIdentifier`: Transforms an arbitrary string into a valid Swift identifier (using only valid characters for a Swift identifier as defined in the Swift language reference). In "pretty" mode, it will also apply the snakeToCamelCase filter afterwards, and other manipulations if needed for a "prettier" but still valid identifier.
* `upperFirstLetter`: Uppercases only the first character
* [Number filters](Documentation/filters-numbers.md):
* `int255toFloat`
* `hexToInt`
* `percent`
## Stencil.Extension & swiftStencilEnvironment
This framework also contains [helper methods for `Stencil.Extension` and `Stencil.Environment`](https://github.com/SwiftGen/StencilSwiftKit/blob/stable/Sources/StencilSwiftKit/Environment.swift), to easily register all the tags and filters listed above on an existing `Stencil.Extension`, as well as to easily get a `Stencil.Environment` preconfigured with both those tags & filters `Extension`.
## Parameters
This framework contains an additional parser, meant to parse a list of parameters from the CLI. For example, using [Commander](https://github.com/kylef/Commander), if you receive a `[String]` from a `VariadicOption`, you can use the parser to convert it into a structured dictionary. For example:
```swift
["foo=1", "bar=2", "baz.qux=hello", "baz.items=a", "baz.items=b", "something"]
```
will become
```swift
[
"foo": "1",
"bar": "2",
"baz": [
"qux": "hello",
"items": [
"a",
"b"
]
],
something: true
]
```
For easier use, you can use the `StencilContext.enrich(context:parameters:environment:)` function to add the following variables to a context:
- `param`: the parsed parameters using the parser mentioned above.
- `env`: a dictionary with all available environment variables (such as `PATH`).
---
# Licence
This code and tool is under the MIT Licence. See the `LICENCE` file in this repository.