https://github.com/mdgriffith/elm-markup-cli
https://github.com/mdgriffith/elm-markup-cli
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/mdgriffith/elm-markup-cli
- Owner: mdgriffith
- License: bsd-3-clause
- Created: 2018-10-24T19:26:08.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2022-12-09T04:45:06.000Z (over 2 years ago)
- Last Synced: 2025-03-24T06:51:51.898Z (4 months ago)
- Language: JavaScript
- Size: 87.9 KB
- Stars: 8
- Watchers: 1
- Forks: 3
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Elm Markup CLI
Check your elm-markup files (`*.emu`) for errors using any [elm-markup](https://package.elm-lang.org/packages/mdgriffith/elm-markup/latest/) documents you have defined in your elm code.
It requires `elm-markup` version 3.0 or later.
## Installation
```shell
npm install -g elm-markup
```
## Usage
```shell
# Find exposed `Mark.Document` and use them to parse .emu files.
# Print errors to the console by default.
elm-markup
# print version of Elm Markup CLI
elm-markup --version
# --report
# Change the report format.
# options
# console (default) - print in a human readable format.
# json - encode every error in json and log to stdout
elm-markup --report=json
```
## Previewing Documents
This packge doesn't handle previewing what a document would look like because that's probably better handled by your elm application and a tool like [`elm-live`](https://github.com/wking-io/elm-live)