aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAkshay Nair <phenax5@gmail.com>2022-01-14 21:23:59 +0530
committerAkshay Nair <phenax5@gmail.com>2022-01-14 21:23:59 +0530
commit4e0f94ea6adeeaa22f8e6729a5d7bd12efe24c3e (patch)
tree913c8886b164aed61614a78ed4c8a2066d0e3b5c
parent950faa740b86af5f264717898f24ae8fb65c036d (diff)
downloadelxr-4e0f94ea6adeeaa22f8e6729a5d7bd12efe24c3e.tar.gz
elxr-4e0f94ea6adeeaa22f8e6729a5d7bd12efe24c3e.zip
docs: adds todo to readme
-rw-r--r--README.md14
-rw-r--r--TODO.md4
2 files changed, 15 insertions, 3 deletions
diff --git a/README.md b/README.md
index 9f9d718..2f767ab 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
# ListExp [ WIP ]
-Regular expression-like syntax for list operations. Nobody asked for this so here it is.
+Regular expression-like syntax for list operations. Toy project experimenting with generalizing regex-like operations to a list.
[![forthebadge](https://forthebadge.com/images/badges/you-didnt-ask-for-this.svg)](https://forthebadge.com)
[![forthebadge](https://forthebadge.com/images/badges/kinda-sfw.svg)](https://forthebadge.com)
@@ -18,6 +18,7 @@ Whitespaces are ignore (except within literals)
* `a|b` => match `a` **or** `b`
* `a*` => Zero or more consecutive instances of pattern `a` in the list
* `a+` => One or more consecutive instances of pattern `a` in the list
+* `a{2, 5}` => Min-Max quantifiers (example matches a more than 2 times but less than 5) [TODO]
* `(\s\T)` => Group (example matches any non-empty string)
* `^a$` => `^` indicates start of list, and `$` indicates end of list [TODO]
* `a,b` => match `a` followed by `b` (next item)
@@ -26,6 +27,17 @@ Whitespaces are ignore (except within literals)
* `/pat/` => Test string values against regex [TODO]
+### TODO
+ - [X] `matchAll` function
+ - [ ] `replaceAll` function
+ - [ ] `match` function
+ - [ ] Named capture groups
+ - [ ] Non-capturing groups
+ - [ ] `{min, max}` quantifiers
+ - [ ] Regular expressions for string items
+ - [ ] Nested list evaluation
+ - [ ] Number comarison
+
### Examples
diff --git a/TODO.md b/TODO.md
index 40f50bc..9a6e393 100644
--- a/TODO.md
+++ b/TODO.md
@@ -3,10 +3,10 @@
## Features
- [X] Eval: Quantifiers (`+` and `*`)
- [X] Eval: Next item/Sequence
- - [ ] Parse: `{2, 5}` quantifiers
+ - [X] Func: matchAll
+ - [ ] `{2, 5}` quantifiers
- [ ] Eval: `^$` start-end
- [ ] Func: replace
- - [X] Func: matchAll
- [ ] Not/Inverse
- [ ] Named capture groups
- [ ] Non-capture groups