bavary

KO | EN

gitlite — search

#javascript #ai #typescript #llm #golang #machine-learning #rust #nodejs #windows #awesome-list #vue #security #mcp #open-source

(★ 11)

🧬 Regular expressions on steroids. Parse anything and everything with a syntax - crafted to parse syntax. A super-set of regular-expressions.

bavary Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<br>

> Checkout [related packages](#related-packages)

## Getting Started
⚠ Bavary is currently **not stable** and **heavily under development**.
The API might change and all `0.0.x` releases should be treated as test / preview releases.

Install via npm:
```shell
$ npm install @bavary/core
```

Install via yarn:
```shell
$ yarn add @bavary/core
```

Include directly via jsdelivr:
```html
<script src="https://cdn.jsdelivr.net/npm/@bavary/core/lib/bavary.js"></script>
```

## Usage
```js
import {compile} from '@bavary/core';

// Compile definitions
const parse = compile(`['A' | 'B']`);

// Use compiled definitions to parse a string
const parsed = parse('A');

// Logs "A" to the console
console.log(parsed);
```

The function `compile` accepts as second argument a [config object](docs/config.md).

## Compiling in chunks
It's possible to (re-)compile just parts of your entire code-base to speed up the process:

```js
import {compile, compileChunk,} from '@bavary/core';
const entry = compileChunk(`entry [<abc>]`);
const abc = compileChunk(`<abc> = [(a - c)+]`);
const parse = compile([...entry, ...abc]);

console.log(parse('aabbccc')); // Prints 'aabbccc'
```

## What's next?
Check out the [documentation](docs/syntax.md) to get started or jump directly into one of the examples:

1. [string](docs/examples/string.md) - Parsing strings and support escaped quotes.
2. [hex-color](docs/examples/hex-color.md) - Parsing different kinds of color types in the hexadecimal format.
3. [number](docs/examples/number.md) - Parsing floats and integers with optional scientific notation.

## Related packages
* [@bavary/core](https://github.com/Simonwep/bavary) _- Parser and compiler._
* [@bavary/cli](https://github.com/Simonwep/bavary-cli) _- CLI with development server._
* [@bavary/bavary-lib](https://github.com/Simonwep/bavary-lib) _- Standard library with extensions for bavary._
* [@bavary/webpack-loader](https://github.com/Simonwep/bavary-webpack-loader) _- Webpack loader for declaration files._

bavary

bavary Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

bavary

bavary Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README