https://github.com/yiminghe/kison
A LALR(1)/LL(1)/LL(K) parser generator for javascript/typescript
https://github.com/yiminghe/kison
async-regexp excel-formula grammar javascript lalr ll parser parser-generator typescript vba
Last synced: 11 days ago
JSON representation
A LALR(1)/LL(1)/LL(K) parser generator for javascript/typescript
- Host: GitHub
- URL: https://github.com/yiminghe/kison
- Owner: yiminghe
- License: mit
- Created: 2014-04-24T04:31:57.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2024-10-10T22:07:36.000Z (6 months ago)
- Last Synced: 2025-04-01T02:37:40.966Z (19 days ago)
- Topics: async-regexp, excel-formula, grammar, javascript, lalr, ll, parser, parser-generator, typescript, vba
- Language: TypeScript
- Homepage:
- Size: 5.71 MB
- Stars: 41
- Watchers: 4
- Forks: 4
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# kison
[](http://badge.fury.io/js/kison)
[](https://npmjs.org/package/kison)
[](https://app.travis-ci.com/github/yiminghe/kison)
[https://yiminghe.me/kison](https://yiminghe.me/kison)
[https://github.com/yiminghe/kison](https://github.com/yiminghe/kison)
A LALR(1)/LL(1)/LL(K) parser generator for `javascript`/`typescript`
## examples
[https://yiminghe.me/kison/examples/](https://yiminghe.me/kison/examples/)
- [xtemplate](https://github.com/xtemplate/xtemplate): an extensible template engine
[](https://badge.fury.io/js/xtemplate)
[](https://npmjs.org/package/xtemplate)
- [json](https://github.com/modulex/json): es5 compliant javascript implementation of JSON parser
[](https://badge.fury.io/js/modulex-json)
[](https://npmjs.org/package/modulex-json)
- [excel formula engine](https://yiminghe.me/kison/examples/excel-formula-engine/): excel formula engine
[](https://badge.fury.io/js/excel-formula-engine)
[](https://npmjs.org/package/excel-formula-engine)
- [regular expression engine](https://yiminghe.me/kison/examples/regular-expression-engine/): support [async stream match](https://medium.com/@yiminghe/match-stream-data-using-regular-expression-a1a08b17ca2e)
[](https://badge.fury.io/js/regular-expression-engine)
[](https://npmjs.org/package/regular-expression-engine)
- [vba engine](https://yiminghe.me/kison/examples/vba/): [written in typescript/javascript](https://medium.com/@yiminghe/vba-engine-written-in-typescript-javascript-4ee8403777ec)
[](https://badge.fury.io/js/vba)
[](https://npmjs.org/package/vba)
## run command
```
npx kison@latest -g xx-grammar.js
```
## grammar and lexer definition
### LALR
cal-grammar.js: support operator precedence
``` javascript
module.exports = {
productions: [
{
symbol: 'exp',
rhs: ['primaryExpression'],
},
{
symbol: 'exp',
rhs: ['exp', '^', 'exp'],
action() {
return {
v: Math.pow(this.$1.v, this.$3.v),
l: this.$1,
r: this.$3,
op: '^',
};
},
},
{
symbol: 'exp',
rhs: ['exp', '-', 'exp'],
action() {
return { v: this.$1.v - this.$3.v, l: this.$1, r: this.$3, op: '-' };
},
},
{
symbol: 'exp',
rhs: ['exp', '*', 'exp'],
action() {
return { v: this.$1.v * this.$3.v, l: this.$1, r: this.$3, op: '*' };
},
},
{
symbol: 'exp',
rhs: ['exp', '/', 'exp'],
action() {
return { v: this.$1.v / this.$3.v, l: this.$1, r: this.$3, op: '/' };
},
},
{
symbol: 'exp',
precedence: 'UMINUS',
rhs: ['-', 'exp'],
action() {
return { v: -this.$2.v, op: 'UMINUS' };
},
},
{
symbol: 'exp',
rhs: ['exp', '+', 'exp'],
action() {
return { v: this.$1.v + this.$3.v, l: this.$1, r: this.$3, op: '+' };
},
},
{
symbol: 'primaryExpression',
rhs: ['(', 'exp', ')'],
action() {
return this.$2;
},
},
{
symbol: 'primaryExpression',
rhs: ['NUMBER'],
action() {
return { v: Number(this.$1) };
},
},
],
operators: [
['left', '+', '-'],
['left', '*', '/'],
['right', '^'],
['right', 'UMINUS'],
],
lexer: {
rules: [
{
regexp: /^\s+/,
token: '$HIDDEN',
},
{
regexp: /^[0-9]+(\.[0-9]+)?\b/,
token: 'NUMBER'
}
]
}
};
```
### LL/LL(K)
cal-grammar.js:
- LL(1) and LL(K) support:
- direct left recursive
- operator precedence
- repeat notation(*/+)
- optional notation(?)
- group notation('('/')')
- alternative natation('|')
- LL(K) extra support:
- lazy repeat notation(*?/+?)
- lazy optional notation(??).
``` javascript
const startGroup = `'('`;
const endGroup = `')'`;
const alternative = `'|'`;
module.exports = () => ({
productions: [
{
symbol: 'program',
rhs: ['statements'],
},
{
symbol: 'statements',
rhs: [startGroup, 'exp', 'NEW_LINE', endGroup + '*'],
},
{
symbol: 'exp',
rhs: [
'exp', '+', 'exp',
alternative,
'exp', '-', 'exp',
alternative,
'exp', '*', 'exp',
alternative,
'exp', '/', 'exp',
alternative,
'exp', '^', 'exp',
],
label: 'binary-exp',
},
{
symbol: 'exp',
rhs: ['-', 'exp'],
precedence: 'UMINUS',
},
{
symbol: 'exp',
rhs: ['NUMBER'],
},
{
symbol: 'exp',
rhs: ['(', 'exp', ')'],
},
],
operators: [
['left', '+', '-'],
['left', '*', '/'],
['right', '^'],
['right', 'UMINUS'],
],
lexer: {
rules: [
{
regexp: /^\n/,
token: 'NEW_LINE',
},
{
regexp: /^\s+/,
token: '$HIDDEN',
},
{
regexp: /^[0-9]+(\.[0-9]+)?\b/,
token: 'NUMBER',
},
],
},
});
```
## command options
- `--es`: generate es module
- `-g`: grammar file
- `-m`: ll or lalr or llk **(llk is powerful than ll but less performant!)**
- `--babel`: use babel to transform code. need install @babel/[email protected] and @babel/preset-env manually
- `--declaration`: generate d.ts type file for LL parser
### LALR
```
npx kison@latest -g cal-grammar.js
```
### LL
ll parser generator
```
npx kison@latest -m ll -g cal-grammar.js
```
## changelog
### 0.6.0 - 2022/12/31
- support incremental parser
### 0.5.0 - 2021/09/30
- support '-m llk' support LL(K)
### 0.4.35 - 2021/09/22
- support `--declaration` to generate d.ts type for LL
### 0.4.x - 2021/06/24
* LL & LALR
* add $HIDDEN token type
* use js config file
* add excel formula demo
* support filter for lexer config
* support operator precedence
* LL
* support LL parser
* support direct left recursive elimination and extract common prefix for LL
* support parser tree auto return even if partly error
### 0.3.0 - 2014/08/25
* optimize error debug info