Giter VIP home page Giter VIP logo

camunda-modeler-linter-plugin's Introduction

This plugin was replaced by the built-in linting feature of Camunda Modeler v5.3. Check out the custom lint rules plugin to learn how to add custom lint rules to the built-in linting feature.

camunda-modeler-linter-plugin

CI Compatible with Camunda Modeler version 3.3

bpmnlint as a plugin for the Camunda Modeler.

Screenshot of the plug-in

Overriding Provided Rules

This plug-ins uses the recommended bpmnlint and Camunda rules.

You may override this via your own Camunda Modeler client plug-in as shown below:

import {
  registerBpmnJSPlugin
} from 'camunda-modeler-plugin-helpers';

import customLinterConfig from './.bpmnlintrc';

registerBpmnJSPlugin({
  __init__: [
    function(linting) {
      linting.setLinterConfig(customLinterConfig);
    }
  ]
});

Please note that you must use the bpmnlint-loader to bundle your .bpmnlintrc for usage in the browser.

For a complete example, checkout the custom-linter-rules-plugin that accomplishes this.

Licence

MIT

camunda-modeler-linter-plugin's People

Contributors

dependabot[bot] avatar maxtru avatar nikku avatar philippfromme avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

camunda-modeler-linter-plugin's Issues

Bugs while working with camunda modeler version 4.11.1

The linter plugin starts having bugs if used with camunda modeler version 4.11.1. It's still possible to check if a process has start and end events and it does realize if an event is missing and even updates the counter but the error is not shown in the diagram itself.

camunda-modeler-linter-plugin does not work with Modeler 5.3.0

Hello,
I copied all the plugins I have from Modeler 5.2 to 5.3, and I received this error.

Thie plug in which failed is the linter:
camunda-modeler-property-info-plugin-master](https://github.com/camunda/camunda-modeler-linter-plugin)

[D:\dev\intellij\community\zeebe-cherry-framework\src\test\resources\connectorworker\connectorworker.bpmn] this.getModeler(...).get(...).deactivate is not a function
    at deactivate (webpack://camunda-modeler-client/src/app/tabs/cloud-bpmn/BpmnEditor.js:187:39)
    at componentDidUpdate (webpack://camunda-modeler-client/node_modules/react-dom/cjs/react-dom.production.min.js:216:295)
    at Vh (webpack://camunda-modeler-client/node_modules/react-dom/cjs/react-dom.production.min.js:220:181)
    at file:///D:/Camunda/camunda-modeler-5.3.0/resources/app.asar/public/bundle.js:2:803376
    at b (webpack://camunda-modeler-client/node_modules/scheduler/cjs/scheduler.production.min.js:18:162)
    at unstable_runWithPriority (webpack://camunda-modeler-client/node_modules/react-dom/cjs/react-dom.production.min.js:250:202)
    at Fi (webpack://camunda-modeler-client/node_modules/react-dom/cjs/react-dom.production.min.js:249:382)
    at Di (webpack://camunda-modeler-client/node_modules/react-dom/cjs/react-dom.production.min.js:248:143)
    at Yh (webpack://camunda-modeler-client/node_modules/react-dom/cjs/react-dom.production.min.js:245:331)
    at Xh (webpack://camunda-modeler-client/node_modules/react-dom/cjs/react-dom.production.min.js:243:85)
    at qf (webpack://camunda-modeler-client/node_modules/react-dom/cjs/react-dom.production.min.js:130:227)
    at enqueueSetState (webpack://camunda-modeler-client/node_modules/react/cjs/react.production.min.js:13:223)
    at file:///D:/Camunda/camunda-modeler-5.3.0/resources/app.asar/public/bundle.js:2:2350775 [ error ]
This error may be the result of a plug-in compatibility issue. [ info ]
[Disable plug-ins (restarts the app)](https://github.com/camunda/camunda-modeler/issues/new?template=BUG_REPORT.md#) [ info ]

bpmnlintrc file load error

Hi,
@nikku ; @pinussilvestrus and team

I tried the approach stated for adding the linter plugin as stated, but i am facing module loading issue,
modeler issue

I added below rules also still facing the issue,
tsconfig

Requesting your inputs in integrating bpmn linter to the camunda modeler angular version

Deprecate Plugin

  • deprecate repository (f2ef122, e9ab068)
  • update plugin to indicate deprecation when used
  • document migration to Camunda Modeler 5.3 plus custom lint rules

Related to #28

lint does not work with modeler 5.5

I created a little bpmn and noticed, that the lint does not show any error, where an error is obvious.
so i created a little bpmn that makes absolutely no sense and is wrong (syntax), no error is shown

image

I would have expected some errors shown below. But it says "No errors."

Allow multiple plug-ins to contribute lint rules and configuration

What is the Problem

There exists certain usage scenarios where, depending on different use-cases users ship different custom linter rules (cf. camunda/camunda-modeler-custom-linter-rules-plugin#5). Right now, it is not possible to inject such.

Describe the solution you'd like

  • users may provide multiple "lint rule providing plug-ins"
  • users can configure per diagram, which lint rules are being used

Additional Context

A potential UI sketch for how linting settings could be accessed:

image

detail information for missing element linting rules is not visible

Hi,

we found an error with handling linting errors for missing elements. I.e.
https://github.com/bpmn-io/bpmnlint/tree/master/docs/rules -> bpmnlint/docs/rules/start-event-required.md

The situation is, that we have 2 participants in a model. The first one is a simple process with a StartEvent. The second one has a LaneSet and no StartEvent in any lane. Yes, this is an error. The BPMNLinter-Plugin counts this error, but the red X is missing. Thats why the detail information of the error is missing too. The only information is "1 Errors". It took a while to get the details, by adding a breakpoint in the script where the errors are counted.
The example in the docs show this red X, but the process is not placed in a LaneSet.

Maybe you could change the handling of errors a bit. For example add the details to the counter, maybe only if it depends on a missing element. Placing the details at the first element in the process could be a bit hard to realise, because you have to "know" what element is the first... :)

Best regards
Frank

Expressions shown as class instead

Not sure what's a good repo to post this issue, there are few bpmnlint projects over here, but I observed something that seems like a bug and thought of sharing.

When working on the lint plugin and validating service tasks, I see that the expression property is appearing as class.

You have a service task with implementation type as "expression"
image

But when you try to read this property and debug, it is stored against node.class field?
image

It doesn't work with my modeler

Camunda Modeler system information

  • Version: 4.12.0
  • Operating System: Mac OS 11.5.0
  • Plugins: BPMN Linter
  • Execution Platform: BPMN - Camunda Cloud

It doesn't show any check result in the modeler.
image

And, when I click the toggle Linting menu,some errors was displayed:
toggleLinting is not a registered action at ia (webpack:///node_modules/bpmn-js/node_modules/diagram-js/lib/features/editor-actions/EditorActions.js:257:9) at ra.na.trigger (webpack:///node_modules/bpmn-js/node_modules/diagram-js/lib/features/editor-actions/EditorActions.js:167:10) at trigger (webpack:///src/app/tabs/cloud-bpmn/BpmnEditor.js:529:40) at triggerAction (webpack:///src/app/tabs/MultiSheetTab.js:269:18) at triggerAction (webpack:///src/app/tabs/EditorTab.js:36:33) at triggerAction (webpack:///src/app/App.js:1782:15) at fn (webpack:///src/app/App.js:2250:19) at file:///Applications/Camunda%20Modeler.app/Contents/Resources/app.asar/public/bundle.js:73:147880 at exec (webpack:///src/app/AppParent.js:76:11) [ error ] This error may be the result of a plug-in compatibility issue. [ info ] [Disable plug-ins (restarts the app)](https://github.com/camunda/camunda-modeler-linter-plugin/issues/new#) [ info ]

image

What's wrong with me?

Diagrams can be auto-fixed

If automatic fixes are available, it should be possible to apply them.

Tasks

  • Autofix can be triggered via the modeler
  • Autofix(es) can be un-done via CMD+Z

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.