GlobFeatures

GlobFeatures = object

Defined in: packages/format-glob/src/dialect.ts:8

Which constructs a glob dialect gives meaning to.

A construct switched off is matched literally, never rejected: that is how EditorConfig and gitignore behave with syntax they do not define, and a pattern file written for one tool must not become an error in another.

Properties

backslashEscape

readonly backslashEscape: boolean

Defined in: packages/format-glob/src/dialect.ts:46

\x — the next character is literal.

---

braceAlternation

readonly braceAlternation: boolean

Defined in: packages/format-glob/src/dialect.ts:34

{a,b} — alternation between literal branches.

---

braceRange

readonly braceRange: boolean

Defined in: packages/format-glob/src/dialect.ts:37

{1..9} — an inclusive integer range.

---

caseSensitive

readonly caseSensitive: boolean

Defined in: packages/format-glob/src/dialect.ts:74

Whether matching is case sensitive.

---

characterClass

readonly characterClass: boolean

Defined in: packages/format-glob/src/dialect.ts:22

[abc], [a-z] — a character class.

---

classNegation

readonly classNegation: "!" | "^" | "both"

Defined in: packages/format-glob/src/dialect.ts:25

Which prefix negates a class. Ignored when characterClass is off.

---

comments

readonly comments: boolean

Defined in: packages/format-glob/src/dialect.ts:65

A leading # makes the whole pattern a comment, which matches nothing.

---

extglob

readonly extglob: boolean

Defined in: packages/format-glob/src/dialect.ts:43

?(a|b), *(a|b), +(a|b), @(a|b), !(a|b) — the ksh extended glob groups bash enables with shopt -s extglob.

---

globstar

readonly globstar: boolean

Defined in: packages/format-glob/src/dialect.ts:16

** — a whole path segment span, including separators.

---

leadingSlashAnchors

readonly leadingSlashAnchors: boolean

Defined in: packages/format-glob/src/dialect.ts:52

A leading / anchors the pattern to the search root rather than matching at any depth.

---

matchBase

readonly matchBase: boolean

Defined in: packages/format-glob/src/dialect.ts:71

A pattern containing no separator is matched against the last path segment rather than against the whole path.

---

patternNegation

readonly patternNegation: boolean

Defined in: packages/format-glob/src/dialect.ts:62

A leading ! inverts the whole pattern’s verdict. Repeated ! toggle, so !!a means a. Unrelated to classNegation, which inverts one character class and nothing else.

---

periodMustBeExplicit

readonly periodMustBeExplicit: boolean

Defined in: packages/format-glob/src/dialect.ts:80

Whether a leading . must be matched by a literal . rather than by a wildcard — POSIX’s hidden-file rule.

---

posixClasses

readonly posixClasses: boolean

Defined in: packages/format-glob/src/dialect.ts:31

[[:alpha:]] — a POSIX class name inside a character class. Ignored when characterClass is off.

---

singleChar

readonly singleChar: boolean

Defined in: packages/format-glob/src/dialect.ts:19

? — exactly one character.

---

starCrossesSeparator

readonly starCrossesSeparator: boolean

Defined in: packages/format-glob/src/dialect.ts:13

* — any run of characters. Always on; starCrossesSeparator says how far.

---

trailingSlashMeansDirectory

readonly trailingSlashMeansDirectory: boolean

Defined in: packages/format-glob/src/dialect.ts:55

A trailing / restricts the match to directories.