Security News
ESLint is Now Language-Agnostic: Linting JSON, Markdown, and Beyond
ESLint has added JSON and Markdown linting support with new officially-supported plugins, expanding its versatility beyond JavaScript.
fit-commit-js
Advanced tools
A npm package to validate commits according to community guidelines
A node version of fit-commit by Mike Foley
It creates a git commit hook that will be run each time you do a commit for your repo, it will validate that the commit message follows the guidelines you've set up for your project.
We all want always to become better developers, in order to do so, we need to learn new things every day. One of the strategies to learning and using new ways to work, is to understand the reasons behind them.
In order to get more insights behind why it is important to validate commit messages, and the whys behind each of the rules in this package, check out the wiki in github
To install it run:
$ npm i fit-commit-js
Then you need to install the commit hook in your repo by doing:
$./node_modules/fit-commit-js/bin/fit-commit-js.js install
Then create your fitcomitjsrc.{yml, yaml, json} with your settings, and place it at the root of your project.
You can also add a section in your package.json called: "fitcommitjsConfig", and add there your settings.
Default value: 150
Default value: 1 (the line after the subject)
Default Value: '' ie: feature, chore, bugfix, etc.
Default Value: ''
Default Value: N/A Checks against black list of words
Default Value: N/A
Default Value: N/A
Default Value: N/A
---
validators:
lineLength:
enabled: true
maxLineLength: 72
subjectMaxLength: 50
ticketCode:
enabled: true
ticketCodeText: 'FITCOMMITJS-'
oneTicketPerCommit: false
emptyLines:
enabled: true
emptyLines: 1,3
tags:
enabled: true
tags: bugfix, chore, feature
lineOfTheTag: 4
subjectTense:
enabled: true
subjectPeriod:
enabled: true
capitalizedSubject:
enabled: true
wip:
enabled: true
branch: master
...
"fitcommitjsConfig" : {
"validators" : {
"lineLength" : {
"enabled" : true,
"maxLineLength" : 72,
"subjectMaxLength" : 50
},
"ticketCode" : {
"enabled" : true,
"ticketCodeText" : "FITCOMMITJS-",
"oneTicketPerCommit" : false
},
"emptyLines" : {
"enabled" : true,
"emptyLines" : 13
},
"tags" : {
"enabled" : true,
"tags" : "bugfix, chore, feature",
"lineOfTheTag" : 4
},
"subjectTense" : {
"enabled" : true
},
"subjectPeriod" : {
"enabled" : true
},
"capitalizedSubject" : {
"enabled" : true
},
"wip" : {
"enabled" : true,
"branch" : "master"
}
}
}
...
'adds', 'adding', 'added', 'allows', 'allowing', 'allowed', 'amends', 'amending', 'amended', 'bumps', 'bumping', 'bumped', 'calculates', 'calculating', 'calculated', 'changes', 'changing', 'changed', 'cleans', 'cleaning', 'cleaned', 'commits', 'committing', 'committed', 'corrects', 'correcting', 'corrected', 'creates', 'creating', 'created', 'darkens', 'darkening', 'darkened', 'disables', 'disabling', 'disabled', 'displays', 'displaying', 'displayed', 'drys', 'drying', 'dryed', 'ends', 'ending', 'ended', 'enforces', 'enforcing', 'enforced', 'enqueues', 'enqueuing', 'enqueued', 'extracts', 'extracting', 'extracted', 'finishes', 'finishing', 'finished', 'fixes', 'fixing', 'fixed', 'formats', 'formatting', 'formatted', 'guards', 'guarding', 'guarded', 'handles', 'handling', 'handled', 'hides', 'hiding', 'hid', 'increases', 'increasing', 'increased', 'ignores', 'ignoring', 'ignored', 'implements', 'implementing', 'implemented', 'improves', 'improving', 'improved', 'keeps', 'keeping', 'kept', 'kills', 'killing', 'killed', 'makes', 'making', 'made', 'merges', 'merging', 'merged', 'moves', 'moving', 'moved', 'permits', 'permitting', 'permitted', 'prevents', 'preventing', 'prevented', 'pushes', 'pushing', 'pushed', 'rebases', 'rebasing', 'rebased', 'refactors', 'refactoring', 'refactored', 'removes', 'removing', 'removed', 'renames', 'renaming', 'renamed', 'reorders', 'reordering', 'reordered', 'requires', 'requiring', 'required', 'restores', 'restoring', 'restored', 'sends', 'sending', 'sent', 'sets', 'setting', 'separates', 'separating', 'separated', 'shows', 'showing', 'showed', 'skips', 'skipping', 'skipped', 'sorts', 'sorting', 'speeds', 'speeding', 'sped', 'starts', 'starting', 'started', 'supports', 'supporting', 'supported', 'takes', 'taking', 'took', 'tests', 'testing', 'tested', 'truncates', 'truncating', 'truncated', 'updates', 'updating', 'updated', 'uses', 'using', 'used'
FAQs
A npm package to validate commits according to community guidelines
We found that fit-commit-js demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer 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
ESLint has added JSON and Markdown linting support with new officially-supported plugins, expanding its versatility beyond JavaScript.
Security News
Members Hub is conducting large-scale campaigns to artificially boost Discord server metrics, undermining community trust and platform integrity.
Security News
NIST has failed to meet its self-imposed deadline of clearing the NVD's backlog by the end of the fiscal year. Meanwhile, CVE's awaiting analysis have increased by 33% since June.