@bpmn-io/feel-lint/README.md

Linter for FEEL expressions.

# @bpmn-io/feel-lint

[![CI](https://github.com/bpmn-io/feel-lint/actions/workflows/CI.yml/badge.svg)](https://github.com/bpmn-io/feel-lint/actions/workflows/CI.yml)

Linting for FEEL expressions.

## Usage

There are 2 ways to use this library:

### Linting string expressions

The `lintExpression` function takes a string expression and returns a list of linting errors.

```javascript
import { lintExpression } from "@bpmn-io/feel-lint"

lintExpression('foo = bar');
```

You may pass custom language configuration to the editor. Checkout [@camunda/feel-builtins](https://github.com/camunda/feel-builtins) for a reference of built-in functions.

```javascript
import { camundaBuiltins } from '@camunda/feel-builtins';

lintExpression('> 10, "yes", mike\'s name', {
  dialect: 'unaryTests',
  builtins: camundaBuiltins,
  variables:  [
    {
       name: `mike's name`
    }
  ]
});
```

### CodeMirror plugin

The `cmFeelLinter` function returns a [`LintSource`](https://codemirror.net/docs/ref/#lint.LintSource) that you can use to extend your [CodeMirror](https://codemirror.net/) instance.

```javascript
import { cmFeelLinter } from "@bpmn-io/feel-lint"
import { linter } from '@codemirror/lint';

// ...

const myEditor = new EditorView({
    state: EditorState.create({
      doc: '',
      extensions: [
        linter(cmFeelLinter())
      ]
    })
  });
```


## Hacking the Project

To get the development setup make sure to have [NodeJS](https://nodejs.org/en/download/) installed.
As soon as you are set up, clone the project and execute

```
npm install
npm run dev
```

## License

MIT