❤Network Performance Monitor
    Have ideas to improve npm?Join in the discussion! »

    eslint-plugin-json-schema-validator
    TypeScript icon, indicating that this package has built-in type declarations

    1.0.22 • Public • Published

    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

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

    📖 Documentation

    See documents.

    💿 Installation

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

    Requirements

    • ESLint v6.0.0 and above
    • Node.js v8.10.0 and above

    📖 Usage

    Configuration

    Use .eslintrc.* file to configure rules. See also: https://eslint.org/docs/user-guide/configuring.

    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:

    • plugin:json-schema-validator/base ... Configuration to enable correct JSON, YAML and TOML parsing.
    • plugin:json-schema-validator/recommended ... Above, plus rule to validate with JSON Schema.

    Running ESLint from the command line

    If you want to run eslint from the command line, make sure you include the .json, .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,.json5,.yaml,.yml,.toml src
    eslint "src/**/*.{js,json,json5,yaml,yml,toml}"

    💻 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, .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"
        ]
    }

    ✅ Rules

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

    Rules

    Rule ID Description Fixable RECOMMENDED
    json-schema-validator/no-invalid validate object with JSON Schema. ⭐

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

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

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

    👫 Related Packages

    🔒 License

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

    The JSON Schema included in this plugin release is copy from SchemaStore. Check here for licenses and details.

    Install

    npm i eslint-plugin-json-schema-validator

    DownloadsWeekly Downloads

    1,007

    Version

    1.0.22

    License

    MIT

    Unpacked Size

    4.08 MB

    Total Files

    312

    Last publish

    Collaborators

    • avatar