Skip to content

aocenas/lezer-promql

 
 

lezer-promql

CircleCI NPM version

Where does it come from?

The authoritative copy of this code lives in prometheus/prometheus and is synced to prometheus/lezer-promql on a regular basis by a bot. Please contribute any code changes to the code in https://github.com/prometheus/prometheus/tree/main/web/ui/module/codemirror-promql/src/grammar.

Overview

This is a PromQL grammar for the lezer parser system. It is inspired by the initial grammar coming from Prometheus written in yacc.

This library is stable but doesn't provide any guideline of how to use it as it has been integrated into codemirror-promql. If you want to use this library, you perhaps want to actually use codemirror-promql instead.

Note: This library is following the changes of the upstream grammar (i.e. coming from Prometheus) as closed as possible

Installation

This package is available as an npm package:

npm install --save lezer-promql

Note: you will have to manually install the dependency lezer as it is a peer dependency to this package.

npm install --save lezer

Development

Building

npm i
npm run build

Testing

npm run test

License

The code is licensed under an Apache 2.0 license.

About

A lezer-based PromQL grammar

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 50.1%
  • Shell 49.9%