cspell-glob 5.12.2 → 5.12.3

package/dist/GlobMatcher.d.ts

@@ -41,6 +41,12 @@ interface NormalizedGlobMatchOptions {
      * @default: require('path')
      */
     nodePath: PathInterface;
+    /**
+     * Disable brace matching, so that `{a,b}` and `{1..3}` would be treated as literal characters.
+     *
+     * @default false
+     */
+    nobrace?: boolean;
 }
 export declare class GlobMatcher {
     /**

package/dist/GlobMatcher.js

@@ -25,13 +25,15 @@ const Path = __importStar(require("path"));
 const globHelper_1 = require("./globHelper");
 class GlobMatcher {
     constructor(patterns, rootOrOptions, _nodePath) {
+        var _a;
         _nodePath = _nodePath !== null && _nodePath !== void 0 ? _nodePath : Path;
-        const options = typeof rootOrOptions === 'string' ? { root: rootOrOptions, nodePath: _nodePath } : rootOrOptions !== null && rootOrOptions !== void 0 ? rootOrOptions : {};
+        const options = typeof rootOrOptions === 'string' ? { root: rootOrOptions } : rootOrOptions !== null && rootOrOptions !== void 0 ? rootOrOptions : {};
         const { mode = 'exclude' } = options;
         const isExcludeMode = mode !== 'include';
-        const { root = _nodePath.resolve(), dot = isExcludeMode, nodePath = _nodePath, nested = isExcludeMode, } = options;
+        _nodePath = (_a = options.nodePath) !== null && _a !== void 0 ? _a : _nodePath;
+        const { root = _nodePath.resolve(), dot = isExcludeMode, nodePath = _nodePath, nested = isExcludeMode, nobrace, } = options;
         const normalizedRoot = nodePath.resolve(nodePath.normalize(root));
-        this.options = { root: normalizedRoot, dot, nodePath, nested, mode };
+        this.options = { root: normalizedRoot, dot, nodePath, nested, mode, nobrace };
         patterns = Array.isArray(patterns)
             ? patterns
             : typeof patterns === 'string'
@@ -74,7 +76,8 @@ exports.GlobMatcher = GlobMatcher;
  * @returns a function given a filename returns true if it matches.
  */
 function buildMatcherFn(patterns, options) {
-    const path = options.nodePath;
+    const { nodePath: path, dot, nobrace } = options;
+    const makeReOptions = { dot, nobrace };
     const rules = patterns
         .map((pattern, index) => ({ pattern, index }))
         .filter((r) => !!r.pattern.glob)
@@ -83,7 +86,7 @@ function buildMatcherFn(patterns, options) {
         const matchNeg = pattern.glob.match(/^!/);
         const glob = pattern.glob.replace(/^!/, '');
         const isNeg = (matchNeg && matchNeg[0].length & 1 && true) || false;
-        const reg = mm.makeRe(glob, { dot: options.dot });
+        const reg = mm.makeRe(glob, makeReOptions);
         const fn = (filename) => {
             const match = filename.match(reg);
             return !!match;

package/dist/GlobMatcherTypes.d.ts

@@ -34,6 +34,10 @@ export interface GlobPatternWithOptionalRoot {
      * Optional value useful for tracing which file a glob pattern was defined in.
      */
     source?: string;
+    /**
+     * Optional line number in the source
+     */
+    line?: number;
 }
 export interface GlobPatternWithRoot extends GlobPatternWithOptionalRoot {
     root: string;

package/dist/globHelper.d.ts

@@ -14,6 +14,7 @@ export declare function fileOrGlobToGlob(fileOrGlob: string | GlobPattern, root:
 export declare function doesRootContainPath(root: string, child: string, path: PathInterface): boolean;
 export declare function isGlobPatternWithOptionalRoot(g: GlobPattern): g is GlobPatternWithOptionalRoot;
 export declare function isGlobPatternWithRoot(g: GlobPatternWithRoot | GlobPatternWithOptionalRoot): g is GlobPatternWithRoot;
+export declare function isGlobPatternNormalized(g: GlobPattern | GlobPatternNormalized): g is GlobPatternNormalized;
 export interface NormalizeOptions {
     nested: boolean;
     root: string;
@@ -34,15 +35,21 @@ export declare function normalizeGlobPatterns(patterns: GlobPattern[], options:
  * @param path - Node Path modules to use (testing only)
  */
 export declare function normalizeGlobToRoot<Glob extends GlobPatternWithRoot>(glob: Glob, root: string, path: PathInterface): Glob;
-export declare function isGlobPatternNormalized(p: GlobPatternWithRoot | GlobPatternNormalized): p is GlobPatternNormalized;
 /**
  * Rebase a glob string to a new prefix
  * @param glob - glob string
  * @param rebaseTo - glob prefix
  */
 declare function rebaseGlob(glob: string, rebaseTo: string): string | undefined;
+/**
+ * Trims any trailing spaces, tabs, line-feeds, new-lines, and comments
+ * @param glob - glob string
+ * @returns trimmed glob
+ */
+declare function trimGlob(glob: string): string;
 export declare const __testing__: {
     rebaseGlob: typeof rebaseGlob;
+    trimGlob: typeof trimGlob;
 };
 export {};
 //# sourceMappingURL=globHelper.d.ts.map

package/dist/globHelper.js

@@ -19,7 +19,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.__testing__ = exports.isGlobPatternNormalized = exports.normalizeGlobToRoot = exports.normalizeGlobPatterns = exports.isGlobPatternWithRoot = exports.isGlobPatternWithOptionalRoot = exports.doesRootContainPath = exports.fileOrGlobToGlob = void 0;
+exports.__testing__ = exports.normalizeGlobToRoot = exports.normalizeGlobPatterns = exports.isGlobPatternNormalized = exports.isGlobPatternWithRoot = exports.isGlobPatternWithOptionalRoot = exports.doesRootContainPath = exports.fileOrGlobToGlob = void 0;
 const Path = __importStar(require("path"));
 const { posix } = Path;
 const relRegExp = /^\.[\\/]/;
@@ -59,16 +59,6 @@ function doesRootContainPath(root, child, path) {
     return !rel || (rel !== child && !rel.startsWith('..') && !path.isAbsolute(rel));
 }
 exports.doesRootContainPath = doesRootContainPath;
-const mutationsNestedOnly = [
-    [/^[/]([^/]*)$/, '{$1,$1/**}'],
-    [/^[^/#][^/]*$/, '**/{$&,$&/**}'],
-    [/^[^/#][^/]*\/$/, '**/$&**/*'], // ending slash, should match any nested directory
-];
-const mutationsGeneral = [
-    [/^\//, ''],
-    [/\/$/, '$&**/*'], // if it ends in a slash, make sure matches the folder
-];
-const mutationsNested = mutationsNestedOnly.concat(mutationsGeneral);
 function isGlobPatternWithOptionalRoot(g) {
     return typeof g !== 'string' && typeof g.glob === 'string';
 }
@@ -77,13 +67,45 @@ function isGlobPatternWithRoot(g) {
     return !!g.root;
 }
 exports.isGlobPatternWithRoot = isGlobPatternWithRoot;
+function isGlobPatternNormalized(g) {
+    if (!isGlobPatternWithOptionalRoot(g))
+        return false;
+    if (!isGlobPatternWithRoot(g))
+        return false;
+    const gr = g;
+    return 'rawGlob' in gr && 'rawRoot' in gr && typeof gr.rawGlob === 'string';
+}
+exports.isGlobPatternNormalized = isGlobPatternNormalized;
 function normalizePattern(pattern, nested) {
     pattern = pattern.replace(/^(!!)+/, '');
     const isNeg = pattern.startsWith('!');
+    const prefix = isNeg ? '!' : '';
     pattern = isNeg ? pattern.slice(1) : pattern;
-    const mutations = nested ? mutationsNested : mutationsGeneral;
-    pattern = mutations.reduce((p, [regex, replace]) => p.replace(regex, replace), pattern);
-    return isNeg ? '!' + pattern : pattern;
+    const patterns = nested ? normalizePatternNested(pattern) : normalizePatternGeneral(pattern);
+    return patterns.map((p) => prefix + p);
+}
+function normalizePatternNested(pattern) {
+    // no slashes will match files names or folders
+    if (!pattern.includes('/')) {
+        if (pattern === '**')
+            return ['**'];
+        return ['**/' + pattern, '**/' + pattern + '/**'];
+    }
+    const hasLeadingSlash = pattern.startsWith('/');
+    pattern = hasLeadingSlash ? pattern.slice(1) : pattern;
+    if (pattern.endsWith('/')) {
+        // legacy behavior, if it only has a trailing slash, allow matching against a nested directory.
+        return hasLeadingSlash || pattern.slice(0, -1).includes('/') ? [pattern + '**/*'] : ['**/' + pattern + '**/*'];
+    }
+    if (pattern.endsWith('**')) {
+        return [pattern];
+    }
+    return [pattern, pattern + '/**'];
+}
+function normalizePatternGeneral(pattern) {
+    pattern = pattern.startsWith('/') ? pattern.slice(1) : pattern;
+    pattern = pattern.endsWith('/') ? pattern + '**/*' : pattern;
+    return [pattern];
 }
 /**
  *
@@ -91,25 +113,32 @@ function normalizePattern(pattern, nested) {
  * @param options - Normalization options.
  */
 function normalizeGlobPatterns(patterns, options) {
-    return patterns.map((g) => normalizeGlobPatternWithRoot(g, options));
+    function* normalize() {
+        for (const glob of patterns) {
+            if (isGlobPatternNormalized(glob)) {
+                yield glob;
+                continue;
+            }
+            yield* normalizeGlobPatternWithRoot(glob, options);
+        }
+    }
+    return [...normalize()];
 }
 exports.normalizeGlobPatterns = normalizeGlobPatterns;
 function normalizeGlobPatternWithRoot(g, options) {
+    var _a;
     const { root, nodePath: path, nested } = options;
-    g = !isGlobPatternWithOptionalRoot(g)
-        ? {
-            glob: g.trim(),
-            root,
-        }
-        : g;
-    const gr = isGlobPatternWithRoot(g) ? { ...g } : { ...g, root };
+    g = !isGlobPatternWithOptionalRoot(g) ? { glob: g } : g;
+    const gr = { ...g, root: (_a = g.root) !== null && _a !== void 0 ? _a : root };
+    const rawRoot = gr.root;
+    const rawGlob = g.glob;
+    gr.glob = gr.glob.trim(); // trimGlob(g.glob);
     if (gr.root.startsWith('${cwd}')) {
         gr.root = path.join(path.resolve(), gr.root.replace('${cwd}', ''));
     }
     gr.root = path.resolve(root, path.normalize(gr.root));
-    gr.glob = normalizePattern(gr.glob, nested);
-    const gn = { ...gr, rawGlob: g.glob, rawRoot: g.root };
-    return gn;
+    const globs = normalizePattern(gr.glob, nested);
+    return globs.map((glob) => ({ ...gr, glob, rawGlob, rawRoot }));
 }
 /**
  * Try to adjust the root of a glob to match a new root. If it is not possible, the original glob is returned.
@@ -157,10 +186,6 @@ function normalizeGlobToRoot(glob, root, path) {
     return rebasedGlob ? { ...glob, glob: prefix + rebasedGlob, root } : glob;
 }
 exports.normalizeGlobToRoot = normalizeGlobToRoot;
-function isGlobPatternNormalized(p) {
-    return p.rawGlob !== undefined;
-}
-exports.isGlobPatternNormalized = isGlobPatternNormalized;
 /**
  * Rebase a glob string to a new prefix
  * @param glob - glob string
@@ -190,7 +215,55 @@ function rebaseGlob(glob, rebaseTo) {
     }
     return undefined;
 }
+/**
+ * Trims any trailing spaces, tabs, line-feeds, new-lines, and comments
+ * @param glob - glob string
+ * @returns trimmed glob
+ */
+function trimGlob(glob) {
+    glob = glob.replace(/(?<!\\)#.*/g, '');
+    glob = trimGlobLeft(glob);
+    glob = trimGlobRight(glob);
+    return glob;
+}
+const spaces = {
+    ' ': true,
+    '\t': true,
+    '\n': true,
+    '\r': true,
+};
+/**
+ * Trim any trailing spaces, tabs, line-feeds, or new-lines
+ * Handles a trailing \<space>
+ * @param glob - glob string
+ * @returns glob string with space to the right removed.
+ */
+function trimGlobRight(glob) {
+    const lenMin1 = glob.length - 1;
+    let i = lenMin1;
+    while (i >= 0 && glob[i] in spaces) {
+        --i;
+    }
+    if (glob[i] === '\\' && i < lenMin1) {
+        ++i;
+    }
+    ++i;
+    return i ? glob.slice(0, i) : '';
+}
+/**
+ * Trim any leading spaces, tabs, line-feeds, or new-lines
+ * @param glob - any string
+ * @returns string with leading spaces removed.
+ */
+function trimGlobLeft(glob) {
+    let i = 0;
+    while (i < glob.length && glob[i] in spaces) {
+        ++i;
+    }
+    return glob.slice(i);
+}
 exports.__testing__ = {
     rebaseGlob,
+    trimGlob,
 };
 //# sourceMappingURL=globHelper.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cspell-glob",
-  "version": "5.12.2",
+  "version": "5.12.3",
   "description": "Glob matcher for cspell",
   "keywords": [
     "cspell",
@@ -47,8 +47,8 @@
   "devDependencies": {
     "@types/micromatch": "^4.0.2",
     "@types/node": "^16.10.3",
-    "jest": "^27.2.4",
+    "jest": "^27.2.5",
     "rimraf": "^3.0.2"
   },
-  "gitHead": "1418785bb9c3a29b794a6e9d447b5638f8eb9fbf"
+  "gitHead": "6c424aed933adb8d983ab09dd45042d63d7a5cd8"
 }