https://github.com/comby-tools/sample-catalog
A sample catalog with rewrite templates. Feel free to fork and modify with your own!
https://github.com/comby-tools/sample-catalog
Last synced: 3 days ago
JSON representation
A sample catalog with rewrite templates. Feel free to fork and modify with your own!
- Host: GitHub
- URL: https://github.com/comby-tools/sample-catalog
- Owner: comby-tools
- License: apache-2.0
- Created: 2019-06-23T18:17:46.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2020-09-22T14:49:59.000Z (about 5 years ago)
- Last Synced: 2025-05-06T13:43:56.957Z (5 months ago)
- Language: JavaScript
- Homepage: https://catalog.comby.dev
- Size: 106 KB
- Stars: 6
- Watchers: 3
- Forks: 4
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
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](https://raw.githubusercontent.com/comby-tools/sample-catalog/master/catalogue/Dart/dart_style/prefer-is-empty/DOC.md)) to produce output entries as in the [rendered catalog website](https://catalog.comby.dev).
## 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](https://catalog.comby.dev/) for this repository.
See the [comby](https://github.com/comby-tools/comby) tool or [docs](https://comby.dev/) 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)'
```