feat(parcom): init #79
Draft
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
pskfyi
force-pushed
the
init-parcom
branch
3 times, most recently
from
99f646d to
e01a2a3
Compare
AustinArey
previously approved these changes
May 20, 2023
|
Hey thanks! This is still in draft - please don't feel the need to review. Of course you're free to look and weigh in if you choose. Just know that it may radically change out from under you. |
This was referenced May 23, 2023
Merged
Merged
pskfyi
added a commit
that referenced
this pull request
May 23, 2023
…}`; docs This refactor brings this helper type in line with [the original inspiration](https://twitter.com/mattpocockuk/status/1622730173446557697). During #79 I encountered situations where the `& {}` was necessary to coax the compiler into untangling complex types. I also learned that the `Record`-based type constraint was unnecessary and that it has uses beyond just handling intersections, so I opted to fully implement the original helper except with a shorter name. I also took this opportunity to add a readme entry.
pskfyi
added a commit
that referenced
this pull request
May 23, 2023
…}`; docs This refactor brings this helper type in line with [the original inspiration](https://twitter.com/mattpocockuk/status/1622730173446557697). During #79 I encountered situations where the `& {}` was necessary to coax the compiler into untangling complex types. I also learned that the `Record`-based type constraint was unnecessary and that it has uses beyond just handling intersections, so I opted to fully implement the original helper except with a shorter name. I also took this opportunity to add a readme entry.
Merged
pskfyi
added a commit
that referenced
this pull request
May 26, 2023
…; docs This refactor brings this helper type in line with [the original inspiration](https://twitter.com/mattpocockuk/status/1622730173446557697). During #79 I encountered situations where the `& {}` was necessary to coax the compiler into untangling complex types. I also learned that the `Record`-based type constraint was unnecessary and that it has uses beyond just handling intersections, so I opted to fully implement the original helper except with a shorter name. I also took this opportunity to add a readme entry.
AustinArey
pushed a commit
that referenced
this pull request
May 26, 2023
…; docs This refactor brings this helper type in line with [the original inspiration](https://twitter.com/mattpocockuk/status/1622730173446557697). During #79 I encountered situations where the `& {}` was necessary to coax the compiler into untangling complex types. I also learned that the `Record`-based type constraint was unnecessary and that it has uses beyond just handling intersections, so I opted to fully implement the original helper except with a shorter name. I also took this opportunity to add a readme entry.
pskfyi
force-pushed
the
cursor
branch
2 times, most recently
from
3285c61 to
d6ab735
Compare
pskfyi
force-pushed
the
init-parcom
branch
3 times, most recently
from
d0ee007 to
cb1bc3c
Compare
[Parser combinator](https://en.wikipedia.org/wiki/Parser_combinator) libraries provide composable parsers used for constructing more complex parsers. This first draft is robust enough for simple DSLs. Notably it does not implement backtracking or a chain combinator, which would allow for more advanced branching. However the TS implementation is very powerful, capable of inferring the return types from complex parsers without explicit compiler hints in userland. - The base `Parser` class handles core functionality like `.fallback()`, `into()`, `.not()`, `.then()`, `.optional`, `.ignore`, `.zeroOrMore`, and `.oneOrMore`. - `StringParser` with shorthand factory `string()` provides a specialized `Parser` with string-specific `.split()`, `.trim`, `.trimStart`, and `.trimEnd`. - `ArrayParser` with shorthand factory `sequence()` provides a specialized `Parser` with array-specific `.flat`, `.item()`, `.items()`, `.join()`, and `.toObject()`. - `RegExpParser` with shorthand factory `regexp()` provides a specialized `Parser` with RegExp-specific `.match`, `.group()`, `.groups()`, and `.or()`. - `any()` composes multiple parsers into one that matches the first success. - Common helpers `whitespace`, `blankLink`, `inlineString`, `multilineString`, and `end` are provided, also exported under `string` (ex. `string.inline`, `string.whitespace`) for convenience.
|
Using this PR as a workplace to get the last bits of this organized. A new PR will be opened when it's ready, and this will be closed. The new branch is |
|
All checklist items completed in #107 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
TODO:
whitespace)@examples to all functionsArrayParser&sequence()StringParser&string()RegexParser®ex()CursorAddTextandTextCursor#84Intersect->Pretty#87Flatrespects non-tuple arrays #103infoStringerror.nameproperties #104·#105IndentedCodeBlockDetails["indented"]FencedCodeBlockDetails["char"]md/codeBlock/findAllto return full details (remove last use of code block regex)feat(parser): init; add
combinatormodule (d0ee007)Parser combinator libraries provide composable parsers used for constructing more complex parsers. This first draft is robust enough for simple DSLs. Notably it does not implement backtracking or a chain combinator, which would allow for more advanced branching. However the TS implementation is very powerful, capable of inferring the return types from complex parsers without explicit compiler hints in userland.
The base
Parserclass handles core functionality like.fallback(),into(),.not(),.then(),.optional,.ignore,.zeroOrMore, and.oneOrMore.StringParserwith shorthand factorystring()provides a specializedParserwith string-specific.split(),.trim,.trimStart, and.trimEnd.ArrayParserwith shorthand factorysequence()provides a specializedParserwith array-specific.flat,.item(),.items(),.join(), and.toObject().RegExpParserwith shorthand factoryregexp()provides a specializedParserwith RegExp-specific.match,.group(),.groups(), and.or().any()composes multiple parsers into one that matches the first success.Common helpers
whitespace,blankLink,inlineString,multilineString, andendare provided, also exported understring(ex.string.inline,string.whitespace) for convenience.As a proof-of-concept, the conventional commit parser was refactored to use this module, also exporting the full
Language.