README
¶
Boilerplate
Boilerplate is a tool for generating files and folders ("boilerplate") from a set of templates.
Please see the following for more info, including install instructions and complete documentation:
Join the Discord!
Join our community for discussions, support, and contributions:
License
This code is released under the MPLv2 License. See LICENSE.txt.
Documentation
¶
There is no documentation for this package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package cli provides the command-line interface for the boilerplate tool.
|
Package cli provides the command-line interface for the boilerplate tool. |
|
cmd
|
|
|
wasm/full
command
The full WASM build registers boilerplateRenderTemplate, boilerplateInputsMap, boilerplateRenderFile, boilerplateRenderFiles, and the prepared-bundle trio (boilerplatePrepareBundle, boilerplateRenderFilesWithHandle, boilerplateReleaseBundle).
|
The full WASM build registers boilerplateRenderTemplate, boilerplateInputsMap, boilerplateRenderFile, boilerplateRenderFiles, and the prepared-bundle trio (boilerplatePrepareBundle, boilerplateRenderFilesWithHandle, boilerplateReleaseBundle). |
|
wasm/inputs
Package inputs exposes the boilerplateInputsMap js.Func factory.
|
Package inputs exposes the boilerplateInputsMap js.Func factory. |
|
wasm/internal/bundlewasm
Package bundlewasm holds the pure-Go helpers shared by every full-build WASM handler: the bundle JSON shape, path validation, MapFS construction, the inputs lifter, error-kind taxonomy, and per-handler boilerplate.
|
Package bundlewasm holds the pure-Go helpers shared by every full-build WASM handler: the bundle JSON shape, path validation, MapFS construction, the inputs lifter, error-kind taxonomy, and per-handler boilerplate. |
|
wasm/lite
command
The lite WASM build registers only boilerplateRenderTemplate.
|
The lite WASM build registers only boilerplateRenderTemplate. |
|
wasm/preparedbundle
Package preparedbundle exposes a JS handle API for parsing a bundle once and reusing the parse across many renders.
|
Package preparedbundle exposes a JS handle API for parsing a bundle once and reusing the parse across many renders. |
|
wasm/render
Package render exposes the boilerplateRenderTemplate js.Func factory.
|
Package render exposes the boilerplateRenderTemplate js.Func factory. |
|
wasm/renderfile
Package renderfile exposes the boilerplateRenderFile js.Func factory.
|
Package renderfile exposes the boilerplateRenderFile js.Func factory. |
|
wasm/renderfiles
Package renderfiles exposes the boilerplateRenderFiles js.Func factory.
|
Package renderfiles exposes the boilerplateRenderFiles js.Func factory. |
|
Package config provides functionality for loading and parsing boilerplate configuration files.
|
Package config provides functionality for loading and parsing boilerplate configuration files. |
|
Package getterhelper provides custom getter implementations for file operations.
|
Package getterhelper provides custom getter implementations for file operations. |
|
Package inputs provides static analysis of boilerplate templates to compute which output files are affected by each declared input variable.
|
Package inputs provides static analysis of boilerplate templates to compute which output files are affected by each declared input variable. |
|
internal
|
|
|
color
Package color provides lightweight ANSI terminal color helpers.
|
Package color provides lightweight ANSI terminal color helpers. |
|
fileutil
Package fileutil provides file-system utility functions.
|
Package fileutil provides file-system utility functions. |
|
manifest/v1
Package v1 defines the v1 manifest schema types, validation, and schema generation.
|
Package v1 defines the v1 manifest schema types, validation, and schema generation. |
|
manifest/v2
Package v2 defines the v2 manifest schema types, validation, and schema generation.
|
Package v2 defines the v2 manifest schema types, validation, and schema generation. |
|
shell
Package shell provides helpers for executing external commands.
|
Package shell provides helpers for executing external commands. |
|
Package manifest provides functionality for reading, writing, and validating boilerplate generation manifests.
|
Package manifest provides functionality for reading, writing, and validating boilerplate generation manifests. |
|
Package options provides configuration options for the boilerplate tool.
|
Package options provides configuration options for the boilerplate tool. |
|
pkg
|
|
|
logging
Package logging provides a level-gated logger interface for boilerplate.
|
Package logging provides a level-gated logger interface for boilerplate. |
|
Package prompt provides interactive user prompting.
|
Package prompt provides interactive user prompting. |
|
Package render provides functionality for rendering templates and processing various file formats.
|
Package render provides functionality for rendering templates and processing various file formats. |
|
Package templates provides functionality for processing and rendering templates.
|
Package templates provides functionality for processing and rendering templates. |
|
test-fixtures
|
|
|
Package testutil provides utilities for testing.
|
Package testutil provides utilities for testing. |
|
Package util provides utility functions for common operations.
|
Package util provides utility functions for common operations. |
|
Package validation provides input validation rules for boilerplate variables.
|
Package validation provides input validation rules for boilerplate variables. |
|
Package variables provides functionality for handling template variables and dependencies.
|
Package variables provides functionality for handling template variables and dependencies. |
|
Package version contains the version number for the boilerplate tool.
|
Package version contains the version number for the boilerplate tool. |
Click to show internal directories.
Click to hide internal directories.