summaryrefslogtreecommitdiff
path: root/README.md
blob: a51c057b9ffa70ba59c081695c1f42bb66890446 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
# tomlcheck

[![Build Status](https://travis-ci.org/vmchale/tomlcheck.svg?branch=master)](https://travis-ci.org/vmchale/tomlcheck)

`tomlcheck` is a command-line wrapper around the `htoml` library which can be
used as a syntax checker for TOML.

You can find a vim plugin [here](https://github.com/vmchale/tomlcheck-vim).

## Installation

### Binaries

Head over to the [release page](https://github.com/vmchale/tomlcheck/releases) to see if your platform has
binaries. Simply put it somewhere on your path.

### Cabal

Install [GHC](https://www.haskell.org/ghc/download.html) along with 
[cabal](https://www.haskell.org/downloads#minimal), then

```bash
 $ cabal update
 $ cabal install tomlcheck
```

## Known Deficiencies

  * No Windows binaries
  * Slow on large files (>7000 lines)

## Cool Facts
  
  * It's really fast
  * It uses laziness to make checking schnell yet robust

```
-------------------------------------------------------------------------------
 Language            Files        Lines         Code     Comments       Blanks
-------------------------------------------------------------------------------
 Cabal                   1           58           53            1            4
 Haskell                 3           40           28            4            8
 Justfile                1           21           16            0            5
 Markdown                2           42           42            0            0
 TOML                    3           87           78            0            9
 YAML                    1            9            9            0            0
-------------------------------------------------------------------------------
 Total                  11          257          226            5           26
-------------------------------------------------------------------------------
```