prepare-commit-msg-angular
Version:
Githook to prepare a commit message following Angular guidelines and display documentation about it
75 lines (62 loc) • 2.57 kB
JavaScript
#!/usr/bin/env node
'use strict';
var fs = require('fs');
var execSync = require('child_process').execSync;
var commitMsgFile = process.argv[2] || './.git/COMMIT_EDITMSG';
var isNewCommit = (process.argv[3] === 'undefined');
var maxCharsLine = '#⎴⎴⎴⎴⎴⎴⎴⎴⎴⎴⎴⎴⎴⎴⎴⎴⎴⎴⎴⎴⎴⎴⎴⎴⎴⎴⎴⎴⎴⎴⎴⎴⎴⎴⎴⎴⎴⎴⎴⎴⎴⎴⎴⎴⎴⎴⎴⎴⎴⎴⎴⎴⎴⎴⎴⎴⎴⎴⎴⎴⎴⎴⎴⎴⎴⎴⎴⎴⎴⎴⎴⎴⎴⎴⎴⎴⎴⎴⎴⎴⎴⎴⎴⎴⎴⎴⎴⎴⎴⎴⎴⎴⎴⎴⎴⎴⎴⎴⎴';
var scissorsLine = '# ------------------------ >8 ------------------------';
var doc = `${scissorsLine}
# <type>(<scope>): <subject>
# <BLANK LINE>
# <body>
# <BLANK LINE>
# <footer>
#---
# TYPE must be one of the following:
# - feat: A new feature (will appear in CHANGELOG)
# - fix: A bug fix (will appear in CHANGELOG)
# - docs: Documentation only changes
# - style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
# - refactor: A code change that neither fixes a bug nor adds a feature
# - perf: A code change that improves performance (will appear in CHANGELOG)
# - test: Adding missing tests
# - chore: Changes to the build process or auxiliary tools and libraries such as documentation generation
#
# SCOPE could be anything specifying place of the commit change.
# For example $location, $browser, $compile, $rootScope, ngHref, ngClick, ngView, etc...
#
# SUBJECT contains succinct description of the change:
# - use the imperative, present tense: "change" not "changed" nor "changes"
# - do not capitalize first letter
# - no dot (.) at the end
#---
# https://github.com/ajoslin/conventional-changelog/blob/master/conventions/angular.md
`;
function getPrefilledMessage() {
if (!isNewCommit) {
return '';
}
var currentBranch = execSync('git rev-parse --abbrev-ref HEAD').toString().trim();
return '(' + currentBranch + '): ';
}
function getMaxCharsLine() {
if (!isNewCommit) {
return '';
}
return '\n' + maxCharsLine;
}
function getContentWithDoc() {
if (content.indexOf(scissorsLine) !== -1) {
// git commit -v
content = content.replace(scissorsLine, doc + scissorsLine);
} else if (content.indexOf('#') !== -1) {
// other cases where there is a prompt to display doc
content = content + doc;
}
return content;
}
var content = fs.readFileSync(commitMsgFile).toString();
content = getPrefilledMessage() + getMaxCharsLine() + getContentWithDoc();
fs.writeFileSync(commitMsgFile, content);
process.exit(0);