Add slate test command (#55)

package.json

@@ -6,6 +6,7 @@
   "license": "MIT",
   "author": "Shopify Inc.",
   "dependencies": {
+    "@shopify/theme-lint": "1.0.3",
     "@shopify/themekit": "0.6.6",
     "bluebird": "3.4.6",
     "browser-sync": "2.18.2",

src/commands/test.js

@@ -0,0 +1,20 @@
+import spawn from 'cross-spawn';
+import debug from 'debug';
+import config from '../config';
+
+const logger = debug('slate-tools:test');
+
+export default function(program) {
+  program
+    .command('test')
+    .description('Runs translation tests for a theme\'s locale files (<theme>/src/locales/).')
+    .action(() => {
+      logger(`--gulpfile ${config.gulpFile}`);
+      logger(`--cwd ${config.themeRoot}`);
+
+      spawn(config.gulp, ['test', '--gulpfile', config.gulpFile, '--cwd', config.themeRoot], {
+        detached: false,
+        stdio: 'inherit',
+      });
+    });
+}

src/gulpfile.js

@@ -28,6 +28,17 @@ gulp.task('build:zip', (done) => {
   );
 });
 
+/**
+ * Runs translation tests on each file using @shopify/theme-lint
+ *
+ * @function test
+ * @memberof slate-cli.tasks
+ * @static
+ */
+gulp.task('test', (done) => {
+  runSequence('lint:locales', done);
+});
+
 /**
  * Does a full clean/rebuild of your theme and creates a `.zip` compatible with
  * shopify.

src/tasks/includes/lint-reporter.js

@@ -0,0 +1,60 @@
+const gutil = require('gulp-util');
+const _ = require('lodash');
+
+/** Class representing a custom reporter for @shopify/theme-lint */
+export default class Reporter {
+  constructor() {
+    this.successes = [];
+    this.failures = [];
+  }
+
+  /**
+   * Pushes a valid message onto successes.
+   *
+   * @param {String} message
+   * @param {String} file
+   */
+  success(message, file = null, index = null) {
+    this.successes.push([message, file, index]);
+  }
+
+  /**
+   * Pushes an invalid message onto failures.
+   *
+   * @param {String} message
+   * @param {String} file
+   */
+  failure(message, file = null, index = null) {
+    this.failures.push([message, file, index]);
+  }
+
+  /**
+   * Builds string output for translation tests
+   * depending on successes and failures.
+   */
+  output() {
+    const testsRun = this.failures.length + this.successes.length;
+
+    if (this.failures.length === 0) {
+      gutil.log('Translation tests complete:',
+        gutil.colors.green(`Success (${testsRun} checks run)`),
+      );
+    } else {
+      gutil.log('Translation tests complete:',
+        gutil.colors.red(`Failed (${testsRun} checks run)`),
+      );
+
+      const failureGroups = _.groupBy(this.failures, (failure) => failure[1]);
+
+      _.forOwn(failureGroups, (failures, file) => {
+        gutil.log(gutil.colors.red(`${file}:`));
+
+        failures.map((failure) => {
+          return gutil.log(failure[0]);
+        });
+      });
+    }
+
+    this.successes = this.failures = [];
+  }
+}

src/tasks/lint-locales.js

@@ -0,0 +1,29 @@
+const gulp = require('gulp');
+const {runAll} = require('@shopify/theme-lint');
+
+const config = require('./includes/config.js');
+const Reporter = require('./includes/lint-reporter.js').default;
+
+/**
+ * Runs all the translation tests and the reporter outputs
+ * the locale results once completed.
+ *
+ * @returns {String} Finalized linting output
+ * @private
+ */
+function lintLocales() {
+  return runAll(config.src.root, new Reporter()).then((reporter) => {
+    return reporter.output();
+  });
+}
+
+/**
+ * Runs translation tests using @shopify/theme-lint
+ *
+ * @function lint:locales
+ * @memberof slate-cli.tasks.lint
+ * @static
+ */
+gulp.task('lint:locales', () => {
+  return lintLocales();
+});