Skip to content

Commit

Permalink
Move regex_utils README into docs site.
Browse files Browse the repository at this point in the history
  • Loading branch information
kirkrodrigues committed Jul 19, 2024
1 parent b7eaaa1 commit fd8d10e
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 9 deletions.
1 change: 1 addition & 0 deletions docs/src/dev-guide/components-core/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,7 @@ centos7.4-deps-install
macos12-deps-install
ubuntu-focal-deps-install
ubuntu-jammy-deps-install
regex-utils
:::

[feature-req]: https://github.com/y-scope/clp/issues/new?assignees=&labels=enhancement&template=feature-request.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Regex_utils
# regex_utils library

This library contains useful utilities to handle all regex related tasks.

Expand Down Expand Up @@ -58,20 +58,20 @@ For a detailed description on the options order and usage, see the
### Functionalities
* Wildcards
- Turn `.` into `?`
- Turn `.*` into `*`
- Turn `.+` into `?*`
- E.g. `abc.*def.ghi.+` will get translated to `abc*def?ghi?*`
* Turn `.` into `?`
* Turn `.*` into `*`
* Turn `.+` into `?*`
* E.g. `abc.*def.ghi.+` will get translated to `abc*def?ghi?*`
### Custom configuration
The `RegexToWildcardTranslatorConfig` class objects are currently immutable once instantiated. The
constructor takes the following arguments in order:
* `case_insensitive_wildcard`: to be added later along with the character set translation
implementation.
implementation.
* `add_prefix_suffix_wildcards`: in the absence of regex anchors, add prefix or suffix wildcards so
the query becomes a substring query.
- E.g. `info.*system` gets translated into `*info*system*` which makes the original query a
substring query.
the query becomes a substring query.
* E.g. `info.*system` gets translated into `*info*system*` which makes the original query a
substring query.

0 comments on commit fd8d10e

Please sign in to comment.