Skip to content

Commit

Permalink
update doc
Browse files Browse the repository at this point in the history
  • Loading branch information
Bingran Hu committed Jul 19, 2024
1 parent 9f6b02f commit 30b2b5f
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions docs/src/dev-guide/components-core/regex-utils.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,19 @@ For a detailed description on the options order and usage, see the
* Turn `.*` into `*`
* Turn `.+` into `?*`
* E.g. `abc.*def.ghi.+` will get translated to `abc*def?ghi?*`
* Metacharacter escape sequences
* Append the escaped metacharacters literally to the wildcard output string.
* The list of characters that require escaping is `[\/^$.|?*+(){}`.
* The list of characters that are optional to escape is `],<>-_=!`. Escaping them will not have
any effect (the escape backslash is ignored). This list may be expanded in the future.
* E.g. `a\[\+b\-\_c-_d` will get translated to `a[+b-_c-_d`
* For metacharacters shared by both syntaxes, keep the escape backslashes.
* The list of characters that fall into this category is `*?\`. All wildcard metacharacters are
also regex metacharacters.
* E.g. `a\*b\?c\\d` will get translated to `a\*b\?c\\d` (no change)
* Escape sequences with alphanumeric characters are disallowed.
* E.g. Special utility escape sequences `\Q`, `\E`, `\A` etc. and back references `\1` `\2` etc.
cannot be translated.
### Custom configuration
Expand Down

0 comments on commit 30b2b5f

Please sign in to comment.