add swig.version and -v to cli

Author: paularmstrong

Makefile

@@ -1,6 +1,6 @@
 SHA := $(shell git rev-parse HEAD)
 THIS_BRANCH := $(shell git rev-parse --abbrev-ref HEAD)
-VERSION_REGEX = [0-9]*\.[0-9]*\.[0-9]*[^\" ]*
+VERSION_REGEX = [0-9][0-9]*\.[0-9][0-9]*\.[0-9][0-9]*[^\" ]*
 VERSION := $(shell npm ls | grep "swig@" |  grep -Eo "${VERSION_REGEX}" -m 1)
 
 TMP = 'tmp'
@@ -14,6 +14,14 @@ all:
 	@cp scripts/githooks/* .git/hooks/
 	@chmod -R +x .git/hooks/
 
+.INTERMEDIATE version: \
+	browser/comments.js \
+	docs/index.json
+
+version:
+	@sed -i.bak 's/${VERSION_REGEX}/${VERSION}/' lib/swig.js
+	@rm lib/swig.js.bak
+
 browser/comments.js: FORCE
 	@sed -i.bak 's/v${VERSION_REGEX}/v${VERSION}/' $@
 	@rm $@.bak
@@ -156,7 +164,7 @@ docs: build build-docs
 
 FORCE:
 
-.PHONY: all \
+.PHONY: all version \
 	build build-docs \
 	test test-browser lint coverage \
 	docs/index.json docs gh-pages

bin/swig.js

@@ -16,6 +16,7 @@ var command,
       '    $0 render [files] [options]\n'
       )
     .describe({
+      v: 'Show the Swig version number.',
       o: 'Output location.',
       h: 'Show this help screen.',
       j: 'Variable context as a JSON file.',
@@ -25,6 +26,7 @@ var command,
       'wrap-end': 'Template wrapper end for "compile".',
       'method-name': 'Method name to set template to and run from.'
     })
+    .alias('v', 'version')
     .alias('o', 'output')
     .default('o', 'stdout')
     .alias('h', 'help')
@@ -35,6 +37,10 @@ var command,
     .default('wrap-end', ';')
     .default('method-name', 'tpl')
     .check(function (argv) {
+      if (argv.v) {
+        return;
+      }
+
       if (!argv._.length) {
         throw new Error('');
       }
@@ -62,6 +68,11 @@ var command,
   files,
   fn;
 
+if (argv.v) {
+  console.log(require('../package').version);
+  process.exit(0);
+}
+
 if (argv.j) {
   ctx = JSON.parse(fs.readFileSync(argv.j, 'utf8'));
 } else if (argv.c) {

docs/docs/api.html

@@ -42,6 +42,21 @@ <h3>Examples</h3>
   </section>
 {% endfor %}
 
+{% for prop in properties %}
+  <section id="{{ prop.name }}" class="doc">
+    <h2>swig.{{ prop.name }}</h2>
+
+    <p>{{ prop.description|replace('\n', '</p><p>')|raw }}</p>
+
+    {% if prop.examples.length %}
+    <h3>Examples</h3>
+    {% for example in prop.examples %}
+    <pre><code data-language="js">{{ example }}</code></pre>
+    {% endfor %}
+    {% endif %}
+  </section>
+{% endfor %}
+
 {% for fn in functions %}
   {% if fn.access !== "private" %}
   <section id="{{ fn.name }}" class="doc">
@@ -104,6 +119,9 @@ <h3>Examples</h3>
 {% for def in typedefs %}
   <li><a href="#{{ def.name }}">Object: {{ def.name }}</a></li>
 {% endfor %}
+{% for prop in properties %}
+  <li><a href="#{{ prop.name }}">swig.{{ prop.name }}</a></li>
+{% endfor %}
 {% for fn in functions %}
   {% if fn.access !== "private" %}
   <li>

docs/docs/cli.html

@@ -21,6 +21,7 @@ <h2>Usage</h2>
 
   <h3>Options</h3>
   <pre>
+-v, --version  Show the Swig version number.
 -o, --output   Output location. [default: "stdout"]
 -h, --help     Show this help screen.
 -j, --json     Variable context as a JSON file.

lib/swig.js

@@ -6,6 +6,15 @@ var fs = require('fs'),
   parser = require('./parser'),
   dateformatter = require('./dateformatter');
 
+/**
+ * Swig version number as a string.
+ * @example
+ * if (swig.version === "1.0.0-pre3") { ... }
+ *
+ * @type {String}
+ */
+exports.version = "1.0.0-pre3";
+
 /**
  * Swig Options Object. This object can be passed to many of the API-level Swig methods to control various aspects of the engine. All keys are optional.
  * @typedef {Object} SwigOpts

tests/basic.test.js

@@ -12,6 +12,12 @@ function resetOptions() {
   swig.invalidateCache();
 }
 
+describe('version', function () {
+  it('is 1.0.0-pre3', function () {
+    expect(swig.version).to.equal('1.0.0-pre3');
+  });
+});
+
 describe('options', function () {
   beforeEach(resetOptions);
   afterEach(resetOptions);

tests/bin.test.js

@@ -21,6 +21,15 @@ var casefiles = fs.readdirSync(__dirname + '/cases/'),
     return f.split('.')[0];
   });
 
+describe('bin/swig -v', function () {
+  it('shows the version number', function (done) {
+    exec(bin + ' -v', function (err, stdout, stderr) {
+      expect((/^\d+\.\d+\.\d+/).test(stdout)).to.equal(true);
+      done();
+    });
+  });
+});
+
 describe('bin/swig render', function () {
   _.each(cases, function (files, c) {
     var test = _.find(files, isTest),