Skip to content

On canvas linting overlays#71

Draft
nikku wants to merge 2 commits into
mainfrom
on-canvas-linting-overlays
Draft

On canvas linting overlays#71
nikku wants to merge 2 commits into
mainfrom
on-canvas-linting-overlays

Conversation

@nikku
Copy link
Copy Markdown
Member

@nikku nikku commented Jul 21, 2023

This PR adds on canvas linting annotations to provide more immediate access to issues.

capture tjD8sv_optimized


Can be tried out via

npx @bpmn-io/sr camunda/linting#on-canvas-linting-overlays

Closes #68

@nikku nikku requested review from philippfromme and smbea July 21, 2023 13:42
@bpmn-io-tasks bpmn-io-tasks Bot added the in progress Currently worked on label Jul 21, 2023
@nikku nikku changed the base branch from main to rework-annotations July 21, 2023 13:42
@nikku nikku force-pushed the on-canvas-linting-overlays branch from 8a884da to 1b11719 Compare July 21, 2023 13:43
@nikku
Copy link
Copy Markdown
Member Author

nikku commented Jul 21, 2023

Marked it as draft as someone would need to take this over / add test cases.

@nikku nikku removed their assignment Jul 21, 2023
@nikku
Copy link
Copy Markdown
Member Author

nikku commented Jul 21, 2023

Missing to complete this:

  • Test coverage
  • Real world use-case with stacked errors / warnings
  • Improved styling (inherit bpmn-js font?)
  • A round of inhouse user testing

@philippfromme philippfromme force-pushed the rework-annotations branch 2 times, most recently from 2c50508 to 0925f71 Compare July 24, 2023 13:50
Base automatically changed from rework-annotations to main July 24, 2023 13:52
@philippfromme philippfromme force-pushed the on-canvas-linting-overlays branch from 1b11719 to 74e34ab Compare July 24, 2023 13:59
@YanaSegal
Copy link
Copy Markdown

That looks good - I have one comment regarding the tooltip background - for UI consistency and better visibility, we use a dark background.

@nikku nikku force-pushed the on-canvas-linting-overlays branch from 74e34ab to e6e40ee Compare August 16, 2023 20:15
@nikku nikku requested a review from YanaSegal August 16, 2023 20:16
@nikku
Copy link
Copy Markdown
Member Author

nikku commented Aug 16, 2023

@YanaSegal I've updated the example to feature multiple lint errors, cf. screen capture below:

capture zLCkMX_optimized

If we want to pursue the dark route then we'd need to have appropriate styling for these errors, decide not to move to the dark side, or decide to not add the overlays at last.

@nikku
Copy link
Copy Markdown
Member Author

nikku commented Aug 28, 2023

@YanaSegal and myself made the decision to park this initiative. The play team may come up with a solution that we can work with.

@nikku nikku added backlog Queued in backlog and removed in progress Currently worked on labels Aug 28, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

backlog Queued in backlog

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Provide more context for on canvas overlays

2 participants