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

chore: build as cjs package #18

Merged
merged 3 commits into from
May 15, 2024
Merged

chore: build as cjs package #18

merged 3 commits into from
May 15, 2024

Conversation

cyyynthia
Copy link
Member

No description provided.

@cyyynthia cyyynthia added the enhancement New feature or request label May 12, 2024
@DavidAnson
Copy link

Ooh, very happy to see this!! I'd love this PR (plus a release) in order to fix igorshubovych/markdownlint-cli#469 without needing to introduce an async code path. It looks like you've done the work already, but if you'd like a second pair of eyes or anything to get this done, I volunteer. Thank you! :)

package.json Outdated
@@ -1,6 +1,6 @@
{
"name": "smol-toml",
"version": "1.1.4",
"version": "1.1.5",

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

At the risk of being a pest, I think changing the primary export from ESM to CJS should be considered a breaking change (i.e., semver major increment vs. patch increment).

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I see why that'd be the case; but the change shouldn't have any effect on downstream users (the package remains compatible with ESM-style imports) so I'm unsure if a semver major is necessary here 🤔

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You're right! I hadn't realized existing uses would continue to work, sorry.

@cyyynthia
Copy link
Member Author

After double checking the change I don't think it changes the behavior of the library enough to warrant a semver major.

It does allow for something new as a side effect (that I quite like, actually) and the possibility to import the library as TOML without using * as. I'll make this a semver minor bump instead of a patch since that's a new feature

@cyyynthia cyyynthia merged commit 91006d3 into mistress May 15, 2024
@cyyynthia cyyynthia deleted the chore/cjs branch May 15, 2024 14:50
@DavidAnson
Copy link

v1.2.0 works great, thank you!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants