@aurodesignsystem-dev/auro-config
v0.0.0-pr28.0
Published
This package contains the shared configuration for the development tools used by Auro.
Readme
Auro Config
Shared config for every Auro tool. Extend it and every repo lints, formats, and releases the same way.
Published as @aurodesignsystem/auro-config.
Install
npm install --save-dev @aurodesignsystem/auro-configUsage
Point each config file at the shared version with extends. Do not copy the rules into your repo, and do not deviate from them. The whole point is that every Auro repo stays aligned.
What's in here
| Config | Extend it from | Used for |
|--------|----------------|----------|
| biome.json | @aurodesignsystem/auro-config/biome | lint and format |
| .stylelintrc | @aurodesignsystem/auro-config/stylelint | CSS lint |
| .releaserc | @aurodesignsystem/auro-config/releaserc | semantic-release |
| .commitlintrc | @aurodesignsystem/auro-config/commitlint | commit message rules |
| .lintstagedrc | @aurodesignsystem/auro-config/lintstaged | pre-commit checks |
Examples
biome.json
{ "extends": ["@aurodesignsystem/auro-config/biome"] }.stylelintrc
{ "extends": ["@aurodesignsystem/auro-config/stylelint"] }.releaserc
{ "extends": ["@aurodesignsystem/auro-config/releaserc"] }.commitlintrc
{ "extends": ["@aurodesignsystem/auro-config/commitlint"] }.lintstagedrc
{ "extends": ["@aurodesignsystem/auro-config/lintstaged"] }The release config
releaserc is the one that drives publishing. It sets:
- Branches:
mainpublishes to npmlatest.rc/*publishes a prerelease to thercdist-tag. - Commit rules: conventional commits, plus
docs(README),refactor, andstyleeach bump a patch. - Plugins: commit-analyzer, release-notes-generator, changelog, npm, github.
One thing to know: there is no @semantic-release/git plugin. The changelog and version bump are not committed back to the repo. They live in the npm package and the GitHub release. This is the recommended way semantic-release suggests you use their tool.
