File: expr.match.md

package info (click to toggle)
watchman 4.9.0-9
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 9,992 kB
  • sloc: cpp: 27,459; python: 6,538; java: 3,404; php: 3,257; ansic: 2,803; javascript: 1,116; makefile: 671; ruby: 364; sh: 124; xml: 102; lisp: 4
file content (73 lines) | stat: -rw-r--r-- 1,989 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
---
pageid: expr.match
title: match & imatch
layout: docs
section: Expression Terms
permalink: docs/expr/match.html
---

The `match` expression performs a glob-style match against the basename of
the file, evaluating true if the match is successful.

```json
["match", "*.txt"]
```

You may optionally provide a third argument to change the scope of the match
from the basename to the wholename of the file.

```json
["match", "*.txt", "basename"]
["match", "dir/*.txt", "wholename"]
```

### Case sensitivity

`match` is case sensitive; for case insensitive matching use `imatch` instead;
it behaves identically to `match` except that the match is performed ignoring
case.

*Since 2.9.9.*

On systems where the watched root is a case insensitive filesystem (this is the
common case for OS X and Windows), `match` is equivalent to `imatch`.

*Since 4.7.*

You can override the case sensitivity of all name matching operations used
in the query by setting the `case_sensitive` field in your query.

## wildmatch

*Since 3.7.*

The `match` expression has been enhanced as described below.  The
[capability](/watchman/docs/capabilities.html) name associated with this
enhanced functionality is `wildmatch`.

If you want to recursively match all files under a directory, use the `**`
glob operator along with the `wholename` scope:

```json
["match", "src/**/*.java", "wholename"]
```

By default, paths whose names start with `.` are not included. To
change this behavior, you may optionally provide a fourth argument
containing a dictionary of flags:

```json
["match", "*.txt", "basename", {"includedotfiles": true}]
```

By default, backslashes in the pattern escape the next character, so
`\*` matches a literal `*` character. To change this behavior so
backslashes are treated literally, set the `noescape` flag to `true`
in the flags dictionary. (Note that `\\` is a literal `\` in JSON notation):

```json
["match", "*\\*.txt", "filename", {"noescape": true}]
```

matches `a\b.txt`.