Clean up outdated and deprecated dependencies

.gitignore

@@ -0,0 +1,2 @@
+*node_modules*
+*.DS_Store*

.npmignore

@@ -0,0 +1,3 @@
+.travis.yml
+TODO.md
+RELEASE-CHECKLIST.md

.travis.yml

@@ -0,0 +1,8 @@
+language: node_js
+node_js:
+  - "0.10"
+  - "0.11"
+script: ./bin/headstart.js
+branches:
+  only:
+    - master

LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Florian Vanthuyne <hello@flovan.me>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

README.md

@@ -1,7 +1,42 @@
-Boilerplate 0.2
-===============
+# [Headstart](website-url), an automated front-end setup
 
-An opinionated boilerplate/workflow build on modular snippets, including [Sass](http://sass-lang.com/), [Compass](http://compass-style.org/), [Respond](https://github.com/scottjehl/Respond), [Require](http://requirejs.org/), ... with a mobile-first approach. It's a collection of snippets & best practices combined to a personal workflow, with flexible re-usability and copy-paste-whatever-you-need in mind. Works great as a framework within [CodeKit](http://incident57.com/codekit/), but that's just a personal preference.  
-
-Feedback, questions, ...     
-Get in touch [@gwenvanhee](http://www.twitter.com/gwenvanhee)
+> Headstart is an all-in-one task runner that frees front-end developers of the little worries that come along with modern web development. If you ever wanted to use tools like [Grunt](http://gruntjs.com/) or [Gulp](http://gulpjs.com/), but found the configuration too troublesome, you will probably like this pre-configured setup better.
+
+[![NPM version][npm-image]][npm-url] [![NPM Downloads][downloads-image]][downloads-url] [![Gitter][gitter-image]][gitter-url]
+
+## Documentation
+
+  - [Getting started][getting-started-url]
+  - [Base Setup][base-setup-url]
+  - [Upgrading][ugrading-url]
+
+## ♥ Feedback
+
+What did you like? What didn't you like? Did you get stuck somewhere? Where the docs easy to follow, or did you give up at a certain point?
+
+This is a one-man project, so some approaches might be personated. Nevertheless, Headstart is meant to be used by other people as well, so your feedback is very valuable!
+
+[Mail me anything at all](mailto:hello@flovan.me) or [add an issue][issues-url].
+
+## Updates
+
+For all updates, follow [@headstartio][twitter-url] on Twitter.  
+Changes can be found on [the changelog page][changelog-url].
+
+[website-url]: http://headstart.io
+[getting-started-url]: http://headstart.io/installation
+[base-setup-url]: http://headstart.io/base-setup
+[changelog-url]: http://www.headstart.io/changelog
+[ugrading-url]: http://headstart.io/upgrading-guide
+[twitter-url]: https://twitter.com/headstartio
+[issues-url]: https://github.com/flovan/headstart/issues
+[npm-url]: https://npmjs.org/package/headstart
+[npm-image]: https://badge.fury.io/js/headstart.svg
+[travis-url]: https://travis-ci.org/flovan/headstart
+[travis-image]: https://travis-ci.org/flovan/headstart.svg
+[downloads-url]: https://github.com/flovan/headstart
+[downloads-image]: http://img.shields.io/npm/dm/headstart.svg
+[david-url]: https://david-dm.org/flovan/headstart
+[david-image]: https://david-dm.org/flovan/headstart.png?theme=shields.io
+[gitter-url]: https://gitter.im/flovan/headstart?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge
+[gitter-image]: https://badges.gitter.im/Join%20Chat.svg

RELEASE-CHECKLIST.md

@@ -0,0 +1,43 @@
+## Release checklist
+
+A list of things that need to work for each and every release.
+
+### Initialising
+
+- [ ] Boilerplate files have been updated and packaged into a release
+- [ ] The latest boilerplate release can be scaffolded through `hs init` *and* `headstart init`
+- [ ] Files can be served through the init
+- [ ] A browser can be opened from the init
+- [ ] An editor can be opened from the init
+
+### CLI testing
+
+- [ ] A build is successfull through `hs build`
+- [ ] A production build is success through `hs build --p` *and* `hs build --production`
+- [ ] Files can be served in development through `hs build --s` *and* `hs build --serve`
+- [ ] Files can be served in production through `hs build --s --p` *and* `hs build --serve --production`
+- [ ] A browser can be opened through `hs build --s --o` *and* `hs build --serve --open`
+- [ ] A browser can not be opened without `--s`
+- [ ] An editor can be opened through `hs build --e` *and* `hs build --edit` *and* `hs build --s --e` *and* `hs build --s --edit`
+- [ ] A tunnel can be initiated through `hs build --s --t` *and* `hs build --s --tunnel`
+- [ ] A custom tunnel can be initiated through `hs build --s --t=bla` *and* `hs build --s --tunnel=bla` and returns `bla.localtunnel.me` (or something) when available
+- [ ] Google PSI can be initiated through `hs build --s --t --psi`
+- [ ] The "mobile" PSI strategy can be set through `hs build --s --t --psi --strategy=mobile`
+- [ ] Google PSI can not be initiated without both `--s` and `--t`
+
+### Development
+
+- [ ] JS files get injected
+- [ ] Changes to JS files reload the page
+- [ ] Added/deleted JS files reload the page and update the injected files
+- [ ] CSS files get injected
+- [ ] Changes to CSS files update the page
+- [ ] Added/deleted CSS files reload the page and update the injected files
+- [ ] Images get copied over
+- [ ] Changes to images trigger a reload
+
+### Production
+
+- [ ] A `.favicon` is generated in the root
+- [ ] A `.htaccess` is generated in the root
+- [ ] All `./misc` files are copied over to the root

TODO.md

@@ -0,0 +1,71 @@
+### TODO's:
+
+  - [ ] Fix crash when missing `// requires` file is found 
+  - [ ] Adding new view js files doesn't seem to add them to gaze
+
+### A list of things to explore:
+
+  - [ ] Think about fixed size columns for eg ads
+  - [ ] Try to have revisioned images, even though updating references in other files will be hard (https://github.com/smysnk/gulp-rev-all, maybe https://www.npmjs.org/package/gulp-hash/ + https://www.npmjs.org/package/gulp-hash-references/)
+  - [ ] Watch changes on config and folders like fonts/video, and rebuild (https://github.com/leny/gulp-supervisor & https://github.com/JacksonGariety/gulp-nodemon & https://www.npmjs.org/package/keepup/)
+  - [ ] See if Commander is a better alternative to LiftOff (https://github.com/visionmedia/commander.js)
+  - [ ] Try replacing gulp-inject with gulp-include-source (https://www.npmjs.org/package/gulp-include-source/)
+  - [ ] See if scripts tasks can be made faster with gulp-remember (https://github.com/ahaurw01/gulp-remember)
+  - [ ] Maybe do something with icon fonts from SVG files (https://www.npmjs.org/package/gulp-fontcustom/ or https://github.com/nfroidure/gulp-iconfont or https://github.com/nfroidure/gulp-svgicons2svgfont)
+  - [ ] Make it possible to use LESS (https://www.npmjs.org/package/gulp-less/)
+  - [ ] Make it possible to use Stylus (https://www.npmjs.org/package/gulp-stylus/)
+  - [ ] Maybe replace some CSS processing modules with gulp-pleeease (https://www.npmjs.org/package/gulp-pleeease/)
+  - [ ] Try having critical css inlined (http://css-tricks.com/authoring-critical-fold-css/ & https://github.com/pocketjoso/penthouse/#as-a-node-module OR https://github.com/filamentgroup/criticalcss)
+  - [ ] Use SassDoc (https://github.com/SassDoc/gulp-sassdoc)
+  - [ ] Split up gulpfile into task files (https://github.com/whitneyit/gulp-taskify or https://www.npmjs.org/package/gulp-hub/)
+  - [ ] Remove deleted / renamed files from export folder with gulp-sync-files (https://www.npmjs.org/package/gulp-sync-files/)
+  - [ ] Replace Ender by Cash when it gets out of alpha (https://github.com/kenwheeler/cash)
+  - [ ] Check out HeadJS (http://headjs.com)
+  - [ ] Implement gulp-foreach (https://www.npmjs.org/package/gulp-foreach/)
+  - [ ] Make sure a key can be used with PSI (without any uncaught TypeError)
+  - [ ] Simpler watch setup > https://gist.github.com/Snugug/2dc9ff47ce4b4acb28f6
+
+
+  ### Take a look at these plugins also
+
+  - https://www.npmjs.org/package/del/ instead of gulp-rimraf (will prolly have to use https://www.npmjs.org/package/gulp-filenames)
+  - CDN Solution https://www.npmjs.org/package/gulp-cdnizer/
+  - https://www.npmjs.org/package/gulp-log-capture
+  - https://www.npmjs.org/package/gulp-static-handlebars
+  - https://www.npmjs.org/package/gulp-if-else
+  - https://www.npmjs.org/package/gulp-headerfooter
+  - https://www.npmjs.org/package/gulp-htmlrefs OR https://www.npmjs.org/package/gulp-rev-replace
+  - https://www.npmjs.org/package/favicons
+
+### Done
+
+  - [x] Fix reloading when a layout/partial changes
+  - [x] Find a better/smarter templating system https://www.npmjs.org/package/gulp-file-insert/
+  - [x] Find better (smaller, dep-less) way of stripping comments from --production HTML
+  - [x] Allow custom repo's to be set for scaffolding
+  - [x] Fix sass and htmlmin error crashes
+  - [x] Add W3C validation option to config (https://www.npmjs.org/package/gulp-w3cjs/)
+  - [x] Try out revisions to leverage cache control (https://github.com/sindresorhus/gulp-rev)
+  - [x] Generate a cache manifeset for --production (https://www.npmjs.org/package/gulp-manifest/ + http://diveintohtml5.info/offline.html)
+  - [x] Replace livereloading with browser-sync (https://github.com/shakyShane/browser-sync through http://shakyshane.com/gulpjs-sass-browsersync-ftw/)
+  - [x] ^ Fix logging by gulp-connect (~~muting https://www.npmjs.org/package/mute-stream~~)
+  - [x] Auto-check for updates (~~http://stackoverflow.com/questions/20686244/install-programmatically-a-npm-package-providing-its-version and http://stackoverflow.com/questions/11949419/nodejs-npm-show-latest-version-of-a-module~~ https://github.com/yeoman/update-notifier)
+  - [x] Make box-sizing work through inherit (http://css-tricks.com/inheriting-box-sizing-probably-slightly-better-best-practice)
+  - [x] Find a less crude way of muting module output through gulp-util
+  - [x] Put Liftoff logo on website (https://www.npmjs.org/package/liftoff)
+  - [x] Make HTML minifier options configurable through `config.json`
+  - [x] Properly test gulp-combine-media-queries (Result: saves a few KB's, enabling by default in boilerplate v1.1.1)
+  - [ ] ~~Use a different minifier (https://www.npmjs.org/package/gulp-compressor/ or https://www.npmjs.org/package/gulp-minifier/)~~
+  - [ ] ~~Check out csscss (https://www.npmjs.org/package/gulp-csscss/)~~
+  - [x] Properly test Uncss
+  - [x] Pass gulp-ruby-sass errors instead of uncss notification
+  - [x] Remove ender and underscore map from underscore.js
+  - [x] Turn aliasing into state, and extend to doc/button/form module
+  - [x] Fix url in update notice
+  - [x] Fix jshint logs appearing in the middle of the progressbar
+  - [x] Dry out modules
+  - [x] Drop `open` in favour of opening the browser through `browsersync`
+  - [x] A build starting with a Sass error will result in pages without (a) css file(s)
+  - [x] Disable (and warn about disabling of) w3c validation when not ".html"
+  - [x] Re-add `open` because openEditor won't work otherwise..
+

bin/headstart.js

@@ -0,0 +1,190 @@
+#!/usr/bin/env node
+'use strict';
+
+// To see an extended Error Stack Trace, uncomment
+// Error.stackTraceLimit = 9000;
+
+// REQUIRES -------------------------------------------------------------------
+//
+// Note: Gulp related requires are made further down to speed up the first
+// part of this script
+
+var 
+	path                = require('path'),
+	fs                  = require('fs'),
+	chalk               = require('chalk'),
+	_                   = require('lodash'),
+
+	pkg                 = require('../package.json'),
+	Liftoff             = require('liftoff'),
+	updateNotifier      = require('update-notifier'),
+	argv                = require('minimist')(process.argv.slice(2)),
+	gulp,
+	gulpFile
+;
+
+// CLI CONFIGURATION ----------------------------------------------------------
+//
+
+var cli = new Liftoff({
+	name: 'headstart'
+});
+
+// CHECK FOR UPDATES ----------------------------------------------------------
+//
+
+var notifier = updateNotifier({
+	packageName:    pkg.name,
+	packageVersion: pkg.version
+});
+
+if (notifier.update) {
+	// Inlined from the update-notifier source for more control
+	console.log(
+		chalk.yellow('\n\n┌──────────────────────────────────────────┐\n|') +
+		chalk.white(' Update available: ') +
+		chalk.green(notifier.update.latest) +
+		chalk.grey(' (current: ' + notifier.update.current + ') ') +
+		chalk.yellow('|\n|') +
+		chalk.white(' Instructions can be found on:            ') +
+		chalk.yellow('|\n|') +
+		chalk.magenta(' http://headstart.io/upgrading-guide   ') +
+		chalk.yellow('|\n') +
+		chalk.yellow('└──────────────────────────────────────────┘\n')
+	);
+}
+
+// LAUNCH CLI -----------------------------------------------------------------
+//
+
+cli.launch({}, launcher);
+
+function launcher (env) {
+
+	var 
+		versionFlag  = argv.v || argv.version,
+		infoFlag     = argv.i || argv.info || argv.h || argv.help,
+
+		allowedTasks = ['init', 'build'],
+		task         = argv._,
+		numTasks     = task.length
+	;
+
+	// Check for version flag
+	if (versionFlag) {
+		logHeader(pkg);
+		process.exit(0);
+	}
+
+	// Log info if no tasks are passed in
+	if (!numTasks) {
+		logInfo(pkg);
+		process.exit(0);
+	}
+
+	// Warn if more than one tasks has been passed in
+	if (numTasks > 1) {
+		console.log(chalk.red('\nOnly one task can be provided. Aborting.\n'));
+		logTasks();
+		process.exit(0);
+	}
+
+	// We are now sure we only have 1 task
+	task = task[0];
+
+	// Print info if needed
+	if(infoFlag) {
+		logInfo(pkg);
+		process.exit(0);
+	}
+
+	// Check if task is valid
+	if (_.indexOf(allowedTasks, task) < 0) {
+		console.log(chalk.red('\nThe provided task "' + task + '" was not recognized. Aborting.\n'));
+		logTasks();
+		process.exit(0);
+	}
+
+	// Change directory to where Headstart was called from
+	if (process.cwd() !== env.cwd) {
+		process.chdir(env.cwd);
+		console.log(chalk.cyan('Working directory changed to', chalk.magenta(env.cwd)));
+	}
+
+	// Require gulp assets
+	gulp     = require('gulp');
+	gulpFile = require(path.join(path.dirname(fs.realpathSync(__filename)), '../gulpfile.js'));
+
+	// Start the task through Gulp
+	process.nextTick(function () {
+		gulp.start.apply(gulp, [task]);
+	});
+}
+
+// HELPER FUNCTIONS -----------------------------------------------------------
+//
+
+function logInfo (pkg) {
+	logHeader(pkg);
+	logTasks();
+}
+
+function logHeader (pkg) {
+	console.log(
+		chalk.cyan(
+			'\n' +
+			'|                  |     |              |\n' +
+			'|---.,---.,---.,---|,---.|--- ,---.,---.|---\n' +
+			'|   ||---\',---||   |`---.|    ,---||    |\n' +
+			'`   \'`---\'`---^`---\'`---\'`---\'`---^`    `---\'\n\n'
+		) +
+		chalk.cyan.inverse('➳  http://headstart.io') +
+		'                 ' +
+		chalk.yellow.inverse('v' + pkg.version) + '\n'
+	);
+}
+
+function logTasks () {
+	console.log(
+		chalk.grey.underline('To start a new project, run:\n\n') +
+		chalk.magenta('headstart init [flags]') +
+		chalk.grey(' or ') +
+		chalk.magenta('hs init [flags]\n\n') +
+		chalk.white('--base <source>') +
+		chalk.grey('\t\tUse a custom boilerplate repo, eg. user/repo#branch\n')
+	);
+	console.log(
+		chalk.grey.underline('To build the project, run:\n\n') +
+		chalk.magenta('headstart build [flags]') +
+		chalk.grey(' or ') +
+		chalk.magenta('hs build [flags]\n\n') +
+		chalk.white('--s, --serve') +
+		chalk.grey('\t\tServe the files on a static address\n') +
+		chalk.white('--o, --open') +
+		chalk.grey('\t\tOpen up a browser for you (default Google Chrome)\n') +
+		chalk.white('--e, --edit') +
+		chalk.grey('\t\tOpen the files in your editor (default Sublime Text)\n') +
+		chalk.white('--p, --production') +
+		chalk.grey('\tMake a production ready build\n') +
+		chalk.white('--t, --tunnel') +
+		chalk.grey('\t\tTunnel your served files to the web (requires --serve)\n') +
+		chalk.white('--psi') +
+		chalk.grey('\t\t\tRun PageSpeed Insights (requires --serve and --tunnel)\n') +
+		//chalk.white('--key <key>') +
+		//chalk.grey('\t\tOptional, an API key for PSI\n') +
+		chalk.white('--strategy <type>') +
+		chalk.grey('\tRun PSI in either "desktop" (default) or "mobile" mode\n\n') +
+		chalk.white('--verbose') +
+		chalk.grey('\t\tOutput extra information while building\n')
+	);
+	console.log(
+		chalk.grey.underline('For information, run:\n\n') +
+		chalk.magenta('headstart [flags]') +
+		chalk.grey(' or ') +
+		chalk.magenta('hs [flags]\n\n') +
+		chalk.white('--i, --info,\n--h, --help') +
+		chalk.grey('\t\tPrint out this message\n') +
+		chalk.white('--v, --version') +
+		chalk.grey('\t\tPrint out version\n')
+	);
+}