options.json 3.1 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980
  1. {
  2. "type": "object",
  3. "additionalProperties": true,
  4. "properties": {
  5. "context": {
  6. "description": "A string indicating the root of your files.",
  7. "type": "string"
  8. },
  9. "emitError": {
  10. "description": "The errors found will always be emitted, to disable set to `false`.",
  11. "type": "boolean"
  12. },
  13. "emitWarning": {
  14. "description": "The warnings found will always be emitted, to disable set to `false`.",
  15. "type": "boolean"
  16. },
  17. "exclude": {
  18. "description": "Specify the files and/or directories to exclude. Must be relative to `options.context`.",
  19. "anyOf": [{ "type": "string" }, { "type": "array" }]
  20. },
  21. "extensions": {
  22. "description": "Specify extensions that should be checked.",
  23. "anyOf": [{ "type": "string" }, { "type": "array" }]
  24. },
  25. "failOnError": {
  26. "description": "Will cause the module build to fail if there are any errors, to disable set to `false`.",
  27. "type": "boolean"
  28. },
  29. "failOnWarning": {
  30. "description": "Will cause the module build to fail if there are any warnings, if set to `true`.",
  31. "type": "boolean"
  32. },
  33. "files": {
  34. "description": "Specify directories, files, or globs. Must be relative to `options.context`. Directories are traveresed recursively looking for files matching `options.extensions`. File and glob patterns ignore `options.extensions`.",
  35. "anyOf": [{ "type": "string" }, { "type": "array" }]
  36. },
  37. "formatter": {
  38. "description": "Specify the formatter that you would like to use to format your results.",
  39. "anyOf": [{ "type": "string" }, { "instanceof": "Function" }]
  40. },
  41. "lintDirtyModulesOnly": {
  42. "description": "Lint only changed files, skip lint on start.",
  43. "type": "boolean"
  44. },
  45. "quiet": {
  46. "description": "Will process and report errors only and ignore warnings, if set to `true`.",
  47. "type": "boolean"
  48. },
  49. "stylelintPath": {
  50. "description": "Path to `stylelint` instance that will be used for linting.",
  51. "type": "string"
  52. },
  53. "outputReport": {
  54. "description": "Write the output of the errors to a file, for example a `json` file for use for reporting.",
  55. "anyOf": [
  56. {
  57. "type": "boolean"
  58. },
  59. {
  60. "type": "object",
  61. "additionalProperties": false,
  62. "properties": {
  63. "filePath": {
  64. "description": "The `filePath` is relative to the webpack config: `output.path`.",
  65. "anyOf": [{ "type": "string" }]
  66. },
  67. "formatter": {
  68. "description": "You can pass in a different formatter for the output file, if none is passed in the default/configured formatter will be used.",
  69. "anyOf": [{ "type": "string" }, { "instanceof": "Function" }]
  70. }
  71. }
  72. }
  73. ]
  74. },
  75. "threads": {
  76. "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.",
  77. "anyOf": [{ "type": "number" }, { "type": "boolean" }]
  78. }
  79. }
  80. }