Interface IExpandedFilesConfig

These are valid for compact-format

Hierarchy

Index

Properties

Properties

optional public cwd?: boolean

All {@link IExpandedFilesConfig.src} matches are relative to (but don't include) this path.

optional public debug?: boolean

Dump a ton of stuff to stderr.

optional public dest?: string

Destination path prefix.

optional public dot?: boolean

Allow patterns to match filenames starting with a period, even if the pattern does not explicitly have a period in that spot.

optional public expand?: boolean

Enables the following options

optional public ext?: string

Replace any existing extension with this value in generated {@link IExpandedFilesConfig.dest} paths.

optional public filter?: any

Either a valid fs.Stats method name:

  • isFile
  • isDirectory
  • isBlockDevice
  • isCharacterDevice
  • isSymbolicLink
  • isFIFO
  • isSocket

or a function that is passed the matched src filepath and returns true or false.

string (src: string) => boolean

optional public flatten?: boolean

Remove all path parts from generated {@link IExpandedFilesConfig.dest} paths.

optional public flipNegate?: boolean

Returns from negate expressions the same as if they were not negated. (Ie, true on a hit, false on a miss.)

optional public matchBase?: boolean

If set, then patterns without slashes will be matched against the basename of the path if it contains slashes. For example, a?b would match the path /xyz/123/acb, but not /xyz/acb/123.

optional public nobrace?: boolean

Do not expand {a,b} and {1..3} brace sets.

optional public nocase?: boolean

Perform a case-insensitive match.

optional public nocomment?: boolean

Suppress the behavior of treating # at the start of a pattern as a comment.

optional public noext?: boolean

Disable "extglob" style patterns like +(a|b).

optional public noglobstar?: boolean

Disable ** matching against multiple folder names.

optional public nonegate?: boolean

Suppress the behavior of treating a leading ! character as negation.

optional public nonull?: boolean

When a match is not found by minimatch.match, return a list containing the pattern itself. When set, an empty list is returned if there are no matches.

optional public rename?: Function

This function is called for each matched src file, (after extension renaming and flattening). The {@link IExpandedFilesConfig.dest} and matched {@link IExpandedFilesConfig.src} path are passed in, and this function must return a new dest value. If the same dest is returned more than once, each src which used it will be added to an array of sources for it.

optional public src?: Array<string>

Pattern(s) to match, relative to the {@link IExpandedFilesConfig.cwd}.