https://github.com/sno2/feign
[WIP] A parser combinator module for Deno with compile-time type parsing support.
https://github.com/sno2/feign
deno parser-combinators
Last synced: about 1 year ago
JSON representation
[WIP] A parser combinator module for Deno with compile-time type parsing support.
- Host: GitHub
- URL: https://github.com/sno2/feign
- Owner: sno2
- License: mit
- Created: 2021-11-28T21:54:30.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2022-01-19T05:16:53.000Z (over 4 years ago)
- Last Synced: 2025-03-27T14:51:54.549Z (about 1 year ago)
- Topics: deno, parser-combinators
- Language: TypeScript
- Homepage:
- Size: 25.4 KB
- Stars: 6
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# feign
A parser combinator for Deno with compile-time string type parsing support
inspired by [Rust's `nom` crate](https://crates.io/crates/nom).
### 🚨 Deno Notice 🚨
You may get a `type is excessively large or infinite` error when using creating
complex parsers in Deno. This is due to the use of long recursion when utilizing
string parsing. However, this error will resolve once Deno updates its
TypeScript version to 4.5 with the introduction of
[tail-end elimination in TypeScript conditionals for recursive types](https://devblogs.microsoft.com/typescript/announcing-typescript-4-5-beta/#tailrec-conditional).
The TypeScript version upgrade is expected to be released with Deno 1.17. A
possible workaround is to abstract your parsers out into multiple parsers and
passing the inputs between each of them.
## Guide
### Usage
Import feign from Deno's Third Party Modules registry:
```ts no-run
import {} from "https://deno.land/x/feign/mod.ts";
```
### Examples
- [Identiifer](./examples/identiifer.ts)
## Contributing
### Linting
Make sure you run the linter before pushing your code. We don't care about the
`no-explicit-any` rule as it is required to cast to `any` to have conditional
return types. Therefore, run the following command to lint the code:
```sh
$ deno lint --rules-exclude=no-explicit-any
```
### Building Utilities
Make sure you add proper tests for both valid and invalid inputs along with
including conditions such as when the input is a regular `string` type to ensure
correct behavior.
### Testing
We use the unstable built-in test nesting API for our tests so make sure you run
`deno test` with the `--unstable` flag:
```sh
$ deno test --unstable
```
### Codebase Notes
- Always return either `never` or an extension of `[string, any]` inside of
parser helper types or you will break a lot of code.
## License
[MIT](./LICENSE)