Add quiet option

Author: alexcanessa

lib/_options.js

@@ -134,6 +134,11 @@ module.exports = {
             short: '-m',
             name: 'only-milestones',
             description: 'Add to the release bodies only the issues that have a milestone'
+        },
+        {
+            short: '-q',
+            name: 'quiet',
+            description: 'Run command without console logs.'
         }
     ],
     releaseOptions: [

lib/src/Gren.js

@@ -13,6 +13,7 @@ const defaults = {
     template: templateConfig,
     prerelease: false,
     generate: false,
+    quiet: false,
     override: false,
     debug: false,
     ignoreLabels: false,
@@ -75,7 +76,7 @@ class Gren {
      * @return {Promise}
      */
     async release() {
-        utils.printTask('Generate release notes');
+        utils.printTask(this.options.quiet, 'Generate release notes');
 
         await this._hasNetwork();
         const blocks = await this._getReleaseBlocks();
@@ -92,7 +93,7 @@ class Gren {
      * @return {Promise}
      */
     async changelog() {
-        utils.printTask('Generate changelog file');
+        utils.printTask(this.options.quiet, 'Generate changelog file');
 
         await this._hasNetwork();
         this._checkChangelogFile();
@@ -133,11 +134,12 @@ class Gren {
      * @param  {string} body The body of the file
      */
     _createChangelog(body) {
+        const loaded = utils.task(this, `Creating ${this.options.changelogFilename}`);
         const filePath = process.cwd() + '/' + this.options.changelogFilename;
 
         fs.writeFileSync(filePath, this.options.template.changelogTitle + body);
 
-        console.log(chalk.green(`\nChangelog created in ${filePath}`));
+        loaded(chalk.green(`\nChangelog created in ${filePath}`));
     }
 
     /**
@@ -164,9 +166,7 @@ class Gren {
         const loaded = utils.task(this, 'Updating latest release');
         const { data: release } = await this.repo.updateRelease(releaseId, releaseOptions);
 
-        loaded(chalk.green(`${release.name} has been successfully updated!`));
-
-        console.log(chalk.blue(`\nSee the results here: ${release.html_url}`));
+        loaded(chalk.green(`${release.name} has been successfully updated!`) + chalk.blue(`\nSee the results here: ${release.html_url}`));
 
         return release;
     }
@@ -193,9 +193,7 @@ class Gren {
         const loaded = utils.task(this, 'Preparing the release');
         const { data: release } = await this.repo.createRelease(releaseOptions);
 
-        loaded(chalk.green(`\n${release.name} has been successfully created!`));
-
-        console.log(chalk.blue(`See the results here: ${release.html_url}`));
+        loaded(chalk.green(`\n${release.name} has been successfully created!`) + chalk.blue(`See the results here: ${release.html_url}`));
 
         return release;
     }

lib/src/_utils.js

@@ -30,7 +30,11 @@ function sortObject(object) {
 *
 * @param  {string} name The name of the task
 */// istanbul ignore next
-function printTask(name) {
+function printTask(isQuiet, name) {
+    if (isQuiet) {
+        return;
+    }
+
     process.stdout.write(chalk.blue(`\n🤖  - ${name}:\n===================================\n`));
 }
 
@@ -45,6 +49,11 @@ function printTask(name) {
 * @return {Function}          The function to be fired when is loaded
 */// istanbul ignore next
 function task(gren, taskName) {
+    if (gren.options.quiet) {
+        gren.tasks[taskName] = {};
+
+        return noop;
+    }
     const spinner = ora(taskName);
     gren.tasks[taskName] = spinner;
 
@@ -205,6 +214,11 @@ function getFileNameFromPath(path) {
     return path.split('\\').pop().split('/').pop();
 }
 
+/**
+ * Just a noop function
+ */
+function noop() {}
+
 // Allow nodeunit to work. Has to be fixed.
 module.exports = {
     sortObject,
@@ -217,5 +231,5 @@ module.exports = {
     formatDate,
     requireConfig,
     getConfigFromFile,
-    noop: () => {}
+    noop
 };

package-lock.json

@@ -5,7 +5,7 @@
     "main": "./github-release-notes.js",
     "scripts": {
         "start": "node github-release-notes.js",
-        "test": "nyc mocha --compilers=js:babel-register",
+        "test": "nyc mocha --reporter=nyan --compilers=js:babel-register",
         "coverage": "nyc --reporter=lcov --reporter=text mocha --compilers=js:babel-register",
         "options": "node tasks/_generate-options.js",
         "examples": "node tasks/_generate-examples.js",
@@ -82,6 +82,7 @@
         "jsdoc": "^3.4.3",
         "minami": "^1.2.3",
         "nyc": "^11.2.1",
+        "tap-nyan": "^1.1.0",
         "yamljs": "^0.3.0"
     }
 }

package.json

@@ -15,14 +15,15 @@ describe('Gren', () => {
     const gren = new Gren({
         token: TOKEN,
         username: 'github-tools',
-        repo: 'github-release-notes'
+        repo: 'github-release-notes',
+        quiet: true
     });
 
     it('Should throw an error', () => {
         process.env.GREN_GITHUB_TOKEN = null;
 
-        const gren = () => new Gren();
-        assert.throws(gren, chalk.red('You must provide the TOKEN'), 'No token passed');
+        const grenWithoutToken = () => new Gren();
+        assert.throws(grenWithoutToken, chalk.red('You must provide the TOKEN'), 'No token passed');
     });
 
     it('Should generate the options', () => {