Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add ability to disable rule for a particular BPMN file or element #116

Open
nhomble opened this issue Sep 5, 2023 · 4 comments
Open

Add ability to disable rule for a particular BPMN file or element #116

nhomble opened this issue Sep 5, 2023 · 4 comments
Labels
backlog Queued in backlog enhancement New feature or request

Comments

@nhomble
Copy link

nhomble commented Sep 5, 2023

Is your feature request related to a problem? Please describe

I am forced to disable a certain rule in my project even though it is only one bpmn in the project that requires this rule exclusion.

Describe the solution you'd like

I would prefer to disable the bpmn lint rule for a specific file.

A possible solution would be to support exclusions in the .bpmnlintrc file.

Describe alternatives you've considered

I could keep the rule and skip linting the file in general, but then there are other important lints that I still want to evaluate. I don't have a use case for ever skipping them.

Additional context

This is a similar use case to the eslint-disable pragma for eslint.

@nhomble nhomble added the enhancement New feature or request label Sep 5, 2023
@nikku
Copy link
Member

nikku commented Sep 11, 2023

Thanks for opening this issue, I can see how it could be very useful.

What would be your preferred solution?

  • Add the eslint-disable like pragma to your BPMN file
  • Add custom overrides (exclusion) in .bpmnlintrc file

@nikku nikku added the needs more information Requires additional information to be actionable. label Sep 11, 2023
@nhomble
Copy link
Author

nhomble commented Sep 11, 2023

My preference depends on the modeler. If adding an exclusion as some kind of property or pragma on the xml is wrapped in a nice UI, then I think keeping the exclusions in the same file could be really helpful. It would also be ideal to target very specific nodes of the xml that require exclusions rather than the whole file.

Without some GUI support, I don't think people would want to open the raw xml every time. I'd prefer the .bpmnlintrc approach as an mvp.

@nikku nikku added backlog Queued in backlog and removed needs more information Requires additional information to be actionable. labels Sep 14, 2023
@nikku
Copy link
Member

nikku commented Sep 14, 2023

Thanks for your feedback. From the bpmnlint perspective we may want to support both cases. It is GUI-less anyway. Once we support tagging inside the BPMN file then we could consider a better editor integration.

@nikku
Copy link
Member

nikku commented Sep 14, 2023

We'd be happy to work with you to get this feature incorporated, if you are interested in contributing.

@nikku nikku changed the title ability to disable rule for a bpmn Add ability to disable rule for a particular BPMN file or element Sep 14, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backlog Queued in backlog enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants