feat(API): standardize v() and version() into a single call

BREAKING CHANGE: change `version()` to return a string representation of the version, removing `v()`

Author: bmuenzenmeyer

packages/cli/bin/cli-actions/version.js

@@ -5,4 +5,4 @@ const config = Object.assign(patternlab.getDefaultConfig(), {
 });
 
 module.exports = ({ version }) =>
-	`${version} (PatternLab Node Core version: ${patternlab(config).v()})`;
+	`${version} (PatternLab Node Core version: ${patternlab(config).version()})`;

packages/core/docs/README.md

@@ -26,12 +26,7 @@ Many of these functions are exposed to users within [Editions](https://github.co
   Returns the standardized default config used to run Pattern Lab. This method can be called statically or after instantiation.
 
 **Returns**: <code>object</code> - Returns the object representation of the `patternlab-config.json`  
-## `version()` ⇒ <code>void</code>
-
-  Logs current version to standard output
-
-**Returns**: <code>void</code> - current patternlab-node version as defined in `package.json`  
-## `v()` ⇒ <code>string</code>
+## `version()` ⇒ <code>string</code>
 
   Returns current version
 
@@ -63,7 +58,7 @@ Many of these functions are exposed to users within [Editions](https://github.co
 
   Logs usage to standard output
 
-**Returns**: <code>void</code> - pattern lab API usage, as console output  
+**Returns**: <code>void</code> - Pattern Lab API usage, as console output  
 ## `installplugin(pluginName)` ⇒ <code>void</code>
 
   Installs plugin already available via `node_modules/`

packages/core/src/index.js

@@ -13,15 +13,15 @@
 const updateNotifier = require('update-notifier');
 
 const packageInfo = require('../package.json');
-const buildPatterns = require('./lib/buildPatterns');
 const help = require('./lib/help');
 const events = require('./lib/events');
-const loaduikits = require('./lib/loaduikits');
-const logger = require('./lib/log');
 const pe = require('./lib/pattern_exporter');
 
 const defaultConfig = require('../patternlab-config.json');
 
+let buildPatterns = require('./lib/buildPatterns'); // eslint-disable-line
+let loaduikits = require('./lib/loaduikits'); // eslint-disable-line
+let logger = require('./lib/log'); // eslint-disable-line
 let fs = require('fs-extra'); // eslint-disable-line
 let ui_builder = require('./lib/ui_builder'); // eslint-disable-line
 let copier = require('./lib/copier'); // eslint-disable-line
@@ -44,25 +44,16 @@ const getDefaultConfig = function() {
 };
 
 const patternlab_module = function(config) {
-  const PatternLab = require('./lib/patternlab');
-  const patternlab = new PatternLab(config);
+  const PatternLabClass = require('./lib/patternlab');
+  const patternlab = new PatternLabClass(config);
 
   return {
-    /**
-     * Logs current version to standard output
-     *
-     * @returns {void} current patternlab-node version as defined in `package.json`
-     */
-    version: function() {
-      return patternlab.logVersion();
-    },
-
     /**
      * Returns current version
      *
      * @returns {string} current patternlab-node version as defined in `package.json`, as string
      */
-    v: function() {
+    version: function() {
       return patternlab.getVersion();
     },
 
@@ -155,7 +146,7 @@ const patternlab_module = function(config) {
     /**
      * Logs usage to standard output
      *
-     * @returns {void} pattern lab API usage, as console output
+     * @returns {void} Pattern Lab API usage, as console output
      */
     help: function() {
       logger.info(help(patternlab.package.version));

packages/core/src/lib/patternlab.js

@@ -225,9 +225,6 @@ module.exports = class PatternLab {
   getVersion() {
     return this.package.version;
   }
-  logVersion() {
-    logger.info(this.package.version);
-  }
   getSupportedTemplateExtensions() {
     return this.engines.getSupportedFileExtensions();
   }

packages/edition-node-gulp/gulpfile.js

@@ -34,7 +34,7 @@ function serve() {
 }
 
 gulp.task('patternlab:version', function() {
-  patternlab.version();
+  console.log(patternlab.version());
 });
 
 gulp.task('patternlab:help', function() {