minimatch

小型比赛

一个最小的匹配实用程序。

这是npm内部使用的匹配库。

它的工作原理是将 glob 表达式转换为 JavaScript RegExp对象。

用法

// 混合模块，使用 require() 或 importimport { minimatch } from 'minimatch' // 或:const { minimatch } = require('minimatch')minimatch('bar.foo', '*.foo') 加载true!minimatch('bar.foo', '*.bar') // false!minimatch('bar.foo', '*.+(bar|foo)', { debug: true }) // true, 并且嘈杂！

特征

支持这些全局功能：

• 支撑扩张

• 扩展全局匹配

• “Globstar” **匹配

• Posix 字符类，例如[[:alpha:]] ，支持全范围的 Unicode 字符。例如， [[:alpha:]]将与'é'匹配，但[a-zA-Z]不会。不支持整理符号和设置匹配，因此在ch被视为单个字符的语言环境中， [[=e=]]将不匹配'é' ，而[[.ch.]]将不匹配'ch' 。

看：

• man sh

• man bash模式匹配

• man 3 fnmatch

• man 5 gitignore

视窗

请仅在 glob 表达式中使用正斜杠。

尽管 Windows 使用/或 作为其路径分隔符，但此 glob 实现仅使用/字符。只能在 glob 表达式中使用正斜杠。模式中的反斜杠将始终被解释为转义字符，而不是路径分隔符。

请注意，or /将被解释为 Windows 上路径中的路径分隔符，并将与 glob 表达式中的/匹配。

所以总是在模式中使用/ 。

UNC 路径

在 Windows 上，像//?/c:/...或//ComputerName/Share/...这样的 UNC 路径会被特殊处理。

• 以双斜杠开头后跟一些非斜杠字符的模式将保留其双斜杠。因此，像//*这样的模式将匹配//x ，但不匹配/x 。

• 以//?/<drive letter>:开头的模式不会处理?作为通配符。相反，它将被视为普通字符串。

• 以//?/<drive letter>:/...开头的模式将匹配以<drive letter>:/...开头的文件路径，反之亦然，就好像//?/不存在一样。仅当驱动器盘符彼此不区分大小写的匹配时，才会出现此行为。路径/模式的其余部分将区分大小写进行比较，除非设置了nocase:true 。

请注意，在文件路径参数中始终允许使用字符作为路径分隔符指定 UNC 路径，但仅当在选项中设置windowsPathsNoEscape: true时才允许在模式参数中。

迷你比赛类

通过实例化minimatch.Minimatch类来创建 minimatch 对象。

 var Minimatch = require('minimatch').Minimatchvar mm = new Minimatch(模式, 选项)

特性

• pattern minimatch 对象表示的原始模式。

• options提供给构造函数的选项。

• set则表达式或字符串表达式的二维数组。数组中的每一行对应一个大括号扩展模式。行中的每个项目对应于单个路径部分。例如，模式{a,b/c}/d将扩展为一组模式，例如：

    [ [ a, d ]
    , [ b, c, d ] ]

  如果模式的一部分没有任何“魔法”（也就是说，它类似于"foo"而不是fo*o? ），那么它将保留为字符串而不是转换为正则表达式。

• regexp由makeRe方法创建。表达整个模式的单个正则表达式。如果您希望使用类似于fnmatch(3)并启用FNM_PATH模式，这非常有用。

• negate如果模式被否定则为真。

• comment如果模式是注释则为真。

• empty如果模式为""则为真。

方法

• makeRe()如有必要，生成regexp成员，然后返回它。如果模式无效，将返回false 。

• match(fname)如果文件名与模式匹配，则返回 true，否则返回 false。

• matchOne(fileArray, patternArray, partial)采用/分割的文件名，并将其与regExpSet中的单行进行匹配。此方法主要供内部使用，但被公开以便需要避免过多文件系统调用的 glob-walker 可以使用它。

• hasMagic()如果解析的模式包含任何魔术字符，则返回 true。如果所有比较器部分都是字符串文字，则返回 false。如果在构造函数上设置magicalBraces选项，那么它将考虑将原本不神奇的大括号扩展视为魔术。如果未设置，则像a{b,c}d这样的模式将返回false ，因为abd和acd都不包含任何特殊的全局字符。

  这并不意味着模式字符串可以用作文字文件名，因为它可能包含转义的魔术 glob 字符。例如，模式*或[*]不会被认为具有魔力，因为匹配部分解析为文字字符串'*'并且会匹配名为'*'的路径，而不是'*'或'[*]' 。 minimatch.unescape()方法可用于删除转义字符。

所有其他方法都是内部方法，将在必要时调用。

minimatch（路径、模式、选项）

主要出口。使用选项根据模式测试路径。

 var isJS = minimatch(file, '*.js', { matchBase: true })

minimatch.filter（模式，选项）

返回一个测试其提供的参数的函数，适合与Array.filter一起使用。例子：

 var javascripts = fileList.filter(minimatch.filter('*.js', { matchBase: true }))

minimatch.escape(模式, 选项 = {})

对全局模式中的所有魔术字符进行转义，以便它只匹配文字字符串

如果使用windowsPathsNoEscape选项，则通过用[]换行来转义字符，因为字符类中换行的魔术字符只能由该确切字符来满足。

斜杠（以及windowsPathsNoEscape模式中的反斜杠）无法转义或未转义。

minimatch.unescape(模式, 选项 = {})

对可能包含一些转义字符的全局字符串进行取消转义。

如果使用windowsPathsNoEscape选项，则删除方括号转义符，但不删除反斜杠转义符。例如，它将字符串'[*]'转换为* ，但不会将'*'转换为'*' ，因为 是windowsPathsNoEscape模式下的路径分隔符。

如果未设置windowsPathsNoEscape ，则会删除大括号转义符和反斜杠转义符。

斜杠（以及windowsPathsNoEscape模式中的反斜杠）无法转义或未转义。

minimatch.match(列表、模式、选项)

以 fnmatch 或 glob 的风格匹配文件列表。如果没有任何内容匹配，并且设置了 options.nonull，则返回包含模式本身的列表。

 var javascripts = minimatch.match(fileList, '*.js', { matchBase: true })

minimatch.makeRe（模式，选项）

从模式创建正则表达式对象。

选项

默认情况下，所有选项均为false 。

调试

将大量内容转储到 stderr。

诺布拉斯

不要展开{a,b}和{1..3}大括号集。

无球星

禁用针对多个文件夹名称的**匹配。

点

允许模式匹配以句点开头的文件名，即使该模式在该位置没有明确包含句点。

请注意，默认情况下， a/**/b不会匹配a/.d/b ，除非设置了dot 。

没有下一个

禁用“extglob”样式模式，例如+(a|b) 。

诺卡塞

执行不区分大小写的匹配。

nocaseMagicOnly

与{nocase: true}一起使用时，创建不区分大小写的正则表达式，但保持字符串匹配部分不变。在没有{nocase: true}的情况下使用时无效

当使用某种其他形式的不区分大小写的匹配时，或者原始字符串表示以其他方式有用时，这很有用。

非空

当minimatch.match未找到匹配项时，如果设置了此选项，则返回包含模式本身的列表。如果未设置，如果没有匹配项，则返回空列表。

神奇的牙套

这仅影响Minimatch.hasMagic方法的结果。

如果模式包含大括号扩展，例如a{b,c}d ，但没有其他魔术字符，则Minimatch.hasMagic()方法将默认返回false 。设置此选项后，对于大括号扩展以及其他魔法全局字符，它将返回true 。

匹配库

如果设置，则不带斜杠的模式将与路径的基本名称（如果包含斜杠）进行匹配。例如， a?b将匹配路径/xyz/123/acb ，但不匹配/xyz/acb/123 。

没有意见

禁止将模式开头的#视为注释的行为。

诺内盖特

打压对待领导的行为!字符为否定。

翻转否定

从否定表达式返回的结果与未进行否定时相同。 （即命中时为真，未击中时为假。）

部分的

将部分路径与模式进行比较。只要存在的路径部分与模式不矛盾，就会被视为匹配。这对于您正在遍历文件夹结构并且尚未获得完整路径，但希望确保您不会沿着永远无法匹配的路径进行遍历的应用程序非常有用。

例如，

 minimatch('/a/b', '/a/*/c/d', {partial: true }) // true，可能是 /a/b/c/dminimatch('/a/b', '/ **/d', {partial: true }) // true，可能是 /a/b/.../dminimatch('/x/y/z', '/a/**/z', {partial : true }) // false，因为 x !==一个

windows路径无处可逃

仅使用作为路径分隔符，切勿作为转义字符。如果设置，则模式中的所有字符都将替换为/ 。请注意，这使得无法与包含文字 glob 模式字符的路径进行匹配，但允许与 Windows 平台上使用path.join()和path.resolve()构造的模式进行匹配，模仿 Windows 上早期版本的（错误！）行为。请谨慎使用，并注意有关 Windows 路径的警告。

由于遗留原因，如果options.allowWindowsEscape设置为确切值false也会设置此值。

windowsNoMagicRoot

当模式以 UNC 路径或驱动器号开头且处于nocase:true模式时，请勿将模式的根部分转换为不区分大小写的正则表达式，而是将它们保留为字符串。

当平台为win32且设置了nocase:true时，这是默认值。

保留多个斜杠

默认情况下，多个/字符（UNC 路径中的前导//除外，请参阅上面的“UNC 路径”）被视为单个/ 。

也就是说，像a///b这样的模式将匹配文件路径a/b 。

设置preserveMultipleSlashes: true以抑制此行为。

优化级别

一个数字，指示在解析模式并将其用于匹配之前应对模式进行的优化级别。

当设置noglobstar时，Globstar 部分**始终转换为* ，并且多个相邻**部分将转换为单个** （即a/**/**/b将被视为a/**/b ，因为这在所有情况下都是等效的）。

• 0 - 不做进一步的更改。在这种模式下， .和..保留在模式中，这意味着它们也必须出现在测试路径字符串中的相同位置。例如，像a/*/../c这样的模式将匹配字符串a/b/../c但不匹配字符串a/c 。

• 1 -（默认）删除双点..跟随不是** , .的模式部分的情况。 , ..或空'' 。例如，模式./a/b/../*被转换为./a/* ，因此它将匹配路径字符串./a/c ，但不匹配路径字符串./a/b/../c .图案中的点和空路径部分将被保留。

• 2 （或更高）- 更积极的优化，适合与文件遍历案例一起使用：

  虽然这些优化提高了文件遍历用例（例如 glob）的性能（即该模块存在的原因），但在某些情况下，它无法匹配在优化级别 1 或 0 中匹配的文字字符串。

  具体来说，虽然Minimatch.match()方法将以相同的方式优化文件路径字符串，从而产生相同的匹配，但在使用Minimatch.makeRe()提供的正则表达式进行测试时，它将失败，除非路径字符串是第一个使用minimatch.levelTwoFileOptimize()或类似方法进行处理。

• 删除双点..跟随不是** , .的模式部分的情况。 ，或空'' 。删除空的 和.模式的一部分，在安全的情况下这样做（即，除了以/开头的模式中的最后一个位置、第一个位置或第二个位置之外的任何位置，因为这可能表示 Windows 上的 UNC 路径）。

• 将包含<pre>/**/../<p>/<rest>模式转换为等效的<pre>/{..,**}/<p>/<rest> ，其中<p>是一个模式除 之外的部分. , .. , ** , 或空'' 。

• 重复数据删除模式中，一个模式中存在**部分，并且它不是最终路径部分，并且它们在其他方面是等效的。因此{a/**/b,a/b}变为a/**/b ，因为**与空路径部分匹配。

• 重复数据删除模式中存在*部分，以及除** , 之外的非点模式. 、 ..或''位于另一个的相同位置。因此a/{*,x}/b变为a/*/b ，因为*可以与x匹配。

平台

当设置为win32时，这将触发所有特定于 Windows 的行为（对 UNC 路径的特殊处理，并将其视为文件路径中的分隔符以进行比较。）

默认为process.platform的值。

与其他 fnmatch/glob 实现的比较

虽然严格遵守现有标准是一个有价值的目标，但小型匹配和其他实现之间存在一些差异。有些是故意的，有些是不可避免的。

如果模式以!字符，则它被否定。设置nonegate标志来抑制这种行为，并对待leading !字符正常。如果您希望以负 extglob 模式（如!(a|B)启动该模式，这可能是相关的。多种的!模式开头的字符将多次否定该模式。

如果模式以#开头，则它将被视为注释，并且不会匹配任何内容。使用#来匹配行开头的文字# ，或设置nocomment标志来抑制此行为。

默认情况下支持双星字符** ，除非设置了noglobstar标志。这是以 bsdglob 和 bash 4.1 的方式支持的，其中**仅当它是路径部分中的唯一内容时才具有特殊意义。也就是说， a/**/b将匹配a/x/y/b ，但a/**b不会。

如果转义模式没有匹配项，并且设置了nonull标志，则 minimatch.match 将返回提供的模式，而不是解释字符转义。例如， minimatch.match([], "*a?")将返回"*a?"而不是"*a?" 。这类似于在 bash 中设置nullglob选项，只不过它不解析转义模式字符。

如果未禁用大括号扩展，则它会在 glob 模式的任何其他解释之前执行。因此，像+(a|{b),c)}这样的模式在 bash 或 zsh 中无效，首先被扩展为+(a|b)和+(a|c)的集合，并且这些模式检查模式的有效性。由于这两个有效，因此匹配继续进行。

否定的 extglob 模式的处理尽可能接近 Bash 语义，但在某些情况下，否定的 extglob 很难在 JavaScript 正则表达式中表达。特别是否定模式<start>!(<pattern>*|)*将在 bash 中匹配任何不以<start><pattern>开头的内容。但是， <start>!(<pattern>*)*将匹配以<start><pattern>开头的路径，因为空字符串可以与否定部分匹配。在此库中， <start>!(<pattern>*|)*将不匹配以<start>开头的任何模式，因为在正则表达式与 bash 路径扩展中哪些模式被视为“贪婪”的模式存在差异。这可能是可以修复的，但会带来一些复杂性和性能成本，而且这种权衡似乎不值得追求。

请注意，libc 中的fnmatch(3)是一个极其简单的字符串比较匹配器，它不会对斜杠执行任何特殊操作。该库设计用于全局搜索和文件遍历器，因此它确实使用/做一些特殊的事情。因此， foo*将不会匹配此库中的foo/bar ，即使它在fnmatch(3)中也是如此。