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

Update library to comply with bpmn.io baseline #1

Merged
merged 6 commits into from
Nov 21, 2024
Merged

Conversation

nikku
Copy link
Member

@nikku nikku commented Nov 19, 2024

Proposed Changes

This adjusts the library structure to comply with the standard pattern of bpmn.io libraries.

What is out of scope for now:

  • I did not touch the testing approach
  • I did not configure linting
  • There is a number of "how this is built" things to be discussed, for example:

Checklist

To ensure you provided everything we need to look at your PR:

  • Brief textual description of the changes present
  • Visual demo attached
  • Steps to try out present, i.e. using the @bpmn-io/sr tool
  • Related issue linked via Closes {LINK_TO_ISSUE} or Related to {LINK_TO_ISSUE}

We do not checkin dist files via git.
chore: turn into ES module

  * This is the future, embrace it
  * Simplifies building and testing (mid-term) the library

chore: drop `peerDependencies`

  This should only be used under rare circumstances, where
  "there can only be one" principle must be followed, or the outside
  mandates the dependency to use.

  To consider in the future if this library should even depend on
  dmn-moddle, or just consume a moddle tree.

chore: adjust scripts to conform with standard pattern

  The scripts `all`, `build`, `test` scripts work as expected
@nikku nikku requested review from nithinssabu and a team November 19, 2024 11:14
@nikku nikku self-assigned this Nov 19, 2024
@nikku nikku requested review from jarekdanielak and abdul99ahad and removed request for a team November 19, 2024 11:14
@nikku nikku merged commit 2277a7d into main Nov 21, 2024
4 checks passed
@nikku nikku deleted the update-library branch November 21, 2024 09:20
@nikku nikku added documentation Improvements or additions to documentation dependencies and removed documentation Improvements or additions to documentation labels Nov 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants