@house-of-angular/commit-lint
Advanced tools
Package for handling validation of commits, nx tags, branch and code formatting
Package for handling validation of commits, nx tags, branch and code formatting
npm install @house-of-angular/commit-lint --save-dev
print-versionPrint version based on package.json and git commit hash.
validate-branch <branch>Check if branch is correctly named
validate-nx-tagsCheck if all nx tags are valid.
validate-commit <branch>Check if commit messages are correctly formatted.
prettier-check <files>Check with prettier if files are correctly formatted.
build-affected [options]Build affected apps.
Options:
--base <base> - base commit or branch for finding affected apps
--buildFlags <buildFlags> - build flags eg. --aot --build-optimizer=false (default: "--aot --build-optimizer=false")
--head <head> - head commit or branch for finding affected apps
--nodeFlags <nodeFlags> - nodejs flags eg. --max-old-space-size=6144 (default: "")
--npmCommands <npmFlags> - additional npm commands to run before build separated with && eg. build:ci:prepare && build:ci:notify (default: "")
themes-symlinksCreate symlinks in node_modules for _styles.scss and *.theme.scss.
validate-change-size [options]Check if merge request isn't too large.
Options:
--base <base> - base commit or branch for diff
--head <head> - head commit or branch for diff
Create houseofangular-commit-lint.json5 file in repository with the following content:
{
branch: {
// types of branches
types: ['feature', 'bugfix', 'hotfix', 'release', 'refactor'],
// RegExp that overrides "types" (types are ignored)
pattern: '(.*)',
},
change: {
// max number of added lines in change request, default: -1
maxAdditions: -1,
// max number of deleted lines in change request, default: -1
maxDeletions: -1,
// max number of edited files in change request, default: -1
maxFiles: -1,
},
// all commitlint rules are supported
// https://github.com/conventional-changelog/commitlint/blob/master/docs/reference-rules.md
commitlint: {
'body-leading-blank': [1, 'always'],
'footer-leading-blank': [1, 'always'],
'header-max-length': [2, 'always', 72],
'body-max-line-length': [2, 'always', 72],
'footer-max-line-length': [2, 'always', 72],
'scope-case': [2, 'always', 'lower-case'],
'subject-case': [2, 'never', ['sentence-case', 'start-case', 'pascal-case', 'upper-case']],
'subject-empty': [2, 'never'],
'subject-full-stop': [2, 'never', '.'],
'type-case': [2, 'always', 'lower-case'],
'type-empty': [2, 'never'],
'type-enum': [2, 'always', ['build', 'ci', 'docs', 'feat', 'fix', 'perf', 'refactor', 'release', 'style', 'test']],
'scope-enum': [2, 'always', ['test', 'report', 'document']],
},
prettier: {
// extensions to check with prettier
extensionsToCheck: ['.json', '.ts', '.js', '.html', '.css', '.scss'],
},
nxTagsValidator: {
// ignore default tags
ignore: ['type:application', 'type:util', 'type:ui', 'type:data-access', 'type:resource', 'type:feature', 'scope:shared'],
},
}
17.0.6 (2024-04-24)
FAQs
Package for handling validation of commits, nx tags, branch and code formatting
The npm package @house-of-angular/commit-lint receives a total of 29 weekly downloads. As such, @house-of-angular/commit-lint popularity was classified as not popular.
We found that @house-of-angular/commit-lint demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 6 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
require(esm) backported to Node.js 20, easing the transition to ESM-only packages and reducing complexity for developers as Node 18 nears end-of-life.
Security News
PyPI now supports iOS and Android wheels, making it easier for Python developers to distribute mobile packages.
Security News
Create React App is officially deprecated due to React 19 issues and lack of maintenance—developers should switch to Vite or other modern alternatives.