[FEATURE] Adds code for setting commit template

Adds configuration files for linting and git hooks required for package setup. Added code to set git template when the pre-commit-msg hook call this script. [TESTING] Tested by setting the same script locally for this package.

Author: Anshul Guleria

.commit-msg

@@ -0,0 +1,47 @@
+[FEATURE | BUG | DOCS | CHORE] One liner
+# One liner describing the change(<=50 chars)
+
+# FEATURE: When you are adding new feature then use this tag. Usually this
+# updates minor version for non-breaking change and major version for breaking
+# change. Command: `npm version minor` or `npm version major`
+#
+# BUG: When you are fixing an issue in the repository. Usually this changes the
+# patch version of the package. Command: `npm version patch`
+#
+# DOCS: When you are updating the documentation for the package. This is also a
+# patch version change as this does not breaks anything
+#
+# CHORE: When you are doing some minor code re-adjustments for re-factoring
+# which does not changes any interface or fixes any bug. This is also a patch
+# version change.
+
+# Description (<= 72 chars)
+# Should reach max 72 characters before wrapping to new
+# line. Keep this section descriptive.
+Describe the issue you are facing and how you solved it with the
+proposed changes.
+
+[TESTING]
+
+# Explain the how you tested the change. If possible also provide links
+# where your working solution is hosted so that reviewer can test it.
+How you tested this change.
+
+closes: #ISSUE_NUMBER
+
+# If you want to close multiple issues you can do:
+
+# closes: #ISSUE_NUMBER1
+
+# closes: #ISSUE_NUMBER2
+
+# Closes issue in another repository
+# closes: username/repository#ISSUE_NUMBER
+
+# For full list of available syntax and options you can read github
+# documentation on
+# [closing-issues-using-keywords](https://help.github.com/en/articles/closing-issues-using-keywords).
+
+# This is the default autogenerated template by git-commit-template
+# package. For more info read package documentation at
+# https://github.com/amzn/git-commit-template

.editorconfig

@@ -0,0 +1,15 @@
+# top-most EditorConfig file
+root = true
+
+# Unix-style newlines with a newline ending every file
+[*]
+end_of_line = lf
+insert_final_newline = true
+
+# 2 space indentation
+indent_style = space
+indent_size = 2
+
+# Set default charset
+[*.{js,jsx,ts,tsx}]
+charset = utf-8

.eslintignore

@@ -0,0 +1,2 @@
+# Ignore markdown files
+**/*.md

.eslintrc.js

@@ -0,0 +1,25 @@
+module.exports = {
+ env: {
+ commonjs: true,
+ es6: true,
+ node: true,
+ },
+ extends: "eslint:recommended",
+ globals: {
+ Atomics: "readonly",
+ SharedArrayBuffer: "readonly",
+ },
+ parserOptions: {
+ ecmaVersion: 2018,
+ },
+ plugins: ["json"],
+ rules: {
+ indent: ["error", 2, { SwitchCase: 1 }],
+ "linebreak-style": ["error", "unix"],
+ quotes: ["error", "double"],
+ semi: ["error", "always"],
+ "no-console": "off",
+ curly: "warn",
+ "arrow-parens": ["error", "always"],
+ },
+};

.gitignore

@@ -0,0 +1,144 @@
+
+# Created by https://www.gitignore.io/api/vim,node,macos
+# Edit at https://www.gitignore.io/?templates=vim,node,macos
+
+### macOS ###
+# General
+.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must end with two \r
+Icon
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+### Node ###
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# TypeScript v1 declaration files
+typings/
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env
+.env.test
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+
+# next.js build output
+.next
+
+# nuxt.js build output
+.nuxt
+
+# vuepress build output
+.vuepress/dist
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+### Vim ###
+# Swap
+[._]*.s[a-v][a-z]
+[._]*.sw[a-p]
+[._]s[a-rt-v][a-z]
+[._]ss[a-gi-z]
+[._]sw[a-p]
+
+# Session
+Session.vim
+
+# Temporary
+.netrwhist
+*~
+# Auto-generated tag files
+tags
+# Persistent undo
+[._]*.un~
+
+# End of https://www.gitignore.io/api/vim,node,macos
+
+
+# Our custom ignores
+build
+# From idea editor
+*.iml

.huskyrc.js

@@ -0,0 +1,6 @@
+module.exports = {
+ hooks: {
+ "pre-commit": "lint-staged",
+ "prepare-commit-msg": "./bin/git-commit-template.js",
+ },
+};

README.md

@@ -1,7 +1,43 @@
-## Git Commit Template
+# git-commit-template
 
-Set commit templates for git
+Sets commit template for your git projects. This is a husky plugin which should
+be used on `prepare-commit-msg` hook exposed by git.
+
+It exposes a cli command with name `git-commit-template` which you can use in
+your husky configuration. For example:
+
+```javascript
+// .huskyrc.js
+module.exports = {
+ hooks: {
+ "prepare-commit-msg": "git-commit-template",
+ },
+};
+```
+
+## `git-commit-template` command
+
+This command takes an optional parameter of your commit message file name. If
+provided, then it will read the file provided by you, otherwise uses its default
+configuration file. Read [`.commit-msg`](.commit-msg) file to see the default configuration
+added by us.
+
+Sample for providing file name:
+
+```javascript
+// .huskyrc.js
+module.exports = {
+ hooks: {
+ "prepare-commit-msg": "git-commit-template .my-custom-git-msg-file",
+ },
+};
+```
+
+> Note: This hooks provides you default commit message only if you haven't
+> provided any yet. This means that this plugin will not add message if you are
+> amending your commit(`git commit --amend`) or using interactive rebase
+> (`git rebase -i HEAD~3`).
 
 ## License
 
-This library is licensed under the Apache 2.0 License. 
+This library is licensed under the Apache 2.0 License.

SETUP.md

@@ -0,0 +1,4 @@
+For setting up this package you can follow the
+[Setup javascript package](https://w.amazon.com/bin/view/AmazonReactToolkit/Community/PackageSetup/#HSetupjavascriptpackage)
+documentation. Those are generic javascript package guidelines which we follow
+for all our javascript based packages.

bin/git-commit-template.js

@@ -0,0 +1,72 @@
+#!/usr/bin/env node
+
+/**
+ * Script to set our template as commit message template. This depends on husky
+ * parameters $HUSKY_GIT_PARAMS which gives me the git commit message template
+ * being used for commit message. By default this is ./git/COMMIT_MSG file
+ */
+
+/**
+ * Here we are using only the first parameter of $HUSKY_GIT_PARAMS variable i.e.
+ * the commit message file. We will update that file with our template file
+ * content
+ */
+
+/**
+ * Usage examples:
+ * Add this script in your hooks section of husky. We require 1.x version of
+ * husky so this will not work for 0.x version of husky.
+ *
+ * Example:
+ * ```javascript
+ * // .huskyrc.js
+ * module.exports = {
+ * hooks: {
+ * "prepare-commit-msg": "git-commit-template .gitmessage",
+ * },
+ * };
+ *
+ * ```
+ */
+
+const fs = require("fs");
+const path = require("path");
+const COMMIT_MSG_FILE_NAME = ".commit-msg";
+
+// Default template file but will be overridden with input argument if provided
+let templateFile = path.join(__dirname, `../${COMMIT_MSG_FILE_NAME}`);
+
+/**
+ * If we have 3rd argument i.e. file name then use that as template
+ * e.g.
+ * ./bin/setup-template.js .gitmessage
+ * // Then argv will look like this:
+ * argv = [ "node", "./bin/setup-template.js", ".gitmessage" ]
+ */
+if (process.argv[2]) {
+ templateFile = path.join(process.cwd(), process.argv[2]);
+}
+
+/**
+ * Sample git params are [ "./git/COMMIT_MSG", "commit", "HEAD" ] in case of
+ * --amend flag
+ */
+const gitParams = process.env["HUSKY_GIT_PARAMS"].split(" ");
+
+/**
+ * We are running our logic only in case of empty commit message. In other
+ * scenarios commit message would already be present and no longer needs our
+ * template thus skip it.
+ */
+if (gitParams.length === 1) {
+ const commitMsgFile = gitParams[0];
+
+ let gitFileContent = fs.readFileSync(commitMsgFile, { encoding: "utf8" });
+ const templateFileContent = fs.readFileSync(templateFile, {
+ encoding: "utf8",
+ });
+
+ gitFileContent = templateFileContent + gitFileContent;
+
+ fs.writeFileSync(commitMsgFile, gitFileContent, { encoding: "utf8" });
+}

lint-staged.config.js

@@ -0,0 +1,14 @@
+// Since this module is set to use es6 thus module is giving error. Thus
+// defining module as global before hand
+module.exports = {
+ linters: {
+ "*.{js,json,md}": [
+ "npm run lint:files",
+ // Assuming prettier doesn't add any linting issues
+ "prettier --write",
+ // Checking if anything broke because of prettier
+ "npm run lint:files",
+ "git add",
+ ],
+ },
+};