# dmn-js-dmnlint

**Repository Path**: mirrors_bpmn-io/dmn-js-dmnlint

## Basic Information

- **Project Name**: dmn-js-dmnlint
- **Description**: dmn-js integration for dmnlint
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-09-24
- **Last Updated**: 2025-11-16

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# dmn-js-dmnlint

[![CI](https://github.com/bpmn-io/dmn-js-dmnlint/workflows/CI/badge.svg)](https://github.com/bpmn-io/dmn-js-dmnlint/actions?query=workflow%3ACI)

Integrates [dmnlint](https://github.com/bpmn-io/dmnlint) into [dmn-js](https://github.com/bpmn-io/dmn-js).

See this extension in action as part of the [dmnlint playground (TODO)](https://github.com/bpmn-io/dmnlint-playground).

## Usage

Integrate the linter into [dmn-js](https://github.com/bpmn-io/dmn-js):

```javascript
import { DrdLinting } from 'dmn-js-dmnlint';

import DmnModeler from 'dmn-js/lib/Modeler';

import dmnlintConfig from './.dmnlintrc';

var modeler = new DmnModeler({
  common: {
    linting: dmnlintConfig
  },
  drd: {
    additionalModules: [
      DrdLinting
    ]
  }
});
```

## Bundle Lint Rules

Use an appropriate plugin/loader for your module bundler (cf. [rollup-plugin-dmnlint](https://github.com/bpmn-io/rollup-plugin-dmnlint), [dmnlint-loader](https://github.com/bpmn-io/dmnlint-loader)) to bundle the dmnlint configuration directly with your application as [shown above](#usage).

Alternatively, pack your local `.dmnlintrc` file using the [dmnlint-pack-config (TODO)](https://github.com/bpmn-io/dmnlint-pack-config) utility:

```shell
dmnlint-pack-config -c .dmnlintrc -o bundled-config.js
```

## Plug-in Lint Rules

Provide the [packed lint rules](#bundle-lint-rules) via the `linting.dmnlint` option. You may set it dynamically, too:

```javascript
var linting = modeler.get('linting');

linting.setLinterConfig(dmnlintConfig);
```

## Resources

* [Issues](https://github.com/bpmn-io/dmn-js-dmnlint/issues)
* [Playground Project (TODO)](https://github.com/bpmn-io/dmnlint-playground)

## Development Setup

```shell
npm install
npm run dev
```

## Credits

The project is based on [`dmn-js-dmnlint`](https://github.com/bpmn-io/dmn-js-dmnlint) built by [philippfromme](https://github.com/philippfromme).

## License

MIT