https://github.com/bpmn-io/eslint-plugin-bpmn-io

Common lint rules for bpmn.io projects
https://github.com/bpmn-io/eslint-plugin-bpmn-io

Last synced: 3 months ago
JSON representation

Common lint rules for bpmn.io projects

• Host: GitHub
• URL: https://github.com/bpmn-io/eslint-plugin-bpmn-io
• Owner: bpmn-io
• License: mit
• Created: 2018-02-14T12:30:38.000Z (almost 7 years ago)
• Default Branch: main
• Last Pushed: 2024-04-08T09:41:11.000Z (10 months ago)
• Last Synced: 2024-04-14T11:10:11.801Z (10 months ago)
• Language: JavaScript
• Homepage:
• Size: 415 KB
• Stars: 3
• Watchers: 8
• Forks: 5
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-bpmn-io - eslint-plugin-bpmn-io - Common lint rules for bpmn.io projects (Extensions)

README

        
# eslint-plugin-bpmn-io

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

Common lint rules for [bpmn.io](https://bpmn.io) projects.

## Use

Extend one or more of our recommended configurations:

```javascript

import bpmnIoPlugin from 'eslint-plugin-bpmn-io';

export default [

  ...bpmnIoPlugin.configs.recommended

]

```

If you use [mocha](https://mochajs.org/) for testing, add the mocha profile to your specs:

```javascript

import bpmnIoPlugin from 'eslint-plugin-bpmn-io';

export default [

  ...bpmnIoPlugin.configs.browser,

  ...bpmnIoPlugin.configs.mocha.map(config => {

    return {

      ...config,

      files: [

        '**/*.spec.js'

      ]

    };

  })

]

```

## Available Configurations

Base configurations:

* `browser`: Use for browser based projects

* `node`: Use for node based projects

* `recommended`: Use for libraries where no environment is assumed

Special purpose configurations:

* `jsx`: Use `jsx` in conjunction with `browser`

* `mocha`: Use for libraries tested with `mocha` + `chai`

## License

MIT