glob.ts ×24

Frontier kind: Code frontier

unlabeled · c_3526a6c6ec5f

2658 tests · 7078 LOC · 32 files · introduces 0 tests · 167 LOC · 1 file

Introduces — evidence that enters the hierarchy at this concept

Code
24 ranges167 lines · 1 files
Tests
0 tests

Contains — complete concept membership

All code (extent)
1023 ranges7078 lines · 32 files · Browse complete extent
All tests (intent)
2658 testsBrowse complete intent

Neighbourhood graph

The orange circle is the focus. Violet and green circles are every ancestor and descendant, broader and narrower, at any distance; blue squares and pink diamonds are the introduced files and exact introduced tests of every visible concept, not only the focus's. Arrows point from broader to narrower concepts and bridge only concepts omitted from this view. Undirected links show source or test introduction. Concept and file size follows LOC; exact test nodes use test-count units.

Introduced files, introduced tests, and structurally relevant concept specialization

In the embedded map, ordinary wheel input scrolls the page; use the visible controls to zoom and drag to pan. Open the full-screen map for canvas navigation: wheel pans, Ctrl/Command plus wheel zooms, and arrow keys pan when this region is focused. On touch screens, open the full-screen map to pan or pinch. If JavaScript or WebGL is unavailable, use the native relationship evidence on this page.

Graph controls are ready.

Interactive rendering requires JavaScript and WebGL. Use the native relationship evidence on this page while the interactive map is unavailable.

Native relationship evidence

Every exact file and test below is linked only from the concept that introduces it.

Introduced tests

Every collected test enters the hierarchy at exactly one concept.

No tests are introduced at this concept. Its intent tests are introduced by other concepts.

Introduced code

Every collected source range enters the hierarchy at exactly one concept.

1 file ranked by introduced lines: 167 introduced LOC across 24 ranges. Expand a file to inspect source; the > gutter marks introduced lines.

src/vs/base/common/glob.ts 167 introduced LOC · 24 ranges

Open complete file

1 > /*--------------------------------------------------------------------------------------------- glob.ts
2 > * Copyright (c) Microsoft Corporation. All rights reserved.
3 > * Licensed under the MIT License. See License.txt in the project root for license information.
4 > *--------------------------------------------------------------------------------------------*/
5 >
6 > import { equals } from './arrays.js';
7 > import { isThenable } from './async.js';
8 > import { CharCode } from './charCode.js';
9 > import { isEqualOrParent } from './extpath.js';
10 > import { LRUCache } from './map.js';
11 > import { basename, extname, posix, sep } from './path.js';
12 > import { isLinux } from './platform.js';
13 > import { endsWithIgnoreCase, equalsIgnoreCase, escapeRegExpCharacters, ltrim } from './strings.js';
14 >
15 > export interface IRelativePattern {
16 >
17 > /**
18 > * A base file path to which this pattern will be matched against relatively.
19 > */
20 > readonly base: string;
21 >
22 > /**
23 > * A file glob pattern like `*.{ts,js}` that will be matched on file paths
24 > * relative to the base path.
25 > *
26 > * Example: Given a base of `/home/work/folder` and a file path of `/home/work/folder/index.js`,
27 > * the file glob pattern will match on `index.js`.
28 > */
29 > readonly pattern: string;
30 > }
31 >
32 > export interface IExpression {
33 > [pattern: string]: boolean | SiblingClause;
34 > }
35 >
36 > export function getEmptyExpression(): IExpression {
37 return Object.create(null);
38 }
39 > glob.ts
40 > interface SiblingClause {
41 > when: string;
42 > }
43 >
44 > export const GLOBSTAR = '**';
45 > export const GLOB_SPLIT = '/';
46 >
47 > const PATH_REGEX = '[/\\\\]'; // any slash or backslash
48 > const NO_PATH_REGEX = '[^/\\\\]'; // any non-slash and non-backslash
49 > const ALL_FORWARD_SLASHES = /\//g;
50 >
51 function starsToRegExp(starCount: number, isLastPattern?: boolean): string {
52 switch (starCount) {
63 }
64 }
65 > glob.ts
66 > export function splitGlobAware(pattern: string, splitChar: string): string[] {
67 if (!pattern) {
68 return [];
109 return segments;
110 }
111 > glob.ts
112 function parseRegExp(pattern: string): string {
113 if (!pattern) {
256 return regEx;
257 }
258 > glob.ts
259 > // regexes to check for trivial glob patterns that just check for String#endsWith
260 > const T1 = /^\*\*\/\*\.[\w\.-]+$/; // **/*.something
261 > const T2 = /^\*\*\/([\w\.-]+)\/?$/; // **/something
262 > const T3 = /^{\*\*\/\*?[\w\.-]+\/?(,\*\*\/\*?[\w\.-]+\/?)*}$/; // {**/*.something,**/*.else} or {**/package.json,**/project.json}
263 > const T3_2 = /^{\*\*\/\*?[\w\.-]+(\/(\*\*)?)?(,\*\*\/\*?[\w\.-]+(\/(\*\*)?)?)*}$/; // Like T3, with optional trailing /**
264 > const T4 = /^\*\*((\/[\w\.-]+)+)\/?$/; // **/something/else
265 > const T5 = /^([\w\.-]+(\/[\w\.-]+)*)\/?$/; // something/else
266 >
267 > export type ParsedPattern = (path: string, basename?: string) => boolean;
268 >
269 > // The `ParsedExpression` returns a `Promise`
270 > // iff `hasSibling` returns a `Promise`.
271 > export type ParsedExpression = (path: string, basename?: string, hasSibling?: (name: string) => boolean | Promise<boolean>) => string | null | Promise<string | null> /* the matching pattern */;
272 >
273 > export interface IGlobOptions {
274 >
275 > /**
276 > * Simplify patterns for use as exclusion filters during
277 > * tree traversal to skip entire subtrees. Cannot be used
278 > * outside of a tree traversal.
279 > */
280 > trimForExclusions?: boolean;
281 >
282 > /**
283 > * Whether glob pattern matching should be case insensitive.
284 > */
285 > ignoreCase?: boolean;
286 > }
287 >
288 > interface IGlobOptionsInternal extends IGlobOptions {
289 > equals: (a: string, b: string) => boolean;
290 > endsWith: (str: string, candidate: string) => boolean;
291 > isEqualOrParent: (base: string, candidate: string) => boolean;
292 > }
293 >
294 > interface ParsedStringPattern {
295 > (path: string, basename?: string): string | null | Promise<string | null> /* the matching pattern */;
296 > basenames?: string[];
297 > patterns?: string[];
298 > allBasenames?: string[];
299 > allPaths?: string[];
300 > }
301 >
302 > interface ParsedExpressionPattern {
303 > (path: string, basename?: string, name?: string, hasSibling?: (name: string) => boolean | Promise<boolean>): string | null | Promise<string | null> /* the matching pattern */;
304 > requiresSiblings?: boolean;
305 > allBasenames?: string[];
306 > allPaths?: string[];
307 > }
308 >
309 > const CACHE = new LRUCache<string, ParsedStringPattern>(10000); // bounded to 10000 elements
310 >
311 > const FALSE = function () {
312 return false;
313 };
314 > glob.ts
315 > const NULL = function (): string | null {
316 return null;
317 };
318 > glob.ts
319 > /**
320 > * Check if a provided parsed pattern or expression
321 > * is empty - hence it won't ever match anything.
322 > *
323 > * See {@link FALSE} and {@link NULL}.
324 > */
325 > export function isEmptyPattern(pattern: ParsedPattern | ParsedExpression): pattern is (typeof FALSE | typeof NULL) {
326 if (pattern === FALSE) {
327 return true;
334 return false;
335 }
336 > glob.ts
337 function parsePattern(arg1: string | IRelativePattern, options: IGlobOptions): ParsedStringPattern {
338 if (!arg1) {
390 return wrapRelativePattern(parsedPattern, arg1, internalOptions);
391 }
392 > glob.ts
393 function wrapRelativePattern(parsedPattern: ParsedStringPattern, arg2: string | IRelativePattern, options: IGlobOptionsInternal): ParsedStringPattern {
394 if (typeof arg2 === 'string') {
421 return wrappedPattern;
422 }
423 > glob.ts
424 function trimForExclusions(pattern: string, options: IGlobOptions): string {
425 return options.trimForExclusions && pattern.endsWith('/**') ? pattern.substring(0, pattern.length - 2) : pattern; // dropping **, tailing / is dropped later
426 }
427 > glob.ts
428 > // common pattern: **/*.txt just need endsWith check
429 function trivia1(base: string, pattern: string, options: IGlobOptionsInternal): ParsedStringPattern {
430 return function (path: string, basename?: string) {
432 };
433 }
434 > glob.ts
435 > // common pattern: **/some.txt just need basename check
436 function trivia2(base: string, pattern: string, options: IGlobOptionsInternal): ParsedStringPattern {
437 const slashBase = `/${base}`;
457 return parsedPattern;
458 }
459 > glob.ts
460 > // repetition of common patterns (see above) {**/*.txt,**/*.png}
461 function trivia3(pattern: string, options: IGlobOptionsInternal): ParsedStringPattern {
462 const parsedPatterns = aggregateBasenameMatches(pattern.slice(1, -1)
496 return parsedPattern;
497 }
498 > glob.ts
499 > // common patterns: **/something/else just need endsWith check, something/else just needs and equals check
500 function trivia4and5(targetPath: string, pattern: string, matchPathEnds: boolean, options: IGlobOptionsInternal): ParsedStringPattern {
501 const usingPosixSep = sep === posix.sep;
522 return parsedPattern;
523 }
524 > glob.ts
525 function toRegExp(pattern: string, options: IGlobOptions): ParsedStringPattern {
526 try {
535 }
536 }
537 > glob.ts
538 > /**
539 > * Simplified glob matching. Supports a subset of glob patterns:
540 > * * `*` to match zero or more characters in a path segment
541 > * * `?` to match on one character in a path segment
542 > * * `**` to match any number of path segments, including none
543 > * * `{}` to group conditions (e.g. *.{ts,js} matches all TypeScript and JavaScript files)
544 > * * `[]` to declare a range of characters to match in a path segment (e.g., `example.[0-9]` to match on `example.0`, `example.1`, …)
545 > * * `[!...]` to negate a range of characters to match in a path segment (e.g., `example.[!0-9]` to match on `example.a`, `example.b`, but not `example.0`)
546 > */
547 > export function match(pattern: string | IRelativePattern, path: string, options?: IGlobOptions): boolean;
548 > export function match(expression: IExpression, path: string, options?: IGlobOptions): boolean;
549 > export function match(arg1: string | IExpression | IRelativePattern, path: string, options?: IGlobOptions): boolean {
550 if (!arg1 || typeof path !== 'string') {
551 return false;
554 return parse(arg1, options)(path) as boolean;
555 }
556 > glob.ts
557 > /**
558 > * Simplified glob matching. Supports a subset of glob patterns:
559 > * * `*` to match zero or more characters in a path segment
560 > * * `?` to match on one character in a path segment
561 > * * `**` to match any number of path segments, including none
562 > * * `{}` to group conditions (e.g. *.{ts,js} matches all TypeScript and JavaScript files)
563 > * * `[]` to declare a range of characters to match in a path segment (e.g., `example.[0-9]` to match on `example.0`, `example.1`, …)
564 > * * `[!...]` to negate a range of characters to match in a path segment (e.g., `example.[!0-9]` to match on `example.a`, `example.b`, but not `example.0`)
565 > */
566 > export function parse(pattern: string | IRelativePattern, options?: IGlobOptions): ParsedPattern;
567 > export function parse(expression: IExpression, options?: IGlobOptions): ParsedExpression;
568 > export function parse(arg1: string | IExpression | IRelativePattern, options?: IGlobOptions): ParsedPattern | ParsedExpression;
569 > export function parse(arg1: string | IExpression | IRelativePattern, options: IGlobOptions = {}): ParsedPattern | ParsedExpression {
570 if (!arg1) {
571 return FALSE;
597 return parsedExpression(arg1, options);
598 }
599 > glob.ts
600 > export function isRelativePattern(obj: unknown): obj is IRelativePattern {
601 const rp = obj as IRelativePattern | undefined | null;
602 if (!rp) {
606 return typeof rp.base === 'string' && typeof rp.pattern === 'string';
607 }
608 > glob.ts
609 > export function getBasenameTerms(patternOrExpression: ParsedPattern | ParsedExpression): string[] {
610 return (<ParsedStringPattern>patternOrExpression).allBasenames || [];
611 }
612 > glob.ts
613 > export function getPathTerms(patternOrExpression: ParsedPattern | ParsedExpression): string[] {
614 return (<ParsedStringPattern>patternOrExpression).allPaths || [];
615 }
616 > glob.ts
617 function parsedExpression(expression: IExpression, options: IGlobOptions): ParsedExpression {
618 const parsedPatterns = aggregateBasenameMatches(Object.getOwnPropertyNames(expression)
745 return resultExpression;
746 }
747 > glob.ts
748 function parseExpressionPattern(pattern: string, value: boolean | SiblingClause, options: IGlobOptions): (ParsedStringPattern | ParsedExpressionPattern) {
749 if (value === false) {
786 return parsedPattern;
787 }
788 > glob.ts
789 function aggregateBasenameMatches(parsedPatterns: Array<ParsedStringPattern | ParsedExpressionPattern>, result?: string): Array<ParsedStringPattern | ParsedExpressionPattern> {
790 const basenamePatterns = parsedPatterns.filter(parsedPattern => !!(<ParsedStringPattern>parsedPattern).basenames);
844 return aggregatedPatterns;
845 }
846 > glob.ts
847 > // NOTE: This is not used for actual matching, only for resetting watcher when patterns change.
848 > // That is why it's ok to avoid case-insensitive comparison here.
849 > export function patternsEquals(patternsA: Array<string | IRelativePattern> | undefined, patternsB: Array<string | IRelativePattern> | undefined): boolean {
850 return equals(patternsA, patternsB, (a, b) => {
851 if (typeof a === 'string' && typeof b === 'string') {