This is the mystic Reference Manual, version 0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Wed Mar 15 07:04:39 2023 GMT+0.
The main system appears first, followed by any subsystem dependency.
mystic
A project skeleton generator.
Fernando Borretti <eudoxiahp@gmail.com>
Fernando Borretti <eudoxiahp@gmail.com>
(GIT )
MIT
# Mystic
[](https://travis-ci.org/roswell/mystic)
A modular project skeleton generator.
# Overview
Some features:
* **Declarative:** Options are specified in a declarative interface, so you have
have multiple front-ends (command line, web, etc.) to the project generator.
* **Modular:** Most of the functionality common to different templates
(e.g. Travis support, the ‘.gitignore‘ file) is implemented as mixins.
# Usage
“‘lisp
(mystic:render (make-instance ’mystic.template.library:library-template)
(list :name "your-project"
:author "You"
:email "you@gmail.com"
:license "MIT"
:description "A one-line description of your project."
:dependencies "clack, postmodern")
#p"/home/you/code/your-project/")
“‘
I’ll get around to writing an actual interface at some point.
# License
Copyright (c) 2016 Fernando Borretti (eudoxiahp@gmail.com)
Licensed under the MIT License.
0.1
cl-mustache
(system).
split-sequence
(system).
anaphora
(system).
local-time
(system).
src
(module).
Modules are listed depth-first from the system components tree.
mystic/src
mystic
(system).
util.lisp
(file).
mystic.lisp
(file).
Files are sorted by type and then listed depth-first from the systems components trees.
mystic/src/util.lisp
src
(module).
parse-systems-list
(function).
read-template-file
(function).
render-string
(function).
strip-whitespace
(function).
write-file
(function).
mystic/src/mystic.lisp
util.lisp
(file).
src
(module).
boolean-option
(class).
list-templates
(function).
missing-required-option
(condition).
multiple-choice-option
(class).
option
(class).
option-default
(reader method).
option-docstring
(reader method).
option-name
(reader method).
option-name
(reader method).
option-required-p
(reader method).
option-title
(reader method).
prompt-option
(class).
register-template
(function).
render
(function).
render-template
(generic function).
template
(class).
template-docstring
(reader method).
template-name
(reader method).
template-options
(reader method).
validate-options
(method).
*templates*
(special variable).
option-choices
(reader method).
option-processor
(reader method).
Packages are listed by definition order.
mystic
common-lisp
.
boolean-option
(class).
list-templates
(function).
missing-required-option
(condition).
multiple-choice-option
(class).
option
(class).
option-default
(generic reader).
option-docstring
(generic reader).
option-name
(generic reader).
option-required-p
(generic reader).
option-title
(generic reader).
prompt-option
(class).
register-template
(function).
render
(function).
render-template
(generic function).
template
(class).
template-docstring
(generic reader).
template-name
(generic reader).
template-options
(generic reader).
validate-options
(generic function).
*templates*
(special variable).
option-choices
(generic reader).
option-processor
(generic reader).
mystic.util
Utilities for Mystic.
common-lisp
.
parse-systems-list
(function).
read-template-file
(function).
render-string
(function).
strip-whitespace
(function).
write-file
(function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Return a list of project templates.
Read a pathname relative to the templates/ directory into a string.
Register a template.
Render a @cl:param(template) to a @cl:param(directory). The
@cl:param(options) are a plist of option names to their supplied values.
This is the user-level entrypoint, and performs option validation and anything that needs to be done before handing over the task of rendering to the actual @c(render-template) method.
Render a Mustache template string to a string.
Write a string to a file (absolute path), creating it if necessary, and creating its parent directories as well.
missing-required-option
)) ¶Render a @cl:param(template) to a @cl:param(directory). The @cl:param(options) are a plist of option names to their supplied values.
progn
.
:most-specific-first
Signalled when a required option is not supplied.
simple-error
.
The name of the required option.
:option-name
This slot is read-only.
A yes or no option.
An option that gives the user a choice from a list.
A list of strings.
list
:choices
This slot is read-only.
An option to a template.
The name of the option, a keyword, e.g. @c(:project-name).
keyword
:name
This slot is read-only.
The human-readable option name, e.g. @c("Project Name").
string
:title
This slot is read-only.
The option’s documentation string.
string
:docstring
This slot is read-only.
Whether the option is required. False by default.
boolean
:requiredp
This slot is read-only.
A function used to process the value given to the option.
function
(function identity)
:processor
This slot is read-only.
The option’s default value.
:default
This slot is read-only.
An option that prompts the user for a value.
Represents a template.
The template’s human-readable name.
string
:name
This slot is read-only.
The template’s documentation string.
string
:docstring
This slot is read-only.
A list of template options.
list
:options
This slot is read-only.
multiple-choice-option
)) ¶A list of strings.
Jump to: | F G L M O P R S T V W |
---|
Jump to: | F G L M O P R S T V W |
---|
Jump to: | *
C D N O P R S T |
---|
Jump to: | *
C D N O P R S T |
---|
Jump to: | B C F M O P S T U |
---|
Jump to: | B C F M O P S T U |
---|