Introduction

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

: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.

:book: Documentation

See documents.

:cd: Installation

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

Requirements

• ESLint v9.38.0 and above
• Node.js v20.19.0 or higher (in the 20.x line), v22.13.0 or higher (in the 22.x line), or v24.0.0 and above

:book: Usage

Configuration

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.recommended,
  {
    rules: {
      // override/add rules settings here, such as:
      // 'json-schema-validator/no-invalid': 'warn'
    },
  },
];

This plugin provides configs:

• *.configs.base ... Configuration to enable correct JSON, YAML and TOML parsing.
• *.configs.recommended ... Above, plus rule to validate with JSON Schema.

See the rule list to get the rules that this plugin provides.

For backward compatibility, the flat/ prefix can still be used:

• *.configs["flat/base"] is an alias for *.configs.base
• *.configs["flat/recommended"] is an alias for *.configs.recommended

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"
  ]
}

:white_check_mark: Rules

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

Rules

: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: {},
      },
      cache: {
        path: "",
        ttl: "1d",
      },
    },
  },
};

• http ... Settings to resolve schema URLs.
  • getModulePath ... Module path to GET the URL. The default implementation is ./src/utils/http-client/get-modules/http.ts.
  • requestOptions ... Options used in the module.
• cache ... Settings for the schemastore cache used when resolving remote schema URLs.
  • path ... Directory to store cached schemas. A relative path is resolved against the current working directory; an absolute path is used as-is. When unset, the default location alongside the installed package is used.
  • ttl ... How long a cached schema is used before it is refetched. A number is milliseconds; a string is a duration such as "30m", "12h", "1d", or "2w". Defaults to 1 day. Use 0 to always refetch.

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:

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/",
        },
      },
    },
  },
};

Example of cache

Persist the cache to a directory that survives between runs (for example a mounted Docker volume), and refetch weekly:

module.exports = {
  settings: {
    "json-schema-validator": {
      cache: {
        path: "/cache/eslint-json-schema-validator",
        ttl: "1w",
      },
    },
  },
};

YAML merge keys

When validating YAML, this plugin resolves merge keys (<<) before checking the data against the schema, so a mapping that merges in an anchored mapping is validated as the final merged object rather than reporting << itself as an unexpected property.

Merge keys are a YAML 1.1 feature, so they are only resolved for documents parsed as YAML 1.1. yaml-eslint-parser parses documents as YAML 1.2 by default, where << is an ordinary key and is left as-is. A document is treated as YAML 1.1 when it begins with a %YAML 1.1 directive or is parsed with the defaultYAMLVersion parser option set to "1.1".

To resolve merge keys across files without adding a directive to each one, set defaultYAMLVersion for the relevant files in your configuration:

import eslintPluginJsonSchemaValidator from "eslint-plugin-json-schema-validator";
export default [
  ...eslintPluginJsonSchemaValidator.configs.recommended,
  {
    files: ["**/.gitlab-ci.yml", "**/config/**/*.yaml"],
    languageOptions: {
      parserOptions: {
        defaultYAMLVersion: "1.1",
      },
    },
  },
];

This parses the matched files as YAML 1.1 in full, so the YAML 1.1 scalar rules apply as well (for example, yes and on are parsed as booleans).

A schema violation on a property introduced by a merge is reported on the << line — merged properties have no location of their own in the target mapping — with a (from merge key) hint appended to the message.

:beers: Contributing

Welcome contributing!

Please use GitHub's Issues/PRs.

Development Tools

• npm test runs tests and measures coverage.
• npm run update runs in order to update readme and recommended configuration.

Working With Rules

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

:couple: Related Packages

• eslint-plugin-jsonc ... ESLint plugin for JSON, JSON with comments (JSONC) and JSON5.
• eslint-plugin-yml ... ESLint plugin for YAML.
• eslint-plugin-toml ... ESLint plugin for TOML.
• eslint-plugin-vue ... Official ESLint plugin for Vue.js.
• jsonc-eslint-parser ... JSON, JSONC and JSON5 parser for use with ESLint plugins.
• yaml-eslint-parser ... YAML parser for use with ESLint plugins.
• toml-eslint-parser ... TOML parser for use with ESLint plugins.
• vue-eslint-parser ... The ESLint custom parser for .vue files.

:lock: License

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