https://github.com/tailrecursion/boot-heredoc
Parse files and replace string blocks with a Clojure string.
https://github.com/tailrecursion/boot-heredoc
Last synced: 4 months ago
JSON representation
Parse files and replace string blocks with a Clojure string.
- Host: GitHub
- URL: https://github.com/tailrecursion/boot-heredoc
- Owner: tailrecursion
- Created: 2015-09-13T21:19:03.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2015-09-27T20:38:24.000Z (almost 11 years ago)
- Last Synced: 2025-07-06T14:49:33.057Z (about 1 year ago)
- Language: Clojure
- Size: 152 KB
- Stars: 5
- Watchers: 16
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# boot-heredoc
[](dependency)
```clojure
[tailrecursion/boot-heredoc "0.1.1"] ;; latest release
```
[](/dependency)
[Boot] task for adding multiline strings literals to Clojure
## Example
```clojure
(def lorem-ipsum
;;{{
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nullam eget
eleifend metus. Curabitur vitae vestibulum ligula, vel pulvinar nisl. Sed
cursus ipsum id enim rutrum iaculis. Mauris non ullamcorper sem. In porttitor
mi ut massa molestie, eu pharetra turpis aliquet. Ut fermentum varius tortor,
sit amet maximus mi. Praesent et orci orci. Nullam auctor nisi eget sagittis
pharetra. Sed ullamcorper mauris sit amet metus pulvinar, et pretium elit
tincidunt.
;;}}
)
;; becomes...
(def lorem-ipsum "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nullam eget\neleifend metus. Curabitur vitae vestibulum ligula, vel pulvinar nisl. Sed\ncursus ipsum id enim rutrum iaculis. Mauris non ullamcorper sem. In porttitor\nmi ut massa molestie, eu pharetra turpis aliquet. Ut fermentum varius tortor,\nsit amet maximus mi. Praesent et orci orci. Nullam auctor nisi eget sagittis\npharetra. Sed ullamcorper mauris sit amet metus pulvinar, et pretium elit\ntincidunt.")
```
## Usage
Add `boot-heredoc` to your `build.boot` dependencies and `require` the namespace.
> **Note:** the boot-heredoc dependency is only needed at when compiling
> source files. So you should add boot-heredoc with the _test_ scope.
```clj
(merge-env!
:dependencies '[[tailrecursion/boot-heredoc "X.Y.Z" :scope "test"]])
(require '[boot.heredoc :refer [heredoc]])
```
By default the multiline string literals starts with `;;{{` and ends with `;;}}` and
it replaces those blocks on `.hl` files. Those are customizable using options.
You can see the options available on the command line:
```bash
boot heredoc -h
```
or in the REPL:
```clj
boot.user=> (doc heredoc)
```
## License
Copyright © 2015 Marcelo Nomoto
Distributed under the Eclipse Public License either version 1.0 or (at
your option) any later version.
[Boot]: https://github.com/boot-clj/boot