README
¶
stencil
[!WARNING] This version of Stencil is in maintenance mode. That is, there is not enough time to maintain this aside from bug fixes and Outreach-specific features. The next-generation of this tool is currently located at
rgst-io/stencil.
microservice lifecycle manager
Contributing
Please read the CONTRIBUTING.md document for guidelines on developing and contributing changes.
High-level Overview
Stencil is a smart templating engine for service/library development aimed to reduce the use of boilerplate code.
Check out our documentation for more information!
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
stencil
command
|
|
|
docs
module
|
|
|
internal
|
|
|
cmd/stencil
Package stencil implements the stencil command, which is essentially a thing wrapper around the codegen package which does most of the heavy lifting.
|
Package stencil implements the stencil command, which is essentially a thing wrapper around the codegen package which does most of the heavy lifting. |
|
codegen
Package codegen implements the core code generation functionality of stencil.
|
Package codegen implements the core code generation functionality of stencil. |
|
dotnotation
Package dotnotation implements a dotnotation (hello.world) for accessing fields within a map[string]interface{}
|
Package dotnotation implements a dotnotation (hello.world) for accessing fields within a map[string]interface{} |
|
git
Package git implements helpers for interacting with git
|
Package git implements helpers for interacting with git |
|
gitauth
Package gitauth provides helpers for setting up auth
|
Package gitauth provides helpers for setting up auth |
|
lint
Package lint defines the shared finding model used by the stencil lint subcommands.
|
Package lint defines the shared finding model used by the stencil lint subcommands. |
|
lint/manifest
Package manifest implements static validation of a Stencil template repository manifest (manifest.yaml) without resolving dependencies or accessing the network.
|
Package manifest implements static validation of a Stencil template repository manifest (manifest.yaml) without resolving dependencies or accessing the network. |
|
lint/modulefix
Package modulefix implements the shared module-deprecation auto-fix used by both the manifest and project-manifest linters.
|
Package modulefix implements the shared module-deprecation auto-fix used by both the manifest and project-manifest linters. |
|
lint/projectmanifest
Package projectmanifest implements static offline validation of a Stencil project manifest (service.yaml).
|
Package projectmanifest implements static offline validation of a Stencil project manifest (service.yaml). |
|
lint/templates
Package templates implements static block-correctness validation of Stencil template files without rendering or resolving dependencies.
|
Package templates implements static block-correctness validation of Stencil template files without rendering or resolving dependencies. |
|
lint/yamlfix
Package yamlfix provides generic yaml.Node DOM primitives shared by the Stencil manifest lint fixers and line resolvers.
|
Package yamlfix provides generic yaml.Node DOM primitives shared by the Stencil manifest lint fixers and line resolvers. |
|
modules
Package modules implements all logic needed for interacting with stencil modules and their interaction with a service generated by stencil.
|
Package modules implements all logic needed for interacting with stencil modules and their interaction with a service generated by stencil. |
|
modules/modulestest
Package modulestest contains code for interacting with modules in tests.
|
Package modulestest contains code for interacting with modules in tests. |
|
pkg
|
|
|
configuration
Package configuration implements configuration loading logic for stencil repositories and template repositories
|
Package configuration implements configuration loading logic for stencil repositories and template repositories |
|
extensions
Package extensions consumes extensions in stencil
|
Package extensions consumes extensions in stencil |
|
extensions/apiv1
Package apiv1 implements the bridge between a extension and go-plugin providing most of the implementation for the extension if it's written in Go.
|
Package apiv1 implements the bridge between a extension and go-plugin providing most of the implementation for the extension if it's written in Go. |
|
stencil
Package stencil provides an entry point for interacting with Stencil.
|
Package stencil provides an entry point for interacting with Stencil. |
|
stenciltest
Package stenciltest contains code for testing templates
|
Package stenciltest contains code for testing templates |
Click to show internal directories.
Click to hide internal directories.