@linterhub/schema

JSON Schema definitions for linterhub

Table of Contents

• Background
• Installation
• Usage
• Contribute
• License

Background

There are a lot of linters of different types, distributed in different ways and each may have specific runtime dependencies. This repository contains a proposal of unified linter definition, distribution and configuration formats (JSON Schema & JSON files). Under the hood, the main idea is pretty similar to meta-package managers approach.

More details in doс or at the catalog page.

Installation

NPM

Requirements:

• Node.js 8.3+
• npm 5.3+

npm install @linterhub/schema --save-dev

GitHub

All schemas and the source code are available for download at GitHub Releases and GitHub pages as well.

Usage

JavaScript

Get Schema for linter definition and output it to console:

const schema = require('@linterhub/schema');
console.log(schema.linter);

JSON

Describe the linter capabilities and provide some extra info: how to install it and how to execute it - Step by Step guide.

Contribute

You may contribute in several ways like requesting new features, adding tests, fixing bugs, improving documentation or examples. Please check our contributing guidelines.

License

MIT