liquid/README.md

# Go Liquid Template Parser

`goliquid` is a very early-stage Go implementation of the [Shopify Liquid template language](https://shopify.github.io/liquid), for use in [Gojekyll](https://github.com/osteele/gojekyll).

## Status
[![Build Status](https://travis-ci.org/osteele/liquid.svg?branch=master)](https://travis-ci.org/osteele/liquid)
[![Go Report Card](https://goreportcard.com/badge/github.com/osteele/liquid)](https://goreportcard.com/report/github.com/osteele/liquid)

- [ ] Basics
  - [x] Literals
    - [ ] String Escapes
  - [x] Variables
  - [ ] Operators
  - [x] Arrays
  - [ ] Whitespace Control
- [ ] Tags
  - [x] Comment
  - [ ] Control Flow
    - [x] if/else/elsif
    - [x] unless
    - [ ] case/when
  - [ ] Iteration
        - [x] for
            - [ ] limit
            - [ ] offset
            - [ ] range
            - [x] reversed
        - [ ] break, continue
        - [ ] loop variables
        - [ ] tablerow
        - [ ] cycle
  - [ ] Raw
  - [ ] Variable
    - [x] Assign
    - [ ] Capture
- [ ] Filters

## Install

`go get -u github.com/osteele/goliquid`

## Contribute

### Setup

```bash
make setup
```

Install Ragel. On macOS: `brew install ragel`.

### Workflow

```bash
go generate ./...
go test ./...
```

Test just the scanner:

```bash
cd expressions
ragel -Z scanner.rl && go test
```

## Attribution

Michael Hamrah's [Lexing with Ragel and Parsing with Yacc using Go](https://medium.com/@mhamrah/lexing-with-ragel-and-parsing-with-yacc-using-go-81e50475f88f) was essential to understanding `go yacc`.

## License

MIT License
Initial 2017-06-25 17:23:20 +02:00			`# Go Liquid Template Parser`

Improve docs 2017-06-26 16:36:53 +02:00			`goliquid` is a very early-stage Go implementation of the [Shopify Liquid template language](https://shopify.github.io/liquid), for use in [Gojekyll](https://github.com/osteele/gojekyll).
Initial 2017-06-25 17:23:20 +02:00
			`## Status`
Add status badges to the README 2017-06-26 16:16:25 +02:00			`[![Build Status](https://travis-ci.org/osteele/liquid.svg?branch=master)](https://travis-ci.org/osteele/liquid)`
			`[![Go Report Card](https://goreportcard.com/badge/github.com/osteele/liquid)](https://goreportcard.com/report/github.com/osteele/liquid)`
Initial 2017-06-25 17:23:20 +02:00
			`- [ ] Basics`
Implement variable assignment 2017-06-26 21:36:05 +02:00			`- [x] Literals`
			`- [ ] String Escapes`
a.b syntax 2017-06-26 04:59:33 +02:00			`- [x] Variables`
Initial 2017-06-25 17:23:20 +02:00			`- [ ] Operators`
Implement variable assignment 2017-06-26 21:36:05 +02:00			`- [x] Arrays`
Initial 2017-06-25 17:23:20 +02:00			`- [ ] Whitespace Control`
			`- [ ] Tags`
Implement comment tag 2017-06-27 19:47:14 +02:00			`- [x] Comment`
Initial 2017-06-25 17:23:20 +02:00			`- [ ] Control Flow`
Implement {% unless %} 2017-06-26 02:11:29 +02:00			`- [x] if/else/elsif`
			`- [x] unless`
			`- [ ] case/when`
Initial 2017-06-25 17:23:20 +02:00			`- [ ] Iteration`
Implement loop tag 2017-06-27 19:18:01 +02:00			`- [x] for`
Implement loop reversed 2017-06-27 21:10:44 +02:00			`- [ ] limit`
			`- [ ] offset`
			`- [ ] range`
			`- [x] reversed`
Initial 2017-06-25 17:23:20 +02:00			`- [ ] break, continue`
			`- [ ] loop variables`
			`- [ ] tablerow`
			`- [ ] cycle`
			`- [ ] Raw`
			`- [ ] Variable`
Implement variable assignment 2017-06-26 21:36:05 +02:00			`- [x] Assign`
Initial 2017-06-25 17:23:20 +02:00			`- [ ] Capture`
			`- [ ] Filters`

			`## Install`

			`go get -u github.com/osteele/goliquid`

Implement expression scanner 2017-06-25 18:36:28 +02:00			`## Contribute`

			`### Setup`
Initial 2017-06-25 17:23:20 +02:00
			```bash
Add Makefile 2017-06-27 19:25:07 +02:00			`make setup`
Initial 2017-06-25 17:23:20 +02:00			```

Implement expression scanner 2017-06-25 18:36:28 +02:00			Install Ragel. On macOS: `brew install ragel`.

			`### Workflow`

Initial 2017-06-25 17:23:20 +02:00			```bash
Implement variable assignment 2017-06-26 21:36:05 +02:00			`go generate ./...`
			`go test ./...`
Initial 2017-06-25 17:23:20 +02:00			```
Implement expression scanner 2017-06-25 18:36:28 +02:00
			`Test just the scanner:`

			```bash
Implement variable assignment 2017-06-26 21:36:05 +02:00			`cd expressions`
			`ragel -Z scanner.rl && go test`
Yacc expression parsing 2017-06-25 22:21:31 +02:00			```

			`## Attribution`

			Michael Hamrah's [Lexing with Ragel and Parsing with Yacc using Go](https://medium.com/@mhamrah/lexing-with-ragel-and-parsing-with-yacc-using-go-81e50475f88f) was essential to understanding `go yacc`.
Expression evaluator tests; fix revealed bugs 2017-06-26 14:23:50 +02:00
			`## License`

			`MIT License`