Initial troubleshooting project

Author: rsavian

examples/troubleshooting/.bowerrc

@@ -0,0 +1,3 @@
+{
+    "directory": "./src/assets/vendor"
+}

examples/troubleshooting/.editorconfig

@@ -0,0 +1,13 @@
+# http://editorconfig.org
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+indent_size = 4
+indent_style = space
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.json]
+indent_size = 2

examples/troubleshooting/.gitattributes

@@ -0,0 +1,3 @@
+* text=auto
+*.sh eol=lf
+*.cmd eol=crlf

examples/troubleshooting/.npmignore

@@ -0,0 +1,4 @@
+# don't ignore .npmignore files
+!.npmignore
+!.gitignore
+!build-env.js

examples/troubleshooting/Gulpfile.js

@@ -0,0 +1,161 @@
+const gulp = require('gulp');
+const requireDir = require('require-dir');
+const runSequence = require('run-sequence');
+const argv = require('yargs').argv;
+const gulpIf = require('gulp-if');
+const uglify = require('gulp-uglify');
+const useref = require('gulp-useref');
+const header = require('gulp-header');
+const cleanCSS = require('gulp-clean-css');
+const browserSync = require('browser-sync').create();
+
+/**
+ * Uncomment the next line to report the Gulp execution time (for optimization, etc)
+ */
+//require('time-require');
+
+/**
+ * Pulling in all tasks from the tasks folder
+ */
+requireDir('./tools/tasks', {
+    recurse: true
+});
+
+/**
+ * Setup global variables to use across tasks
+ */
+global.pkg = require('./package.json');
+global.env = require('./build-env.js');
+
+global.reloadBrowser = browserSync.reload;
+
+/**
+ * Determines the build mode. Default will be read from the env file but can be overridden with a flag.
+ * Flags are: --dev , --prod
+ */
+if (argv.prod === true || argv.dev === true) {
+    global.isProd = !!argv.prod;
+    global.isDev = !!argv.dev;
+} else {
+    global.isProd = (env.BUILD_MODE === 'prod');
+    global.isDev = (env.BUILD_MODE === 'dev');
+}
+
+// -- Tasks ----------------------------------------------------------------
+/**
+ * Run default tasks for the target environment.
+ *
+ * @task default
+ */
+gulp.task('default', (done) => {
+    runSequence(
+        (isDev === true) ? ['lint', 'build'] :
+        (isProd === true) ? ['build'] : [],
+        done
+    );
+});
+
+/**
+ * Compile source code and outputs to destination.
+ *
+ * @task build
+ */
+gulp.task('build', (done) => {
+    const tasks = [
+        ['clean:dest'],
+        ['buildStatic', 'buildMarkup', 'buildStyles', 'buildScripts', 'buildJST']
+    ];
+
+    if (isProd === true) {
+        tasks.push(['minify']);
+        tasks.push(['clean:minify']);
+    }
+
+    runSequence(...tasks, done);
+});
+
+/**
+ * Minify source code.
+ *
+ * @task minify
+ */
+gulp.task('minify', (done) => {
+    gulp
+        .src(env.DIR_DEST + '/*.html')
+        .pipe(useref())
+        .pipe(gulpIf('*.js', uglify({
+            mangle: false,
+            preserveComments: 'license'
+        })))
+        .pipe(gulpIf('*.css', cleanCSS()))
+        .pipe(gulp.dest(env.DIR_DEST))
+        .on('end', done);
+});
+
+/**
+ * Generate documentation.
+ *
+ * @task docs
+ */
+gulp.task('docs', (done) => {
+    runSequence(
+        ['clean:docs'], ['buildDocs'],
+        done
+    );
+});
+
+/**
+ * Validate code syntax.
+ *
+ * @task lint
+ */
+gulp.task('lint', (done) => {
+    runSequence(
+        ['lintScripts'],
+        done
+    );
+});
+
+/**
+ * Start a web server and reloads the browser file changes.
+ *
+ * @task watch
+ * @options --open
+ */
+gulp.task('watch', (done) => {
+
+    // BrowserSync setup
+    browserSync.init({
+        notify: false,
+        injectChanges: true,
+        open: (argv.open === true),
+        server: {
+            baseDir: env.DIR_DEST
+        }
+    }, (err, bs) => {
+        if (err) {
+            console.warn(err);
+        }
+
+    });
+
+    // Watch and trigger tasks on file changes
+    gulp.watch(env.DIR_SRC + '/assets/scripts/**/*', ['buildScripts']);
+    gulp.watch(env.DIR_SRC + '/assets/styles/**/*', ['buildStyles']);
+    gulp.watch(env.DIR_SRC + '/**/*.{hbs,html}', ['buildMarkup']);
+    gulp.watch(env.DIR_SRC + '/templates/jst/**/*', ['buildJST']);
+    gulp.watch([env.DIR_SRC + '/assets/{media,data}/**/*'], ['buildStatic']);
+});
+
+/**
+ * Helper task to builds and then watches files.
+ * Same as doing "gulp && gulp watch"
+ *
+ * @task launch
+ */
+gulp.task('launch', (done) => {
+    runSequence(
+        ['default'], ['watch'],
+        done
+    );
+});

examples/troubleshooting/README.md

@@ -0,0 +1,41 @@
+# CLIENT.Project
+
+## Build Files
+Builds the project either in the develop or production mode depending on what is set for ```BUILD_MODE``` in **build-env.js** file.
+
+    $ gulp
+
+    // Override the BUILD_MODE with one of the following flag
+    $ gulp --dev
+    $ gulp --prod
+
+By default the ```BUILD_MODE``` in **build-env.js** file production mode. Don't forget to change this so you not always building in production mode.
+
+## Watch Files
+
+    $ gulp watch
+
+	// Automatically open project in the browser:
+    $ gulp watch --open
+
+	// All at once:
+    $ gulp && gulp watch --open
+
+
+## Other Tasks
+
+    // Build YUIDocs:
+    $ gulp docs
+
+    // Check for linting issues:
+    $ gulp lint
+
+    // Helper task for "gulp && gulp watch"
+    $ gulp launch
+    $ gulp launch --open
+
+## Install
+After code is committed to source control and pulled down to another computer you will need to do the following:
+
+    $ cp build-env.js.dist build-env.js
+    $ npm install

examples/troubleshooting/bower.json

@@ -0,0 +1,9 @@
+{
+  "name": "client-project",
+  "version": "1.0.0",
+  "private": true,
+  "dependencies": {
+    "handlebars": "~4.0.5"
+  },
+  "devDependencies": {}
+}

examples/troubleshooting/build-env.js

@@ -0,0 +1,99 @@
+'use strict';
+
+/**
+ * Environment constants.
+ *
+ * This configuration file contains all of the environment-specific values
+ * needed to build a working website. The common values should be committed to
+ * the `build-env.js.dist` file. A non-committed environment-specific copy of
+ * the file should then be made to setup production, staging, and sandboxes as
+ * needed.
+ *
+ * @class Config
+ * @static
+ */
+var Config = {
+    /**
+     * The canonical address of the website. No trailing slash. Protocol may be
+     * omitted (http://www.paulirish.com/2010/the-protocol-relative-url/).
+     *
+     * @property URL_SITE
+     * @type {String}
+     */
+    URL_SITE: '//www.example.com',       // protocol-relative address
+//  URL_SITE: 'https://www.example.com', // absolute address
+
+    /**
+     * The base path of the website. Trailing slashes should be included for any
+     * path other than an empty page-relative value.
+     *
+     * @property URL_BASE
+     * @type {String}
+     */
+    URL_BASE: '',                       // page-relative base path
+//  URL_BASE: '/',                      // root-relative base path
+//  URL_BASE: '/foo/bar/',              // root-directory-relative base path
+//  URL_BASE: '//www.example.com/foo/', // absolute base path
+
+    /**
+     * Path where Node.js modules are installed. No trailing slash.
+     *
+     * @property DIR_NPM
+     * @type {String}
+     */
+    DIR_NPM: 'node_modules',
+
+    /**
+     * Path where Bower components are installed. No trailing slash.
+     *
+     * @property DIR_BOWER
+     * @type {String}
+     */
+    DIR_BOWER: 'src/assets/vendor',
+
+    /**
+     * Path to uncompiled source files. No trailing slash.
+     *
+     * @property DIR_SRC
+     * @type {String}
+     */
+    DIR_SRC: 'src',
+
+    /**
+     * Path to compiled output files. No trailing slash.
+     *
+     * @property DIR_DEST
+     * @type {String}
+     */
+    DIR_DEST: 'web',
+
+    /**
+     * Path to documentation output files. No trailing slash.
+     *
+     * @property DIR_DOCS
+     * @type {String}
+     */
+    DIR_DOCS: 'docs',
+
+    /**
+     * Value to determine what tasks should be triggered to build the output.
+     *
+     * @property BUILD_MODE
+     * @type {String} Options are 'dev' or 'prod'
+     */
+    BUILD_MODE: 'prod',
+
+    /**
+     * DANGER: Whether the Gulpfile should be allowed to modify directories
+     * outside of the current working directory (CDW). Should only be enabled
+     * if you understand the effects and repercussions. Useful when building
+     * in environments where only the contents of DIR_DEST should be publicly
+     * accessible.
+     *
+     * @property UNSAFE_MODE
+     * @type {Boolean}
+     */
+    UNSAFE_MODE: false
+};
+
+module.exports = Config;