@nuuvem/commitlint-config
v1.0.0
Published
Shared commitlint config for Nuuvem projects.
Readme
@nuuvem/commitlint-config
Shared commitlint configuration for Nuuvem projects. Enforces the commit message standards described in our Git commit messages guide.
Extends @commitlint/config-conventional with custom rules:
- nuuvem/no-markdown-emoji — rejects
:+1:style emoji - nuuvem/no-unicode-emoji — rejects Unicode emoji characters
- nuuvem/no-short-references — rejects short GitLab references (
#123,!123)
Usage
Install the package:
npm install --save-dev @nuuvem/commitlint-config
# or
yarn add --dev @nuuvem/commitlint-configCreate a commitlint.config.js in your project root:
module.exports = { extends: ["@nuuvem/commitlint-config"] };That's it. The package includes @commitlint/config-conventional as a dependency, so you don't need to install it separately.
Authentication
This is a private npm package under the @nuuvem scope. Both tokens are stored in the 1Password vault under npm (nuuvem_developers):
- Developers access token — for local development and publishing
- CI access token — for GitLab CI pipelines to install the package
To install or publish locally, create a .npmrc in the project root (already in .gitignore):
//registry.npmjs.org/:_authToken=<developers-access-token>Publishing a new version
bin/release patch # or minor / majorThe script validates that you're on main, up to date with the remote, and authenticated with npm. It then bumps the version, publishes to npm, and pushes the commit and tag.
On first run, if no .npmrc exists, it will prompt for the token and create the .npmrc.
