Giter VIP home page Giter VIP logo

apidoc-checker's Introduction

apidoc-checker

Tooltip displayed over syntax error in Emacs

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"

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

    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.

apidoc-checker's People

Stargazers

 avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.