About

Kapow is a template processor that provides the following directives to support injecting file contents, command output, current date/time, etc in generated files.

Block directives

• Block directives must be placed at the beginning of a line.
• Long commands can be backslash-wrapped.

Span directives

• Span directives must be placed inside a code span and may appear zero or more times in any line.
• Disable processing a span directive by escaping ! with a backslash: \!.

Usage

$ kapow -V
kapow 2.4.0

$ kapow -h
KAPOW!

Usage: kapow [OPTIONS] [INPUT_FILES]...

Arguments:
  [INPUT_FILES]...  Input file(s) [default: -]

Options:
  -r, --readme   Print readme
  -h, --help     Print help
  -V, --version  Print version

• The -r option uses bat for paging and syntax highlighting if you have it installed (optional).

Errors

Example

See the readme task in Makefile.toml:

• Generates t/VERSION.md from t/VERSION.t.md
  • !run:../target/release/kapow -V
• Generates t/USAGE.md from t/USAGE.t.md
  • !run:../target/release/kapow -h
• Generates README.md from t/README.md
  • !inc:VERSION.md
  • !inc:USAGE.md
  • `!now` (all variants)

Changelog

• 1.0.0 (2023-02-21): Initial release
• 1.0.1 (2023-02-21): Update dependencies
• 2.0.0 (2023-02-22): Include stderr in !run: output; enable backslash-wrapping long commands; include whitespace in included files; process path of included files relative to the containing file instead of the current directory; input and included file processed more efficiently via BufReader instead of read_to_string; improved error handling
• 2.1.0 (2023-02-24): Use bat -pl md as readme pager if have it installed; update dependencies
• 2.1.1 (2023-02-24): Fix readme
• 2.1.2 (2023-02-24): Fix readme
• 2.2.0 (2023-03-10): Change to the directory of each input file in order to process included file paths and commands to be run relative to the input file path; run commands via the shell to enable more advanced commands and simplify usage; update dependencies
• 2.2.1 (2023-03-10): Remove shlex dependency
• 2.2.2 (2023-03-10): Fix readme; error if no input file(s) provided
• 2.2.3 (2023-03-10): Fix confict with readme option
• 2.2.4 (2023-03-10): Fix readme
• 2.3.0 (2023-03-11): Add !today span directive; improved exit macro; change directory function; where clauses; fix watch task; fix readme
• 2.3.1 (2023-03-11): Fix readme
• 2.4.0 (2023-03-13): Enable processing from stdin if no input files provided or input file is -; update dependencies

Development

cargo install bat cargo-edit cargo-make cargo-outdated dtg kapow \
miniserve