https://github.com/chrisbarrett/apidoc-checker

A command-line tool to verify apidoc specifications
https://github.com/chrisbarrett/apidoc-checker

apidoc flycheck haskell

Last synced: 1 day ago
JSON representation

A command-line tool to verify apidoc specifications

• Host: GitHub
• URL: https://github.com/chrisbarrett/apidoc-checker
• Owner: chrisbarrett
• License: bsd-3-clause
• Created: 2016-04-10T10:36:41.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2016-11-22T07:23:47.000Z (about 8 years ago)
• Last Synced: 2024-12-11T06:31:13.551Z (about 2 months ago)
• Topics: apidoc, flycheck, haskell
• Language: Haskell
• Homepage:
• Size: 293 KB
• Stars: 4
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# apidoc-checker

![Tooltip displayed over syntax error in Emacs](./assets/screenshot.png)

A tool to validate apidoc specifications. Provides pretty error messages for

command-line use, and includes a Flycheck checker for Emacs.

![Dog at a computer with an overlay labelled "excellent"](./assets/dog.png)

## Usage

```

apidoc-checker - apidoc spec validator

Usage: apidoc-checker FILE [--plain]

  Validates an apidoc JSON specification

Available options:

  -h,--help                Show this help text

  FILE                     Path to the apidoc spec to validate

  --plain                  Remove ANSI colour codes from output.

```

## Installation

1. Install [stack][]

2. Clone this repository and install the tool with stack

   ```sh

   git clone https://github.com/chrisbarrett/apidoc-checker.git

   cd apidoc-checker

   stack install

   ```

### Flycheck Integration

1. Configure Emacs to use [MELPA][] as one of your package sources. This is

   already done for you in Spacemacs.

2. Run `M-x package-install-file apidoc-checker/elisp/apidoc-checker.el` to

   install the package and its dependencies.

When you visit api.json files you should now automatically enter `apidoc-mode`

and get those *sweet sweet* error squiggles.

## Contributions

PRs welcome.

## License

See [LICENSE][]. Copyright (c) 2016 Chris Barrett.

[stack]: http://docs.haskellstack.org/en/stable/README/

[LICENSE]: ./LICENSE

[MELPA]: http://melpa.org/#/getting-started