A sample catalog with rewrite templates. Feel free to fork and modify with your own!

Layout

The catalogue folder contains a directory tree of templates. Each leaf folder is one rewrite pattern, containing the following files.

• match - contains the match pattern
• rewrite - the rewrite pattern
• rule - optional file with a where ... rule

When a directory tree is specified with comby -templates catalogue, the catalogue directory tree is traversed fully and every rewrite pattern is run against the file in the leaf folders.

Note that when running the -templates option without any other flags, all files in the directory will be run against the rewrite patterns. In general, use -f file-pattern.extension and/or -d src to run against a particular filepath pattern or directory, respectively. However, you don't need to worry about doing that for this catalog, since the generator script takes care of that for you.

The top level language under the catalogue directory defines the language label in the rendered site. Use the format in the newline-separated DOC.md files (example) to produce output entries as in the rendered catalog website.

Generating the web site

Run python generate.py (uses Python 2). This creates a catalogue.json. The JSON file is refenced in index.html to generate the site.

Examples

See the rendered catalog for this repository.

See the comby tool or docs for using it!

Example creating new template

Create new directory catalogue/echo with match and rewrite patterns.

mkdir catalogue/echo
# add match and rewrite patterns
echo '(:[emoji] hi)' > catalogue/echo/match
echo 'bye :[emoji]' > catalogue/echo/rewrite

Test is with comby.

$ comby -templates catalogue/echo -stdin -matcher .lisp <<< '(👋 hi)'
------ /dev/null
++++++ /dev/null
@|-1,1 +1,1 ============================================================
-|(👋 hi)
+|bye 👋

We explicitly specify .lisp matcher, because with -stdin input comby is unable to detect matcher from file extension.

Running the same command with docker will be slightly more verbose.

docker run --rm -i -a stdin -a stdout -a stderr -v "$(pwd)"/catalogue:/opt/catalogue comby/comby -templates /opt/catalogue/echo -stdin -matcher .lisp <<< '(👋 hi)'