fix(commits): Write the generated commitlint config as a cjs file - #10
Merged
Conversation
The action wrote commitlint.config.js with module.exports. In a repository whose package.json sets "type": "module", node treats that file as an ES module and the run fails with "module is not defined in ES module scope". A .cjs file stays CommonJS regardless of the consumer's module type, so the config loads in both module and commonjs repositories.
Code Review SummaryThis PR fixes a runtime crash in ESM-based repositories by renaming the generated 🚀 Key Improvements
|
![sourceant[bot]](https://avatars.githubusercontent.com/in/1161781?s=60&v=4){kind=small}
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The commit-validation action writes commitlint.config.js with module.exports.
In a consumer whose package.json sets "type": "module" (any Nuxt or ESM
project), Node loads that file as an ES module and the run crashes with
"module is not defined in ES module scope", failing validation before it
checks a single commit message.
Writing the config as commitlint.config.cjs keeps it CommonJS regardless of
the consumer's module type, so it loads in both ESM and CommonJS repos.
Surfaced by trakli/webui#103. That repo pins the action at @main, so merging
here turns its validate check green on a re-run, with no change needed there.