camunda-modeler icon indicating copy to clipboard operation
camunda-modeler copied to clipboard

Validate `bpmnlint:recommended` rules

Open nikku opened this issue 3 years ago • 3 comments

This PR showcases validation of bpmnlint:recommended rules.

There is clearly a couple of things that we'd need to account for beyond this PR to make this possible. However the PR (screen capture attached) already showcases a few things:

  • We shall include the recommended modeling guidelines (bpmnlint:recommended rules) as warnings, not errors. From the automation perspective, these are rather un-critical, good to have things.
  • We shall re-work our iconography for warnings (the PR does a poor attempt to fix the existing (unused?) warning icon.
  • We shall aim for warnings not being prominently displayed on the diagram (while errors shall be prominently featured. However, warnings are not at all featured at the moment
  • We can easily roll this out via a feature toggle. This PR hides the feature behind --enable-bpmnlint-recommended.

capture 19r1Vy_optimized

nikku avatar Dec 09 '21 18:12 nikku

CC @andreasgeier @philippfromme

nikku avatar Dec 09 '21 18:12 nikku

A related and powerful easy pick could be to allow custom linter rules to be injected via a plug-in.

nikku avatar Dec 09 '21 18:12 nikku

I agree that best practice rules should throw a warning, not an error. Error = blocks execution Warning = everything else

When adding warnings, we need to do another design round for it. But it shouldn't be a big challenge.

Regarding linting overlays on the diagram: We should let the user choose whether none, one, or both types are preferred to see as overlay. Plus, a basic configuration to show/hide linting results at all (as mentioned in this comment).

andreasgeier avatar Dec 13 '21 13:12 andreasgeier