feat(new): add --commit-message-conventions options

Closes #15
groupe-sii · Apr 4, 2017 · 106c260 · 106c260
1 parent 21cc310
commit 106c260
Show file tree

Hide file tree

Showing 6 changed files with 39 additions and 4 deletions.
diff --git a/bin/clea-init.js b/bin/clea-init.js
@@ -16,6 +16,7 @@ program
   .option('--make-it-progressive', 'add the default configuration for a Progressive Web App (defaults to: false)')
   .option('--skip-install', 'skip installing packages (defaults to: false)')
   .option('--skip-git', 'skip initializing a git repository (defaults to: false)')
+  .option('--commit-message-conventions', 'add commit-msg hook to force use of the Google message conventions (defaults to: false)')
   .action((name) => {
     if (!InitProject.UI_FRAMEWORKS.includes(program.uiFramework)) {
       logger.error(`"${program.uiFramework}" ui framework is not allowed. ${chalk.blue.bold('clea help new')} to see allowed types.`);
@@ -30,7 +31,8 @@ program
         uiFramework      : program.uiFramework,
         makeItProgressive: program.makeItProgressive !== undefined,
         skipInstall      : program.skipInstall !== undefined,
-        skipGit          : program.skipGit !== undefined
+        skipGit          : program.skipGit !== undefined,
+        commitMessageConventions: program.commitMessageConventions !== undefined
       });
       initProject.start().catch((err) => {
         debug(err);

diff --git a/bin/clea-new.js b/bin/clea-new.js
@@ -16,6 +16,7 @@ program
   .option('--make-it-progressive', 'add the default configuration for a Progressive Web App (defaults to: false)')
   .option('--skip-install', 'skip installing packages (defaults to: false)')
   .option('--skip-git', 'skip initializing a git repository (defaults to: false)')
+  .option('--commit-message-conventions', 'add commit-msg hook to force use of the Google message conventions (defaults to: false)')
   .action((name) => {
     if (!InitProject.UI_FRAMEWORKS.includes(program.uiFramework)) {
       logger.error(`"${program.uiFramework}" ui framework is not allowed. ${chalk.blue.bold('clea help new')} to see allowed types.`);
@@ -29,7 +30,8 @@ program
         uiFramework      : program.uiFramework,
         makeItProgressive: program.makeItProgressive !== undefined,
         skipInstall      : program.skipInstall !== undefined,
-        skipGit          : program.skipGit !== undefined
+        skipGit          : program.skipGit !== undefined,
+        commitMessageConventions: program.commitMessageConventions !== undefined
       });
       initProject.createFolder();
       initProject.start().catch((err) => {

diff --git a/bin/postinstall.js b/bin/postinstall.js
@@ -0,0 +1,16 @@
+#!/usr/bin/env node
+
+const fs = require('fs-extra'),
+  logger = require('../vendors/logger');
+
+fs.copy('./tools/git/commit-msg.js', '.git/hooks/commit-msg', (err) => {
+  if (err) {
+    return logger.error(err);
+  }
+
+  fs.chmod('.git/hooks/commit-msg', '755', (err) => {
+    if (err) {
+      return logger.error(err);
+    }
+  });
+});
diff --git a/docs/new.md b/docs/new.md
@@ -33,6 +33,8 @@ clea help new
 
 `--skip-git` skip initializing a git repository (defaults to: **false**).
 
+`--commit-message-conventions` add commit-msg hook to force use of the [Google message conventions](../templates/application/COMMITS-CONVENTION.md) (defaults to: **false**).
+
 ### Library
 
 You can also scaffold a new library instead of an application.

diff --git a/lib/commands/init-project.js b/lib/commands/init-project.js
@@ -69,13 +69,21 @@ class InitProject {
       ]);
     }
 
+    // To copy only if `--commit-message-conventions` option has been used
+    if (!this.options.commitMessageConventions) {
+      excludedFiles = excludedFiles.concat([
+        'postinstall.js'
+      ]);
+    }
+
     return this.copyStaticFiles(excludedFiles)
       .then(() => this.copyFiles({
         appName      : this.name,
         slugifiedName: slugify(this.name),
         ngMaterial   : this.options.uiFramework === 'material',
         bootstrap    : this.options.uiFramework === 'bootstrap',
-        pwa          : this.options.makeItProgressive
+        pwa          : this.options.makeItProgressive,
+        commitMessageConventions          : this.options.commitMessageConventions
       }, excludedFiles))
       .then(() => (this.options.skipGit) ? Promise.resolve() : this.initializeGit())
       .then(() => (this.options.skipInstall) ? Promise.resolve() : this.installDependencies())
@@ -164,6 +172,10 @@ class InitProject {
       .then(() => logger.info('Successfully initialized git.'));
   }
 
+  addPostInstall () {
+    return
+  }
+
   installDependencies () {
     return new Promise((resolve, reject) => {
       logger.info(`Installing packages for tooling via NPM.`);

diff --git a/templates/application/_package.json b/templates/application/_package.json
@@ -10,7 +10,8 @@
     "build:prod": "clea build --target production --doc",
     "test": "clea test",
     "lint": "clea lint",
-    "sonar:reporters": "sreporter"
+    "sonar:reporters": "sreporter"<% if (commitMessageConventions) { %>,
+    "postinstall": "node ./node_modules/@clea/cli/bin/postinstall.js"<% } %>
   },
   "dependencies": {
     "angular": "^1.6.2",