✨ Add scaffold command to generate semantic-release settign files.

Author: nkmr-jp

.gitignore

@@ -1 +1,2 @@
-build
+build
+.playground

.playground/.gitkeep

@@ -2,56 +2,65 @@
 V=v3.0.0
 GITMOJI_VERSION=$(V)
 F=semver.yml
-SEMVER_FILE_PATH=$(F)
+SEMVER_FILE=$(F)
+O=./
+OUT_DIR=$(O)
 
 BASE_FILE=https://raw.githubusercontent.com/carloscuesta/gitmoji/$(GITMOJI_VERSION)/src/data/gitmojis.json
 
 # See: https://gist.github.com/rsperl/d2dfe88a520968fbc1f49db0a29345b9
-COLOR := $(shell tput -Txterm setaf 5)
+# define standard colors
+BLACK        := $(shell tput -Txterm setaf 0)
+RED          := $(shell tput -Txterm setaf 1)
+GREEN        := $(shell tput -Txterm setaf 2)
+YELLOW       := $(shell tput -Txterm setaf 3)
+LIGHTPURPLE  := $(shell tput -Txterm setaf 4)
+PURPLE       := $(shell tput -Txterm setaf 5)
+BLUE         := $(shell tput -Txterm setaf 6)
+WHITE        := $(shell tput -Txterm setaf 7)
+
 RESET := $(shell tput -Txterm sgr0)
 
 help:
 	@echo
-	@echo "Usage:"
-	@echo
+	@echo "$(GREEN)Usage:$(RESET)"
 	@echo "    make COMMAND [Options]"
 	@echo
-	@echo "Options:"
+	@echo "$(GREEN)Commands:$(RESET)"
+	@echo "    gen		$(BLUE)Generate gitmojis.json with semver field (alias: g)$(RESET)"
+	@echo "    list	$(BLUE)Show generated gitmojis.json (alias: l)$(RESET)"
+	@echo "    scaffold	$(BLUE)Generate semantic-release setting files (alias: s)$(RESET)"
 	@echo
-	@echo "    V=version	Specify the base gitmoji version"
-	@echo "    F=filepath	Specify semver.yml file path"
+	@echo "$(GREEN)Options:$(RESET)"
+	@echo "    V=<version>		$(BLUE)Specify the base gitmoji version$(RESET)"
+	@echo "    F=<filepath>	$(BLUE)Specify semver.yml file path$(RESET)"
+	@echo "    O=<output dir>	$(BLUE)Specify semver.yml file path$(RESET)"
 	@echo
-	@echo "Commands:"
+	@echo "$(GREEN)Examples:$(RESET)"
+	@echo "    make gen V=v3.0.0 F=./semver.yml"
+	@echo "    make list"
+	@echo "    make scaffold V=v3.0.0 F=./semver.yml O=[your project directory]"
 	@echo
-	@echo "    gen		Generate gitmojis.json with semver field (alias: g)"
-	@echo "    list	Show generated gitmojis.json (alias: l)"
-	@echo "    scaffold	Generate semantic-release configs (alias: s)"
-
-# Short commands
-l: list
-g: gen
-s: scaffold
-h: help
 
 # Generate gitmojis.json with semver field
 gen:
 	@echo
-	@echo "$(COLOR)# GEN: 1. Fetch gitmojis.json ($(GITMOJI_VERSION))$(RESET)"
+	@echo "$(PURPLE)# GEN: 1. Fetch gitmojis.json ($(GITMOJI_VERSION))$(RESET)"
 	mkdir -p build build/src build/dist
 	curl -so build/src/gitmojis.json $(BASE_FILE)
 
 	@echo
 	@echo
-	@echo "$(COLOR)# GEN: 2. Add semver field$(RESET)"
-	yq '.' $(SEMVER_FILE_PATH) > build/src/semver.json
+	@echo "$(PURPLE)# GEN: 2. Add semver field$(RESET)"
+	yq '.' $(SEMVER_FILE) > build/src/semver.json
 	node gitmoji-semver.js
 	cat build/dist/tmp.json | jq > build/dist/gitmojis.json
 	yq -y '.' build/dist/gitmojis.json > build/dist/gitmojis.yml
 	rm build/dist/tmp.json
 
 	@echo
 	@echo
-	@echo "$(COLOR)# GEN: 3. Generated!$(RESET)"
+	@echo "$(PURPLE)# GEN: 3. Generated!$(RESET)"
 	@echo "Generated gitmojis.json and gitmojis.yml whith semver field"
 	@echo "See ./build/dist"
 
@@ -63,7 +72,7 @@ GITMOJI_FILE=build/dist/gitmojis.json
 
 list:
 	@echo
-	@echo "$(COLOR)# LIST: show list gitmoji grouped by semver$(RESET)"
+	@echo "$(PURPLE)# LIST: show list gitmoji grouped by semver$(RESET)"
 	@echo "\n# Major (Breaking)"
 	@cat $(GITMOJI_FILE) | jq -c '.gitmojis[] | select(.semver=="major") | $(FORMAT)'
 	@echo "\n# Minor (Feature)"
@@ -73,11 +82,19 @@ list:
 	@echo "\n# None"
 	@cat $(GITMOJI_FILE) | jq -c '.gitmojis[] | select(.semver=="none") | $(FORMAT)'
 
-scaffold:
-	@echo
-	@echo "$(COLOR)# SCAFFOLD: Generate semantic-release configs$(RESET)"
-#	cp templates/commit-template.hbs build/dist/commit-template.hbs
-	node gen-semantic-release-template.js
-	ls -l build/dist/
+scaffold: gen
 	@echo
+	@echo "$(PURPLE)# SCAFFOLD: Generate semantic-release configs$(RESET)"
+	node gen-template.js
+	mkdir -p $(OUT_DIR)/.release $(OUT_DIR)/.github $(OUT_DIR)/.github/workflows
+	cp ./semantic-release-template/* $(OUT_DIR)/.release
+	mkdir -p $(OUT_DIR)/.github $(OUT_DIR)/.github/workflows
+	mv $(OUT_DIR)/.release/release.yml $(OUT_DIR)/.github/workflows
+	cp ./build/dist/release-template.hbs $(OUT_DIR)/.release
+	cp ./build/src/semver.json $(OUT_DIR)/.release
 
+# Short commands
+l: list
+g: gen
+s: scaffold
+h: help

Makefile

@@ -1,11 +1,12 @@
 const fs = require('fs');
 const gitmojisObj = JSON.parse(fs.readFileSync('./build/dist/gitmojis.json', 'utf8'));
-const commits = '{{subject}} - ' +
-    '[`{{commit.short}}`](https://github.com/{{owner}}/{{repo}}/commit/{{commit.short}}) ' +
-    '`{{shortDate committerDate}}`'
-const header = '# {{releaseTypeEmoji nextRelease.type}}v{{nextRelease.version}} ({{datetime "UTC:yyyy-mm-dd"}}) ' +
-    '**{{releaseTypeText nextRelease.type}}** ({{nextRelease.type}} version up) - [`v{{lastRelease.version}}`...`v{{nextRelease.version}}`]({{compareUrl}})' +
-    '## Changes'
+
+const header = `# {{releaseTypeEmoji nextRelease.type}}v{{nextRelease.version}} ({{datetime "UTC:yyyy-mm-dd"}})
+
+**{{releaseTypeText nextRelease.type}}** ({{nextRelease.type}} version up) - [\`v{{lastRelease.version}}\`...\`v{{nextRelease.version}}\`]({{compareUrl}})
+
+## Changes
+`
 
 function run() {
     let res = header + "{{#with commits}}\n"
@@ -26,15 +27,15 @@ function run() {
         }
     }
     res += "{{/with}}"
-    fs.writeFileSync('./build/dist/semver-template.hbs', res);
+    fs.writeFileSync('./build/dist/release-template.hbs', res);
 }
 
 function buildH3Template(gitmojiObj) {
     return `
 {{#if ${gitmojiObj.name}}}
 ### ${gitmojiObj.emoji} ${gitmojiObj.description} 
 {{#each ${gitmojiObj.name}}}
-- ${commits}
+- {{> commitTemplate}}
 {{/each}}
 {{/if}}
 `

gen-semantic-release-template.js renamed to gen-template.js

@@ -0,0 +1,75 @@
+// in ".releaserc.js" or "release.config.js"
+
+const fs = require('fs');
+const path = require('path')
+const {promisify} = require('util')
+const dateFormat = require('dateformat')
+const readFileAsync = promisify(require('fs').readFile)
+
+const templateDir = "./"
+const template = readFileAsync(path.join(templateDir, 'release-template.hbs'))
+const commitTemplate = readFileAsync(path.join(templateDir, 'commit-template.hbs'))
+const semverObj = JSON.parse(fs.readFileSync('./semver.json', 'utf8'));
+
+const releaseRules = {
+    major: convert(semverObj.semver.major),
+    minor: convert(semverObj.semver.minor),
+    patch: convert(semverObj.semver.patch)
+}
+
+function convert(arr){
+    const res=[]
+    for (const v of arr) {
+        res.push(`:${v}:`)
+    }
+    return res
+}
+
+const releaseNotes = {
+    template,
+    partials: {commitTemplate},
+    helpers: {
+        datetime: function (format = 'UTC:yyyy-mm-dd') {
+            return dateFormat(new Date(), format)
+        },
+        shortDate: function (date) {
+            // See: https://www.npmjs.com/package/dateformat/v/3.0.0
+            return dateFormat(date, 'mmm dd')
+        },
+        releaseTypeText: function (type) {
+            if (type === 'major'){
+                return "Breaking Release!"
+            }
+            if (type === 'minor'){
+                return "Feature Release!"
+            }
+            if (type === 'patch'){
+                return "Patch Release"
+            }
+        },
+        releaseTypeEmoji: function (type) {
+            if (type === 'major'){
+                return ":confetti_ball: "
+            }
+            if (type === 'minor'){
+                return ":star2: "
+            }
+            if (type === 'patch'){
+                return ""
+            }
+        },
+    },
+    issueResolution: {
+        template: '{baseUrl}/{owner}/{repo}/issues/{ref}',
+        baseUrl: 'https://github.com',
+        source: 'github.com'
+    }
+}
+
+module.exports = {
+    branches: semverObj.branches,
+    plugins: [
+        ['semantic-release-gitmoji', {releaseRules, releaseNotes}],
+        '@semantic-release/github'
+    ]
+}

semantic-release-template/.releaserc.js

@@ -0,0 +1,9 @@
+# .release
+
+Check Next Release
+
+```sh
+npm install
+npx semantic-release
+```
+

semantic-release-template/README.md

@@ -0,0 +1 @@
+{{subject}} - [`{{commit.short}}`](https://github.com/{{owner}}/{{repo}}/commit/{{commit.short}}) `{{shortDate committerDate}}`