https://github.com/pbrisbin/ex-lint

Example Linter
https://github.com/pbrisbin/ex-lint

Last synced: about 2 months ago
JSON representation

Example Linter

• Host: GitHub
• URL: https://github.com/pbrisbin/ex-lint
• Owner: pbrisbin
• License: mit
• Created: 2015-01-24T23:24:18.000Z (almost 10 years ago)
• Default Branch: master
• Last Pushed: 2015-01-24T23:36:44.000Z (almost 10 years ago)
• Last Synced: 2024-10-09T09:45:11.593Z (3 months ago)
• Language: Haskell
• Homepage:
• Size: 141 KB
• Stars: 2
• Watchers: 4
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Example Linter

Check the code examples in your markdown.

## Installation

```

% cabal install ex-lint

```

*Note: not yet on Hackage, install from source for now*

## Usage

Format examples in your markdown like [this][ex].

[ex]: https://github.com/pbrisbin/ex-lint/blob/master/test/example.md

Run the markdown file with the linter to see any errors:

```

% ex-lint test/example.md

Mismatch in example

  Expression: 2 + 2

  Expected:   5

  Actual:     4

```

If no files are passed, markdown is read from `stdin`.

## TODO

- Exit non-zero if mismatches present

- Hide `stderr` from check command

- Add `CompileError` to `CheckResult`, ignore those

- Output filename on mismatches

- Output line number on mismatches (difficult)