gulp-chef/lib/schema/glob.json

Cascading configurable recipes for gulp 4.0. An elegant, intuitive way to reuse gulp tasks.

{
	"type": "glob",
	"properties": {
		"globs": {
			"description": "Glob or array of globs to read.",
			"type": "array",
			"items": {
				"type": "string"
			},
			"alias": ["glob"]
		},
		"options": {
			"description": "Options to pass to node-glob through glob-stream.",
			"properties": {
				"allowEmpty": {
					"description": "If true, won't emit an error when a glob pointing at a single file fails to match.",
					"type": "boolean",
					"default": false
				},
				"base": {
					"description": "Used for relative pathing. Typically where a glob starts.",
					"type": "string"
				},
				"buffer": {
					"description": "Setting this to false will return file.contents as a stream and not buffer files. This is useful when working with large files.",
					"type": "boolean",
					"default": true
				},
				"cache": {
					"description": "Pass in a previously generated cache object to save some fs calls.",
					"type": "object"
				},
				"cwd": {
					"description": "cwd for the input folder, only has an effect if provided input folder is relative. Default is process.cwd().",
					"type": "string"
				},
				"cwdbase": {
					"description": "Setting this to true is the same as saying opt.base = opt.cwd.",
					"type": "boolean",
					"default": false
				},
				"debug": {
					"description": "Set to enable debug logging in minimatch and glob.",
					"type": "boolean",
					"default": false
				},
				"dot": {
					"description": "Setting this to true to include .dot files in normal matches and globstar matches.",
					"type": "boolean",
					"default": false
				},
				"follow": {
					"description": "Follow symlinked directories when expanding ** patterns. Note that this can result in a lot of duplicate references in the presence of cyclic links.",
					"type": "boolean",
					"default": false
				},
				"ignore": {
					"description": "Add a pattern or an array of glob patterns to exclude matches. Note: ignore patterns are always in dot:true mode, regardless of any other settings.",
					"type": ["string", "array"]
				},
				"mark": {
					"description": "Add a / character to directory matches. Note that this requires additional stat calls.",
					"type": "boolean",
					"default": false
				},
				"matchBase": {
					"description": "Perform a basename-only match if the pattern does not contain any slash characters. That is, *.js would be treated as equivalent to **/*.js, matching all js files in all directories.",
					"type": "boolean",
					"default": false
				},
				"nobrace": {
					"description": "Do not expand {a,b} and {1..3} brace sets.",
					"type": "boolean",
					"default": false
				},
				"nocase": {
					"description": "Perform a case-insensitive match. Note: on case-insensitive filesystems, non-magic patterns will match by default, since stat and readdir will not raise errors.",
					"type": "boolean",
					"default": false
				},
				"nodir": {
					"description": "Do not match directories, only files. (Note: to match only directories, simply put a / at the end of the pattern.)",
					"type": "boolean",
					"default": false
				},
				"noext": {
					"description": "Do not match +(a|b) \"extglob\" patterns.",
					"type": "boolean",
					"default": false
				},
				"noglobstar": {
					"description": "Do not match ** against multiple filenames. (Ie, treat it as a normal * instead.)",
					"type": "boolean",
					"default": false
				},
				"nomount": {
					"description": "By default, a pattern starting with a forward-slash will be \"mounted\" onto the root setting, so that a valid filesystem path is returned. Set this flag to disable that behavior.",
					"type": "boolean",
					"default": false
				},
				"nonull": {
					"description": "Set to never return an empty set, instead returning a set containing the pattern itself. This is the default in glob(3).",
					"type": "boolean",
					"default": false
				},
				"nosort": {
					"description": "Don't sort the results.",
					"type": "boolean",
					"default": false
				},
				"nounique": {
					"description": "In some cases, brace-expanded patterns can result in the same file showing up multiple times in the result set. By default, this implementation prevents duplicates in the result set. Set this flag to disable that behavior.",
					"type": "boolean",
					"default": false
				},
				"passthrough": {
					"description": "If true, it will create a duplex stream which passes items through and emits globbed files. Since Gulp 4.0.",
					"type": "boolean",
					"default": false
				},
				"read": {
					"description": "Setting this to false will return file.contents as null and not read the file at all.",
					"type": "boolean",
					"default": true
				},
				"realpath": {
					"description": "Set to true to call fs.realpath on all of the results. In the case of a symlink that cannot be resolved, the full absolute path to the matched entry is returned (though it will usually be a broken symlink)",
					"type": "boolean",
					"default": false
				},
				"root": {
					"description": "The place where patterns starting with / will be mounted onto. Defaults to path.resolve(options.cwd, \"/\") (/ on Unix systems, and C:\\ or some such on Windows.)",
					"type": "string"
				},
				"silent": {
					"description": "When an unusual error is encountered when attempting to read a directory, a warning will be printed to stderr. Set the silent option to true to suppress these warnings.",
					"type": "boolean",
					"default": false
				},
				"since": {
					"description": "Setting this to a Date or a time stamp will discard any file that have not been modified since the time specified. Since Gulp 4.0.",
					"type": ["object", "integer"]
				},
				"stat": {
					"description": "Set to true to stat all results. This reduces performance somewhat, and is completely unnecessary, unless readdir is presumed to be an untrustworthy indicator of file existence.",
					"type": "boolean",
					"default": false
				},
				"statCache": {
					"description": "A cache of results of filesystem information, to prevent unnecessary stat calls. While it should not normally be necessary to set this, you may pass the statCache from one glob() call to the options object of another, if you know that the filesystem will not change between calls.",
					"type": "object"
				},
				"strict": {
					"description": "When an unusual error is encountered when attempting to read a directory, the process will just continue on in search of other matches. Set the strict option to raise an error in these cases.",
					"type": "boolean",
					"default": false
				},
				"symlinks": {
					"description": "A cache of known symbolic links. You may pass in a previously generated symlinks object to save lstat calls when resolving ** matches.",
					"type": "object"
				},
				"join": {
					"description": "Join parent's folder. Since Gulp-Chef 0.1.0.",
					"type": ["string", "boolean"],
					"default": "src"
				}
			}
		},
		"required": ["globs"]
	},
	"primary": "globs",
	"gathering": "options"
}