// oxlint-disable unicorn/prefer-string-starts-ends-with no-control-regex
// Alchemy modifications are licensed under Apache-2.0.
// This file includes third-party code; see /THIRD_PARTY_LICENSES.md.
//
// TypeScript port of `ignore` (https://github.com/kaelzhang/node-ignore) v7.0.5.
// Copyright (c) 2013 Kael Zhang <i@kael.me>, contributors. MIT License.
function makeArray<T>(subject: T | readonly T[]): T[] {
return Array.isArray(subject) ? [...subject] : [subject as T];
}
const UNDEFINED = undefined;
const EMPTY = "";
const SPACE = " ";
const ESCAPE = "\\";
const REGEX_TEST_BLANK_LINE = /^\s+$/;
const REGEX_INVALID_TRAILING_BACKSLASH = /(?:[^\\]|^)\\$/;
const REGEX_REPLACE_LEADING_EXCAPED_EXCLAMATION = /^\\!/;
const REGEX_REPLACE_LEADING_EXCAPED_HASH = /^\\#/;
const REGEX_SPLITALL_CRLF = /\r?\n/g;
// Invalid:
// - /foo,
// - ./foo,
// - ../foo,
// - .
// - ..
// Valid:
// - .foo
const REGEX_TEST_INVALID_PATH = /^\.{0,2}\/|^\.{1,2}$/;
const REGEX_TEST_TRAILING_SLASH = /\/$/;
const SLASH = "/";
// Do not use ternary expression here, since "istanbul ignore next" is buggy
let TMP_KEY_IGNORE: string | symbol = "node-ignore";
/* istanbul ignore else */
if (typeof Symbol !== "undefined") {
TMP_KEY_IGNORE = Symbol.for("node-ignore");
}
const KEY_IGNORE = TMP_KEY_IGNORE;
const define = <T>(object: object, key: PropertyKey, value: T): T => {
Object.defineProperty(object, key, { value });
return value;
};
const REGEX_REGEXP_RANGE = /([0-z])-([0-z])/g;
const RETURN_FALSE = () => false;
// Sanitize the range of a regular expression
// The cases are complicated, see test cases for details
const sanitizeRange = (range: string): string =>
range.replace(REGEX_REGEXP_RANGE, (match, from, to) =>
from.charCodeAt(0) <= to.charCodeAt(0)
? match
: // Invalid range (out of order) which is ok for gitignore rules but
// fatal for JavaScript regular expression, so eliminate it.
EMPTY,
);
// > An optional `!` or `^` at the start of a class negates it, so that it
// > matches any character not in the set. (gitignore(5), fnmatch(3))
// The leading `^` has already been escaped to `\^` by the metacharacter
// escaper, so we strip the literal `!` or escaped `^` and emit a single
// regex `^` which is the JavaScript negation token.
const negateRange = (range: string): string =>
range.startsWith("!") || range.startsWith("\\^")
? `^${range.slice(range[0] === "!" ? 1 : 2)}`
: range;
// See fixtures #59
const cleanRangeBackSlash = (slashes: string): string => {
const { length } = slashes;
return slashes.slice(0, length - (length % 2));
};
// > If the pattern ends with a slash,
// > it is removed for the purpose of the following description,
// > but it would only find a match with a directory.
// > In other words, foo/ will match a directory foo and paths underneath it,
// > but will not match a regular file or a symbolic link foo
// > (this is consistent with the way how pathspec works in general in Git).
// '`foo/`' will not match regular file '`foo`' or symbolic link '`foo`'
// -> ignore-rules will not deal with it, because it costs extra `fs.stat` call
// you could use option `mark: true` with `glob`
// '`foo/`' should not continue with the '`..`'
type Replacer = (this: string, ...args: any[]) => string;
const REPLACERS: Array<readonly [RegExp, Replacer]> = [
[
// Remove BOM
// TODO:
// Other similar zero-width characters?
/^\uFEFF/,
() => EMPTY,
],
// > Trailing spaces are ignored unless they are quoted with backslash ("\")
[
// (a\ ) -> (a )
// (a ) -> (a)
// (a ) -> (a)
// (a \ ) -> (a )
/((?:\\\\)*?)(\\?\s+)$/,
(_, m1, m2) => m1 + (m2.indexOf("\\") === 0 ? SPACE : EMPTY),
],
// Replace (\ ) with ' '
// (\ ) -> ' '
// (\\ ) -> '\\ '
// (\\\ ) -> '\\ '
[
/(\\+?)\s/g,
(_, m1) => {
const { length } = m1;
return m1.slice(0, length - (length % 2)) + SPACE;
},
],
// Escape metacharacters
// which is written down by users but means special for regular expressions.
// > There are 12 characters with special meanings:
// > - the backslash \,
// > - the caret ^,
// > - the dollar sign $,
// > - the period or dot .,
// > - the vertical bar or pipe symbol |,
// > - the question mark ?,
// > - the asterisk or star *,
// > - the plus sign +,
// > - the opening parenthesis (,
// > - the closing parenthesis ),
// > - and the opening square bracket [,
// > - the opening curly brace {,
// > These special characters are often called "metacharacters".
[/[\\$.|*+(){^]/g, (match) => `\\${match}`],
[
// > a question mark (?) matches a single character
/(?!\\)\?/g,
() => "[^/]",
],
// leading slash
[
// > A leading slash matches the beginning of the pathname.
// > For example, "/*.c" matches "cat-file.c" but not "mozilla-sha1/sha1.c".
// A leading slash matches the beginning of the pathname
/^\//,
() => "^",
],
// replace special metacharacter slash after the leading slash
[/\//g, () => "\\/"],
[
// > A leading "**" followed by a slash means match in all directories.
// > For example, "**/foo" matches file or directory "foo" anywhere,
// > the same as pattern "foo".
// > "**/foo/bar" matches file or directory "bar" anywhere that is directly
// > under directory "foo".
// Notice that the '*'s have been replaced as '\\*'
/^\^*(?:\\\*\\\*\\\/)+/,
// '**/foo' <-> 'foo'
() => "^(?:.*\\/)?",
],
// starting
[
// there will be no leading '/'
// (which has been replaced by section "leading slash")
// If starts with '**', adding a '^' to the regular expression also works
/^(?=[^^])/,
function startingReplacer(this: string) {
// If has a slash `/` at the beginning or middle
return !/\/(?!$)/.test(this)
? // > Prior to 2.22.1
// > If the pattern does not contain a slash /,
// > Git treats it as a shell glob pattern
// Actually, if there is only a trailing slash,
// git also treats it as a shell glob pattern
// After 2.22.1 (compatible but clearer)
// > If there is a separator at the beginning or middle (or both)
// > of the pattern, then the pattern is relative to the directory
// > level of the particular .gitignore file itself.
// > Otherwise the pattern may also match at any level below
// > the .gitignore level.
"(?:^|\\/)"
: // > Otherwise, Git treats the pattern as a shell glob suitable for
// > consumption by fnmatch(3)
"^";
},
],
// two globstars
[
// Use lookahead assertions so that we could match more than one `'/**'`
/\\\/\\\*\\\*(?=\\\/|$)/g,
// Zero, one or several directories
// should not use '*', or it will be replaced by the next replacer
// Check if it is not the last `'/**'`
(_, index, str) =>
index + 6 < str.length
? // case: /**/
// > A slash followed by two consecutive asterisks then a slash matches
// > zero or more directories.
// > For example, "a/**/b" matches "a/b", "a/x/b", "a/x/y/b" and so on.
// '/**/'
"(?:\\/[^\\/]+)*"
: // case: /**
// > A trailing `"/**"` matches everything inside.
// #21: everything inside but it should not include the current folder
"\\/.+",
],
// normal intermediate wildcards
[
// Never replace escaped '*'
// ignore rule '\*' will match the path '*'
// 'abc.*/' -> go
// 'abc.*' -> skip this rule,
// coz trailing single wildcard will be handed by [trailing wildcard]
/(^|[^\\]+)(\\\*)+(?=.+)/g,
// '*.js' matches '.js'
// '*.js' doesn't match 'abc'
(_, p1, p2) => {
// 1.
// > An asterisk "*" matches anything except a slash.
// 2.
// > Other consecutive asterisks are considered regular asterisks
// > and will match according to the previous rules.
const unescaped = p2.replace(/\\\*/g, "[^\\/]*");
return p1 + unescaped;
},
],
[
// unescape, revert step 3 except for back slash
// For example, if a user escape a '\\*',
// after step 3, the result will be '\\\\\\*'
/\\\\\\(?=[$.|*+(){^])/g,
() => ESCAPE,
],
[
// '\\\\' -> '\\'
/\\\\/g,
() => ESCAPE,
],
[
// > The range notation, e.g. [a-zA-Z],
// > can be used to match one of the characters in a range.
// `\` is escaped by step 3
/(\\)?\[([^\]/]*?)(\\*)($|\])/g,
(match, leadEscape, range, endEscape, close) =>
leadEscape === ESCAPE
? // '\\[bar]' -> '\\\\[bar\\]'
`\\[${range}${cleanRangeBackSlash(endEscape)}${close}`
: close === "]"
? endEscape.length % 2 === 0
? // A normal case, and it is a range notation
// '[bar]'
// '[bar\\\\]'
`[${negateRange(sanitizeRange(range))}${endEscape}]`
: // Invalid range notaton
// '[bar\\]' -> '[bar\\\\]'
"[]"
: "[]",
],
// ending
[
// 'js' will not match 'js.'
// 'ab' will not match 'abc'
/(?:[^*])$/,
// WTF!
// https://git-scm.com/docs/gitignore
// changes in [2.22.1](https://git-scm.com/docs/gitignore/2.22.1)
// which re-fixes #24, #38
// > If there is a separator at the end of the pattern then the pattern
// > will only match directories, otherwise the pattern can match both
// > files and directories.
// 'js*' will not match 'a.js'
// 'js/' will not match 'a.js'
// 'js' will match 'a.js' and 'a.js/'
(match) =>
/\/$/.test(match)
? // foo/ will not match 'foo'
`${match}
.repos/alchemy-effect/packages/node-utils/src/ignore.ts at main · sailfork/t3code-github · Sailfork
: // foo matches 'foo' and 'foo/'
`${match}(?=$|\\/$)`,
],
];
const REGEX_REPLACE_TRAILING_WILDCARD = /(^|\\\/)?\\\*$/;
const MODE_IGNORE = "regex";
const MODE_CHECK_IGNORE = "checkRegex";
type MatcherMode = typeof MODE_IGNORE | typeof MODE_CHECK_IGNORE;
const TRAILING_WILD_CARD_REPLACERS: Record<MatcherMode, Replacer> = {
[MODE_IGNORE](_, p1: string | undefined) {
const prefix = p1
? // '\^':
// '/*' does not match EMPTY
// '/*' does not match everything
// '\\\/':
// 'abc/*' does not match 'abc/'
`${p1}[^/]+`
: // 'a*' matches 'a'
// 'a*' matches 'aa'
"[^/]*";
return `${prefix}(?=$|\\/$)`;
},
[MODE_CHECK_IGNORE](_, p1: string | undefined) {
// When doing `git check-ignore`
const prefix = p1
? // '\\\/':
// 'abc/*' DOES match 'abc/' !
`${p1}[^/]*`
: // 'a*' matches 'a'
// 'a*' matches 'aa'
"[^/]*";
return `${prefix}(?=$|\\/$)`;
},
};
// @param {pattern}
const makeRegexPrefix = (pattern: string): string =>
REPLACERS.reduce(
(prev, [matcher, replacer]) => prev.replace(matcher, replacer.bind(pattern)),
pattern,
);
const isString = (subject: unknown): subject is string => typeof subject === "string";
// > A blank line matches no files, so it can serve as a separator for readability.
const checkPattern = (pattern: string): boolean =>
Boolean(
pattern &&
!REGEX_TEST_BLANK_LINE.test(pattern) &&
!REGEX_INVALID_TRAILING_BACKSLASH.test(pattern) &&
// > A line starting with # serves as a comment.
pattern.indexOf("#") !== 0,
);
const splitPattern = (pattern: string): string[] =>
pattern.split(REGEX_SPLITALL_CRLF).filter(Boolean);
class IgnoreRule {
readonly pattern: string;
readonly mark: string | undefined;
readonly negative: boolean;
readonly body!: string;
readonly ignoreCase!: boolean;
readonly regexPrefix!: string;
private _regex?: RegExp;
private _checkRegex?: RegExp;
constructor(
pattern: string,
mark: string | undefined,
body: string,
ignoreCase: boolean,
negative: boolean,
prefix: string,
) {
this.pattern = pattern;
this.mark = mark;
this.negative = negative;
define(this, "body", body);
define(this, "ignoreCase", ignoreCase);
define(this, "regexPrefix", prefix);
}
get regex() {
const key = `_${MODE_IGNORE}` as const;
if (this[key]) {
return this[key];
}
return this._make(MODE_IGNORE, key);
}
get checkRegex() {
const key = `_${MODE_CHECK_IGNORE}` as const;
if (this[key]) {
return this[key];
}
return this._make(MODE_CHECK_IGNORE, key);
}
_make(mode: MatcherMode, key: "_regex" | "_checkRegex"): RegExp {
const str = this.regexPrefix.replace(
REGEX_REPLACE_TRAILING_WILDCARD,
// It does not need to bind pattern
TRAILING_WILD_CARD_REPLACERS[mode],
);
const regex = this.ignoreCase ? new RegExp(str, "i") : new RegExp(str);
return define(this, key, regex);
}
}
const createRule = ({ pattern, mark }: PatternParams, ignoreCase: boolean): IgnoreRule => {
let negative = false;
let body = pattern;
// > An optional prefix "!" which negates the pattern;
if (body.indexOf("!") === 0) {
negative = true;
body = body.substr(1);
}
body = body
// > Put a backslash ("\") in front of the first "!" for patterns that
// > begin with a literal "!", for example, `"\!important!.txt"`.
.replace(REGEX_REPLACE_LEADING_EXCAPED_EXCLAMATION, "!")
// > Put a backslash ("\") in front of the first hash for patterns that
// > begin with a hash.
.replace(REGEX_REPLACE_LEADING_EXCAPED_HASH, "#");
const regexPrefix = makeRegexPrefix(body);
return new IgnoreRule(pattern, mark, body, ignoreCase, negative, regexPrefix);
};
class RuleManager {
private readonly _ignoreCase: boolean;
_rules: IgnoreRule[] = [];
private _added = false;
constructor(ignoreCase: boolean) {
this._ignoreCase = ignoreCase;
}
_add(pattern: string | Ignore | PatternParams): void {
// #32
const ignorePattern = pattern as Ignore & Record<PropertyKey, unknown>;
if (pattern && ignorePattern[KEY_IGNORE]) {
this._rules = this._rules.concat(ignorePattern._rules._rules);
this._added = true;
return;
}
if (isString(pattern)) {
pattern = {
pattern,
};
}
const patternParams = pattern as PatternParams;
if (checkPattern(patternParams.pattern)) {
const rule = createRule(patternParams, this._ignoreCase);
this._added = true;
this._rules.push(rule);
}
}
// @param {Array<string> | string | Ignore} pattern
add(pattern: string | Ignore | PatternParams | readonly (string | Ignore)[]): boolean {
this._added = false;
const patterns: readonly (string | Ignore | PatternParams)[] = isString(pattern)
? splitPattern(pattern)
: Array.isArray(pattern)
? pattern
: [pattern as Ignore | PatternParams];
patterns.forEach((p) => this._add(p));
return this._added;
}
// Test one single path without recursively checking parent directories
//
// - checkUnignored `boolean` whether should check if the path is unignored,
// setting `checkUnignored` to `false` could reduce additional
// path matching.
// - check `string` either `MODE_IGNORE` or `MODE_CHECK_IGNORE`
// @returns {TestResult} true if a file is ignored
test(path: string, checkUnignored: boolean, mode: MatcherMode): IgnoreTestResult {
let ignored = false;
let unignored = false;
let matchedRule: IgnoreRule | undefined;
this._rules.forEach((rule) => {
const { negative } = rule;
// | ignored : unignored
// -------- | ---------------------------------------
// negative | 0:0 | 0:1 | 1:0 | 1:1
// -------- | ------- | ------- | ------- | --------
// 0 | TEST | TEST | SKIP | X
// 1 | TESTIF | SKIP | TEST | X
// - SKIP: always skip
// - TEST: always test
// - TESTIF: only test if checkUnignored
// - X: that never happen
if (
(unignored === negative && ignored !== unignored) ||
(negative && !ignored && !unignored && !checkUnignored)
) {
return;
}
const matched = rule[mode].test(path);
if (!matched) {
return;
}
ignored = !negative;
unignored = negative;
matchedRule = negative ? UNDEFINED : rule;
});
const ret: IgnoreTestResult = {
ignored,
unignored,
};
if (matchedRule) {
ret.rule = matchedRule;
}
return ret;
}
}
type ErrorConstructor = new (message: string) => Error;
type InvalidPathHandler = (message: string, constructor: ErrorConstructor) => boolean;
const throwError: InvalidPathHandler = (message, Ctor) => {
throw new Ctor(message);
};
interface CheckPath {
(path: unknown, originalPath: string, doThrow: InvalidPathHandler): boolean;
isNotRelative: (path: string) => boolean;
convert: (path: string) => string;
}
const checkPath: CheckPath = (path, originalPath, doThrow) => {
if (!isString(path)) {
return doThrow(`path must be a string, but got \`${originalPath}\``, TypeError);
}
// We don't know if we should ignore EMPTY, so throw
if (!path) {
return doThrow(`path must not be empty`, TypeError);
}
// Check if it is a relative path
if (checkPath.isNotRelative(path)) {
const r = "`path.relative()`d";
return doThrow(`path should be a ${r} string, but got "${originalPath}"`, RangeError);
}
return true;
};
const isNotRelative = (path: string): boolean => REGEX_TEST_INVALID_PATH.test(path);
checkPath.isNotRelative = isNotRelative;
// On windows, the following function will be replaced
/* istanbul ignore next */
checkPath.convert = (path) => path;
class Ignore {
readonly [KEY_IGNORE]?: true;
readonly _rules: RuleManager;
private readonly _strictPathCheck: boolean;
private _ignoreCache!: Record<string, IgnoreTestResult>;
private _testCache!: Record<string, IgnoreTestResult>;
constructor({
ignorecase = true,
ignoreCase = ignorecase,
allowRelativePaths = false,
}: IgnoreOptions = {}) {
define(this, KEY_IGNORE, true);
this._rules = new RuleManager(ignoreCase);
this._strictPathCheck = !allowRelativePaths;
this._initCache();
}
_initCache(): void {
// A cache for the result of `.ignores()`
this._ignoreCache = Object.create(null);
// A cache for the result of `.test()`
this._testCache = Object.create(null);
}
add(pattern: string | Ignore | readonly (string | Ignore)[] | PatternParams): this {
if (this._rules.add(pattern)) {
// Some rules have just added to the ignore,
// making the behavior changed,
// so we need to re-initialize the result cache
this._initCache();
}
return this;
}
// legacy
addPattern(pattern: string | readonly string[]): this {
return this.add(pattern);
}
// @returns {TestResult}
_test(
originalPath: string,
cache: Record<string, IgnoreTestResult>,
checkUnignored: boolean,
slices?: string[],
): IgnoreTestResult {
const path =
originalPath &&
// Supports nullable path
checkPath.convert(originalPath);
checkPath(path, originalPath, this._strictPathCheck ? throwError : RETURN_FALSE);
return this._t(path, cache, checkUnignored, slices);
}
checkIgnore(path: string): IgnoreTestResult {
// If the path doest not end with a slash, `.ignores()` is much equivalent
// to `git check-ignore`
if (!REGEX_TEST_TRAILING_SLASH.test(path)) {
return this.test(path);
}
const slices = path.split(SLASH).filter(Boolean);
slices.pop();
if (slices.length) {
const parent = this._t(slices.join(SLASH) + SLASH, this._testCache, true, slices);
if (parent.ignored) {
return parent;
}
}
return this._rules.test(path, false, MODE_CHECK_IGNORE);
}
_t(
// The path to be tested
path: string,
// The cache for the result of a certain checking
cache: Record<string, IgnoreTestResult>,
// Whether should check if the path is unignored
checkUnignored: boolean,
// The path slices
slices?: string[],
): IgnoreTestResult {
if (path in cache) {
return cache[path];
}
if (!slices) {
// path/to/a.js
// ['path', 'to', 'a.js']
slices = path.split(SLASH).filter(Boolean);
}
slices.pop();
// If the path has no parent directory, just test it
if (!slices.length) {
return (cache[path] = this._rules.test(path, checkUnignored, MODE_IGNORE));
}
const parent = this._t(slices.join(SLASH) + SLASH, cache, checkUnignored, slices);
// If the path contains a parent directory, check the parent first
return (cache[path] = parent.ignored
? // > It is not possible to re-include a file if a parent directory of
// > that file is excluded.
parent
: this._rules.test(path, checkUnignored, MODE_IGNORE));
}
ignores(path: string): boolean {
return this._test(path, this._ignoreCache, false).ignored;
}
// Alchemy addition: match one path against the rules without checking its
// parent directories, so callers can start the parent walk below a
// boundary (e.g. a working directory inside an ignored folder).
matches(path: string): IgnoreTestResult {
return this._rules.test(checkPath.convert(path), true, MODE_IGNORE);
}
createFilter(): (path: string) => boolean {
return (path: string) => !this.ignores(path);
}
filter(paths: readonly string[]): string[] {
return makeArray(paths).filter(this.createFilter());
}
// @returns {TestResult}
test(path: string): IgnoreTestResult {
return this._test(path, this._testCache, true);
}
}
const factory = (options?: IgnoreOptions): Ignore => new Ignore(options);
const isPathValid = (path: string): boolean =>
checkPath(path && checkPath.convert(path), path, RETURN_FALSE);
const setupWindows = () => {
const makePosix = (str: string): string =>
/^\\\\\?\\/.test(str) || /["<>|\u0000-\u001F]+/u.test(str) ? str : str.replace(/\\/g, "/");
checkPath.convert = makePosix;
// 'C:\\foo' <- 'C:\\foo' has been converted to 'C:/'
// 'd:\\foo'
const REGEX_TEST_WINDOWS_PATH_ABSOLUTE = /^[a-z]:\//i;
checkPath.isNotRelative = (path: string) =>
REGEX_TEST_WINDOWS_PATH_ABSOLUTE.test(path) || isNotRelative(path);
};
// Windows
// --------------------------------------------------------------
/* istanbul ignore next */
if (
// Detect `process` so that it can run in browsers.
typeof process !== "undefined" &&
process.platform === "win32"
) {
setupWindows();
}
// ES module exports (upstream uses `module.exports`). Upstream also exposes
// `setupWindows` via `Symbol.for("setupWindows")` for its own test suite; we
// drop that hook since it's unused.
export default factory as unknown as (options?: IgnoreOptions) => IgnoreInstance;
export { Ignore, isPathValid };
// --- Type declarations -----------------------------------------------------
// (not part of the verbatim upstream source; mirrors upstream `index.d.ts`)
type Pathname = string;
interface PatternParams {
pattern: string;
mark?: string;
}
interface IgnoreTestResult {
ignored: boolean;
unignored: boolean;
rule?: IgnoreRule;
}
export interface IgnoreOptions {
ignorecase?: boolean;
/** For compatibility. */
ignoreCase?: boolean;
allowRelativePaths?: boolean;
}
export interface IgnoreInstance {
add(
patterns: string | IgnoreInstance | readonly (string | IgnoreInstance)[] | PatternParams,
): this;
filter(pathnames: readonly Pathname[]): Pathname[];
createFilter(): (pathname: Pathname) => boolean;
ignores(pathname: Pathname): boolean;
/** Alchemy addition: match one path without checking parent directories. */
matches(pathname: Pathname): {
ignored: boolean;
unignored: boolean;
};
test(pathname: Pathname): {
ignored: boolean;
unignored: boolean;
rule?: { pattern: string; mark?: string; negative: boolean };
};
checkIgnore(pathname: Pathname): {
ignored: boolean;
unignored: boolean;
rule?: { pattern: string; mark?: string; negative: boolean };
};
}
.repos/alchemy-effect/packages/node-utils/src/ignore.ts at main · sailfork/t3code-github · Sailfork
\n : // foo matches 'foo' and 'foo/'\n `${match}(?=$|\\\\/$)`,\n ],\n];\n\nconst REGEX_REPLACE_TRAILING_WILDCARD = /(^|\\\\\\/)?\\\\\\*$/;\nconst MODE_IGNORE = \"regex\";\nconst MODE_CHECK_IGNORE = \"checkRegex\";\n\ntype MatcherMode = typeof MODE_IGNORE | typeof MODE_CHECK_IGNORE;\n\nconst TRAILING_WILD_CARD_REPLACERS: Record\u003cMatcherMode, Replacer> = {\n [MODE_IGNORE](_, p1: string | undefined) {\n const prefix = p1\n ? // '\\^':\n // '/*' does not match EMPTY\n // '/*' does not match everything\n\n // '\\\\\\/':\n // 'abc/*' does not match 'abc/'\n `${p1}[^/]+`\n : // 'a*' matches 'a'\n // 'a*' matches 'aa'\n \"[^/]*\";\n\n return `${prefix}(?=$|\\\\/$)`;\n },\n\n [MODE_CHECK_IGNORE](_, p1: string | undefined) {\n // When doing `git check-ignore`\n const prefix = p1\n ? // '\\\\\\/':\n // 'abc/*' DOES match 'abc/' !\n `${p1}[^/]*`\n : // 'a*' matches 'a'\n // 'a*' matches 'aa'\n \"[^/]*\";\n\n return `${prefix}(?=$|\\\\/$)`;\n },\n};\n\n// @param {pattern}\nconst makeRegexPrefix = (pattern: string): string =>\n REPLACERS.reduce(\n (prev, [matcher, replacer]) => prev.replace(matcher, replacer.bind(pattern)),\n pattern,\n );\n\nconst isString = (subject: unknown): subject is string => typeof subject === \"string\";\n\n// > A blank line matches no files, so it can serve as a separator for readability.\nconst checkPattern = (pattern: string): boolean =>\n Boolean(\n pattern &&\n !REGEX_TEST_BLANK_LINE.test(pattern) &&\n !REGEX_INVALID_TRAILING_BACKSLASH.test(pattern) &&\n // > A line starting with # serves as a comment.\n pattern.indexOf(\"#\") !== 0,\n );\n\nconst splitPattern = (pattern: string): string[] =>\n pattern.split(REGEX_SPLITALL_CRLF).filter(Boolean);\n\nclass IgnoreRule {\n readonly pattern: string;\n readonly mark: string | undefined;\n readonly negative: boolean;\n readonly body!: string;\n readonly ignoreCase!: boolean;\n readonly regexPrefix!: string;\n private _regex?: RegExp;\n private _checkRegex?: RegExp;\n\n constructor(\n pattern: string,\n mark: string | undefined,\n body: string,\n ignoreCase: boolean,\n negative: boolean,\n prefix: string,\n ) {\n this.pattern = pattern;\n this.mark = mark;\n this.negative = negative;\n\n define(this, \"body\", body);\n define(this, \"ignoreCase\", ignoreCase);\n define(this, \"regexPrefix\", prefix);\n }\n\n get regex() {\n const key = `_${MODE_IGNORE}` as const;\n\n if (this[key]) {\n return this[key];\n }\n\n return this._make(MODE_IGNORE, key);\n }\n\n get checkRegex() {\n const key = `_${MODE_CHECK_IGNORE}` as const;\n\n if (this[key]) {\n return this[key];\n }\n\n return this._make(MODE_CHECK_IGNORE, key);\n }\n\n _make(mode: MatcherMode, key: \"_regex\" | \"_checkRegex\"): RegExp {\n const str = this.regexPrefix.replace(\n REGEX_REPLACE_TRAILING_WILDCARD,\n\n // It does not need to bind pattern\n TRAILING_WILD_CARD_REPLACERS[mode],\n );\n\n const regex = this.ignoreCase ? new RegExp(str, \"i\") : new RegExp(str);\n\n return define(this, key, regex);\n }\n}\n\nconst createRule = ({ pattern, mark }: PatternParams, ignoreCase: boolean): IgnoreRule => {\n let negative = false;\n let body = pattern;\n\n // > An optional prefix \"!\" which negates the pattern;\n if (body.indexOf(\"!\") === 0) {\n negative = true;\n body = body.substr(1);\n }\n\n body = body\n // > Put a backslash (\"\\\") in front of the first \"!\" for patterns that\n // > begin with a literal \"!\", for example, `\"\\!important!.txt\"`.\n .replace(REGEX_REPLACE_LEADING_EXCAPED_EXCLAMATION, \"!\")\n // > Put a backslash (\"\\\") in front of the first hash for patterns that\n // > begin with a hash.\n .replace(REGEX_REPLACE_LEADING_EXCAPED_HASH, \"#\");\n\n const regexPrefix = makeRegexPrefix(body);\n\n return new IgnoreRule(pattern, mark, body, ignoreCase, negative, regexPrefix);\n};\n\nclass RuleManager {\n private readonly _ignoreCase: boolean;\n _rules: IgnoreRule[] = [];\n private _added = false;\n\n constructor(ignoreCase: boolean) {\n this._ignoreCase = ignoreCase;\n }\n\n _add(pattern: string | Ignore | PatternParams): void {\n // #32\n const ignorePattern = pattern as Ignore & Record\u003cPropertyKey, unknown>;\n if (pattern && ignorePattern[KEY_IGNORE]) {\n this._rules = this._rules.concat(ignorePattern._rules._rules);\n this._added = true;\n return;\n }\n\n if (isString(pattern)) {\n pattern = {\n pattern,\n };\n }\n\n const patternParams = pattern as PatternParams;\n if (checkPattern(patternParams.pattern)) {\n const rule = createRule(patternParams, this._ignoreCase);\n this._added = true;\n this._rules.push(rule);\n }\n }\n\n // @param {Array\u003cstring> | string | Ignore} pattern\n add(pattern: string | Ignore | PatternParams | readonly (string | Ignore)[]): boolean {\n this._added = false;\n\n const patterns: readonly (string | Ignore | PatternParams)[] = isString(pattern)\n ? splitPattern(pattern)\n : Array.isArray(pattern)\n ? pattern\n : [pattern as Ignore | PatternParams];\n patterns.forEach((p) => this._add(p));\n\n return this._added;\n }\n\n // Test one single path without recursively checking parent directories\n //\n // - checkUnignored `boolean` whether should check if the path is unignored,\n // setting `checkUnignored` to `false` could reduce additional\n // path matching.\n // - check `string` either `MODE_IGNORE` or `MODE_CHECK_IGNORE`\n\n // @returns {TestResult} true if a file is ignored\n test(path: string, checkUnignored: boolean, mode: MatcherMode): IgnoreTestResult {\n let ignored = false;\n let unignored = false;\n let matchedRule: IgnoreRule | undefined;\n\n this._rules.forEach((rule) => {\n const { negative } = rule;\n\n // | ignored : unignored\n // -------- | ---------------------------------------\n // negative | 0:0 | 0:1 | 1:0 | 1:1\n // -------- | ------- | ------- | ------- | --------\n // 0 | TEST | TEST | SKIP | X\n // 1 | TESTIF | SKIP | TEST | X\n\n // - SKIP: always skip\n // - TEST: always test\n // - TESTIF: only test if checkUnignored\n // - X: that never happen\n if (\n (unignored === negative && ignored !== unignored) ||\n (negative && !ignored && !unignored && !checkUnignored)\n ) {\n return;\n }\n\n const matched = rule[mode].test(path);\n\n if (!matched) {\n return;\n }\n\n ignored = !negative;\n unignored = negative;\n\n matchedRule = negative ? UNDEFINED : rule;\n });\n\n const ret: IgnoreTestResult = {\n ignored,\n unignored,\n };\n\n if (matchedRule) {\n ret.rule = matchedRule;\n }\n\n return ret;\n }\n}\n\ntype ErrorConstructor = new (message: string) => Error;\ntype InvalidPathHandler = (message: string, constructor: ErrorConstructor) => boolean;\n\nconst throwError: InvalidPathHandler = (message, Ctor) => {\n throw new Ctor(message);\n};\n\ninterface CheckPath {\n (path: unknown, originalPath: string, doThrow: InvalidPathHandler): boolean;\n isNotRelative: (path: string) => boolean;\n convert: (path: string) => string;\n}\n\nconst checkPath: CheckPath = (path, originalPath, doThrow) => {\n if (!isString(path)) {\n return doThrow(`path must be a string, but got \\`${originalPath}\\``, TypeError);\n }\n\n // We don't know if we should ignore EMPTY, so throw\n if (!path) {\n return doThrow(`path must not be empty`, TypeError);\n }\n\n // Check if it is a relative path\n if (checkPath.isNotRelative(path)) {\n const r = \"`path.relative()`d\";\n return doThrow(`path should be a ${r} string, but got \"${originalPath}\"`, RangeError);\n }\n\n return true;\n};\n\nconst isNotRelative = (path: string): boolean => REGEX_TEST_INVALID_PATH.test(path);\n\ncheckPath.isNotRelative = isNotRelative;\n\n// On windows, the following function will be replaced\n/* istanbul ignore next */\ncheckPath.convert = (path) => path;\n\nclass Ignore {\n readonly [KEY_IGNORE]?: true;\n readonly _rules: RuleManager;\n private readonly _strictPathCheck: boolean;\n private _ignoreCache!: Record\u003cstring, IgnoreTestResult>;\n private _testCache!: Record\u003cstring, IgnoreTestResult>;\n\n constructor({\n ignorecase = true,\n ignoreCase = ignorecase,\n allowRelativePaths = false,\n }: IgnoreOptions = {}) {\n define(this, KEY_IGNORE, true);\n\n this._rules = new RuleManager(ignoreCase);\n this._strictPathCheck = !allowRelativePaths;\n this._initCache();\n }\n\n _initCache(): void {\n // A cache for the result of `.ignores()`\n this._ignoreCache = Object.create(null);\n\n // A cache for the result of `.test()`\n this._testCache = Object.create(null);\n }\n\n add(pattern: string | Ignore | readonly (string | Ignore)[] | PatternParams): this {\n if (this._rules.add(pattern)) {\n // Some rules have just added to the ignore,\n // making the behavior changed,\n // so we need to re-initialize the result cache\n this._initCache();\n }\n\n return this;\n }\n\n // legacy\n addPattern(pattern: string | readonly string[]): this {\n return this.add(pattern);\n }\n\n // @returns {TestResult}\n _test(\n originalPath: string,\n cache: Record\u003cstring, IgnoreTestResult>,\n checkUnignored: boolean,\n slices?: string[],\n ): IgnoreTestResult {\n const path =\n originalPath &&\n // Supports nullable path\n checkPath.convert(originalPath);\n\n checkPath(path, originalPath, this._strictPathCheck ? throwError : RETURN_FALSE);\n\n return this._t(path, cache, checkUnignored, slices);\n }\n\n checkIgnore(path: string): IgnoreTestResult {\n // If the path doest not end with a slash, `.ignores()` is much equivalent\n // to `git check-ignore`\n if (!REGEX_TEST_TRAILING_SLASH.test(path)) {\n return this.test(path);\n }\n\n const slices = path.split(SLASH).filter(Boolean);\n slices.pop();\n\n if (slices.length) {\n const parent = this._t(slices.join(SLASH) + SLASH, this._testCache, true, slices);\n\n if (parent.ignored) {\n return parent;\n }\n }\n\n return this._rules.test(path, false, MODE_CHECK_IGNORE);\n }\n\n _t(\n // The path to be tested\n path: string,\n\n // The cache for the result of a certain checking\n cache: Record\u003cstring, IgnoreTestResult>,\n\n // Whether should check if the path is unignored\n checkUnignored: boolean,\n\n // The path slices\n slices?: string[],\n ): IgnoreTestResult {\n if (path in cache) {\n return cache[path];\n }\n\n if (!slices) {\n // path/to/a.js\n // ['path', 'to', 'a.js']\n slices = path.split(SLASH).filter(Boolean);\n }\n\n slices.pop();\n\n // If the path has no parent directory, just test it\n if (!slices.length) {\n return (cache[path] = this._rules.test(path, checkUnignored, MODE_IGNORE));\n }\n\n const parent = this._t(slices.join(SLASH) + SLASH, cache, checkUnignored, slices);\n\n // If the path contains a parent directory, check the parent first\n return (cache[path] = parent.ignored\n ? // > It is not possible to re-include a file if a parent directory of\n // > that file is excluded.\n parent\n : this._rules.test(path, checkUnignored, MODE_IGNORE));\n }\n\n ignores(path: string): boolean {\n return this._test(path, this._ignoreCache, false).ignored;\n }\n\n // Alchemy addition: match one path against the rules without checking its\n // parent directories, so callers can start the parent walk below a\n // boundary (e.g. a working directory inside an ignored folder).\n matches(path: string): IgnoreTestResult {\n return this._rules.test(checkPath.convert(path), true, MODE_IGNORE);\n }\n\n createFilter(): (path: string) => boolean {\n return (path: string) => !this.ignores(path);\n }\n\n filter(paths: readonly string[]): string[] {\n return makeArray(paths).filter(this.createFilter());\n }\n\n // @returns {TestResult}\n test(path: string): IgnoreTestResult {\n return this._test(path, this._testCache, true);\n }\n}\n\nconst factory = (options?: IgnoreOptions): Ignore => new Ignore(options);\n\nconst isPathValid = (path: string): boolean =>\n checkPath(path && checkPath.convert(path), path, RETURN_FALSE);\n\nconst setupWindows = () => {\n const makePosix = (str: string): string =>\n /^\\\\\\\\\\?\\\\/.test(str) || /[\"\u003c>|\\u0000-\\u001F]+/u.test(str) ? str : str.replace(/\\\\/g, \"/\");\n\n checkPath.convert = makePosix;\n\n // 'C:\\\\foo' \u003c- 'C:\\\\foo' has been converted to 'C:/'\n // 'd:\\\\foo'\n const REGEX_TEST_WINDOWS_PATH_ABSOLUTE = /^[a-z]:\\//i;\n checkPath.isNotRelative = (path: string) =>\n REGEX_TEST_WINDOWS_PATH_ABSOLUTE.test(path) || isNotRelative(path);\n};\n\n// Windows\n// --------------------------------------------------------------\n/* istanbul ignore next */\nif (\n // Detect `process` so that it can run in browsers.\n typeof process !== \"undefined\" &&\n process.platform === \"win32\"\n) {\n setupWindows();\n}\n\n// ES module exports (upstream uses `module.exports`). Upstream also exposes\n// `setupWindows` via `Symbol.for(\"setupWindows\")` for its own test suite; we\n// drop that hook since it's unused.\n\nexport default factory as unknown as (options?: IgnoreOptions) => IgnoreInstance;\nexport { Ignore, isPathValid };\n\n// --- Type declarations -----------------------------------------------------\n// (not part of the verbatim upstream source; mirrors upstream `index.d.ts`)\n\ntype Pathname = string;\n\ninterface PatternParams {\n pattern: string;\n mark?: string;\n}\n\ninterface IgnoreTestResult {\n ignored: boolean;\n unignored: boolean;\n rule?: IgnoreRule;\n}\n\nexport interface IgnoreOptions {\n ignorecase?: boolean;\n /** For compatibility. */\n ignoreCase?: boolean;\n allowRelativePaths?: boolean;\n}\n\nexport interface IgnoreInstance {\n add(\n patterns: string | IgnoreInstance | readonly (string | IgnoreInstance)[] | PatternParams,\n ): this;\n filter(pathnames: readonly Pathname[]): Pathname[];\n createFilter(): (pathname: Pathname) => boolean;\n ignores(pathname: Pathname): boolean;\n /** Alchemy addition: match one path without checking parent directories. */\n matches(pathname: Pathname): {\n ignored: boolean;\n unignored: boolean;\n };\n test(pathname: Pathname): {\n ignored: boolean;\n unignored: boolean;\n rule?: { pattern: string; mark?: string; negative: boolean };\n };\n checkIgnore(pathname: Pathname): {\n ignored: boolean;\n unignored: boolean;\n rule?: { pattern: string; mark?: string; negative: boolean };\n };\n}\n","preview":null,"history":null,"version":"615ee42411a8c0cad8c153843a0152db7cb15ed1"},"/_session?shell=1":null}