{ "title": "JSON schema for the Grunt Watch task", "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "definitions": { "target": { "required": [ "files" ], "properties": { "files": { "type": "array", "description": "One or more files to watch.", "items": { "type": "string" } }, "tasks": { "type": "array", "description": "One or more tasks to run.", "items": { "type": "string" } }, "options": { "$ref": "#/definitions/options" } } }, "optionsWithEvents": { "oneOf": [ { "properties": { "events": { "description": "Specify the type watch event that trigger the specified task.", "type": "array", "items": { "$ref": "#/definitions/eventType" } } } }, { "properties": { "events": { "$ref": "#/definitions/eventType" } } } ] }, "eventType": { "type": "string", "description": "Specify the type watch event that trigger the specified task.", "default": "all", "enum": [ "all", "changed", "added", "deleted" ] }, "options": { "type": "object", "description": "One or more files to watch.", "allOf": [ { "$ref": "#/definitions/optionsWithEvents" } ], "properties": { "spawn": { "type": "boolean", "description": "Whether to spawn task runs in a child process.", "default": true }, "interrupt": { "type": "boolean", "description": "As files are modified this watch task will spawn tasks in child processes.", "default": false }, "debounceDelay": { "type": "integer", "description": "How long to wait before emitting events in succession for the same filepath and status. For example if your Gruntfile.js file was changed, a 'changed' event will only fire again after the given milliseconds.", "default": 500 }, "interval": { "type": "integer", "description": "The interval is passed to 'fs.watchFile'. Since 'interval' is only used by 'fs.watchFile' and this watcher also uses 'fs.watch'; it is recommended to ignore this option.", "default": 100 }, "reload": { "type": "boolean", "description": "By default, if Gruntfile.js is being watched, then changes to it will trigger the watch task to restart, and reload the Gruntfile.js changes. When reload is set to true, changes to any of the watched files will trigger the watch task to restart. This is especially useful if your Gruntfile.js is dependent on other files.", "default": false }, "forever": { "type": "boolean", "description": "This is only a task level option and cannot be configured per target. By default the watch task will duck punch grunt.fatal and grunt.warn to try and prevent them from exiting the watch process. If you don't want grunt.fatal and grunt.warn to be overridden set the forever option to false.", "default": true }, "atBegin": { "type": "boolean", "description": "This option will trigger the run of each specified task at startup of the watcher.", "default": false }, "livereload": { "type": [ "boolean", "number" ], "description": "If enabled a live reload server will be started with the watch task per target. Then after the indicated tasks have run, the live reload server will be triggered with the modified files.", "default": false }, "cwd": { "type": [ "string", "object" ], "description": "Ability to set the current working directory." }, "livereloadOnError": { "type": "boolean", "description": "Option to prevent the livereload if the executed tasks encountered an error. If set to false , the livereload will only be triggered if all tasks completed successfully.", "default": true } } } }, "properties": { "options": { "$ref": "#/definitions/options" } }, "additionalProperties": { "$ref": "#/definitions/target" } }