stylelint-webpack-plugin/dist/options.json

A Stylelint plugin for webpack

{
  "type": "object",
  "additionalProperties": true,
  "properties": {
    "context": {
      "description": "A string indicating the root of your files.",
      "type": "string"
    },
    "emitError": {
      "description": "The errors found will always be emitted, to disable set to `false`.",
      "type": "boolean"
    },
    "emitWarning": {
      "description": "The warnings found will always be emitted, to disable set to `false`.",
      "type": "boolean"
    },
    "exclude": {
      "description": "Specify the files and/or directories to exclude. Must be relative to `options.context`.",
      "anyOf": [{ "type": "string" }, { "type": "array" }]
    },
    "extensions": {
      "description": "Specify extensions that should be checked.",
      "anyOf": [{ "type": "string" }, { "type": "array" }]
    },
    "failOnError": {
      "description": "Will cause the module build to fail if there are any errors, to disable set to `false`.",
      "type": "boolean"
    },
    "failOnWarning": {
      "description": "Will cause the module build to fail if there are any warnings, if set to `true`.",
      "type": "boolean"
    },
    "files": {
      "description": "Specify directories, files, or globs. Must be relative to `options.context`. Directories are traversed recursively looking for files matching `options.extensions`. File and glob patterns ignore `options.extensions`.",
      "anyOf": [{ "type": "string" }, { "type": "array" }]
    },
    "formatter": {
      "description": "Specify the formatter that you would like to use to format your results.",
      "anyOf": [
        { "type": "string" },
        { "instanceof": "Function" },
        { "instanceof": "Promise" }
      ]
    },
    "lintDirtyModulesOnly": {
      "description": "Lint only changed files, skip lint on start.",
      "type": "boolean"
    },
    "quiet": {
      "description": "Will process and report errors only and ignore warnings, if set to `true`.",
      "type": "boolean"
    },
    "stylelintPath": {
      "description": "Path to `stylelint` instance that will be used for linting.",
      "type": "string"
    },
    "outputReport": {
      "description": "Write the output of the errors to a file, for example a `json` file for use for reporting.",
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "filePath": {
              "description": "The `filePath` is relative to the webpack config: `output.path`.",
              "anyOf": [{ "type": "string" }]
            },
            "formatter": {
              "description": "You can pass in a different formatter for the output file, if none is passed in the default/configured formatter will be used.",
              "anyOf": [{ "type": "string" }, { "instanceof": "Function" }]
            }
          }
        }
      ]
    },
    "threads": {
      "description": "Set to true for an auto-selected pool size based on number of cpus. Set to a number greater than 1 to set an explicit pool size. Set to false, 1, or less to disable and only run in main process.",
      "anyOf": [{ "type": "number" }, { "type": "boolean" }]
    }
  }
}