Home

Awesome

Introduction

eslint-plugin-json-schema-validator is ESLint plugin that validates data using JSON Schema Validator.

NPM license NPM version NPM downloads NPM downloads NPM downloads NPM downloads NPM downloads Build Status

:name_badge: Features

This ESLint plugin validates JSON, JSONC, JSON5, YAML, TOML, JavaScript and Vue Custom Blocks with JSON Schema.

You can check on the Online DEMO that uses JavaScript, JSON, YAML and TOML.

<!--DOCS_IGNORE_START-->

:book: Documentation

See documents.

:cd: Installation

npm install --save-dev eslint eslint-plugin-jsonc eslint-plugin-json-schema-validator

Requirements

<!--DOCS_IGNORE_END-->

:book: Usage

<!--USAGE_SECTION_START--> <!--USAGE_GUIDE_START-->

Configuration

New Config (eslint.config.js)

Use eslint.config.js file to configure rules. See also: https://eslint.org/docs/latest/use/configure/configuration-files-new.

Example eslint.config.js:

import eslintPluginJsonSchemaValidator from "eslint-plugin-json-schema-validator";
export default [
  // add more generic rule sets here, such as:
  // js.configs.recommended,
  ...eslintPluginJsonSchemaValidator.configs["flat/recommended"],
  {
    rules: {
      // override/add rules settings here, such as:
      // 'json-schema-validator/no-invalid': 'warn'
    },
  },
];

This plugin provides configs:

Legacy Config (.eslintrc)

Use .eslintrc.* file to configure rules. See also: https://eslint.org/docs/latest/use/configure/.

Example .eslintrc.js:

module.exports = {
  extends: [
    // add more generic rulesets here, such as:
    // 'eslint:recommended',
    "plugin:json-schema-validator/recommended",
  ],
  rules: {
    // override/add rules settings here, such as:
    // 'json-schema-validator/no-invalid': 'error'
  },
};

This plugin provides configs:

Running ESLint from the command line

If you want to run eslint from the command line, make sure you include the .json, .jsonc, .json5, .yaml, .yml and .toml extension using the --ext option or a glob pattern, because ESLint targets only .js files by default.

Examples:

eslint --ext .js,.json,.jsonc,.json5,.yaml,.yml,.toml src
eslint "src/**/*.{js,json,jsonc,json5,yaml,yml,toml}"

:computer: Editor Integrations

Visual Studio Code

Use the dbaeumer.vscode-eslint extension that Microsoft provides officially.

You have to configure the eslint.validate option of the extension to check .json, .jsonc, .json5, .yaml, .yml and .toml files, because the extension targets only *.js or *.jsx files by default.

Example .vscode/settings.json:

{
  "eslint.validate": [
    "javascript",
    "javascriptreact",
    "json",
    "jsonc",
    "json5",
    "yaml",
    "toml"
  ]
}
<!--USAGE_GUIDE_END--> <!--USAGE_SECTION_END-->

:white_check_mark: Rules

<!--RULES_SECTION_START--> <!-- The `--fix` option on the [command line](https://eslint.org/docs/user-guide/command-line-interface#fixing-problems) automatically fixes problems reported by rules which have a wrench :wrench: below. -->

The rules with the following star :star: are included in the configs.

<!--RULES_TABLE_START-->

Rules

Rule IDDescriptionFixableRECOMMENDED
json-schema-validator/no-invalidvalidate object with JSON Schema.:star:
<!--RULES_TABLE_END--> <!--RULES_SECTION_END--> <!--DOCS_IGNORE_START--> <!--ADVANCED_USAGE_GUIDE_START-->

:zap: Advanced Usage

Settings

Use .eslintrc.* file to configure settings. See also: https://eslint.org/docs/user-guide/configuring/configuration-files#adding-shared-settings.

Example .eslintrc.js:

module.exports = {
  settings: {
    "json-schema-validator": {
      http: {
        getModulePath: "",
        requestOptions: {},
      },
    },
  },
};

Example of http

Example of using the request module for HTTP requests.

./path/to/request-get.js:

const request = require("request");

/**
 * GET Method using request module.
 */
module.exports = function get(url, options) {
  return new Promise((resolve, reject) => {
    request.get(url, options, (error, _res, body) => {
      if (error) {
        reject(error);
        return;
      }
      resolve(body);
    });
  });
};

.eslintrc.js:

<!-- eslint-skip -->
module.exports = {
  settings: {
    "json-schema-validator": {
      http: {
        getModulePath: require.resolve("./path/to/request-get.js"),
        requestOptions: {
          // Example of proxy settings.
          proxy: "http://my.proxy.com:8080/",
        },
      },
    },
  },
};
<!--ADVANCED_USAGE_GUIDE_END-->

:beers: Contributing

Welcome contributing!

Please use GitHub's Issues/PRs.

Development Tools

Working With Rules

This plugin uses jsonc-eslint-parser, yaml-eslint-parser and toml-eslint-parser for the parser.

<!--DOCS_IGNORE_END-->

:couple: Related Packages

:lock: License

See the LICENSE file for license rights and limitations (MIT).