Scaffolding to run a command

Author: kumar303

.babelrc

@@ -0,0 +1,7 @@
+{
+  "presets": ["es2015", "stage-2"],
+  "plugins": [
+    "transform-class-properties",
+    "transform-es2015-modules-commonjs",
+  ]
+}

.gitignore

@@ -1,5 +1,10 @@
 # OSX
 .DS_Store
 
+# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Build artifacts.
 npm-debug.log
 node_modules
+dist/*

Gruntfile.js

@@ -0,0 +1,31 @@
+var fs = require('fs');
+
+module.exports = function(grunt) {
+
+  // load all grunt tasks matching the ['grunt-*', '@*/grunt-*'] patterns
+  require('load-grunt-tasks')(grunt);
+
+  var configs = require('load-grunt-configs')(grunt, {
+    config: {
+      src: 'tasks/*.js',
+    },
+  });
+
+  grunt.initConfig(configs);
+
+  grunt.registerTask('build', [
+    'webpack:build',
+  ]);
+
+  grunt.registerTask('watch-build', [
+    'webpack:watchBuild',
+  ]);
+
+  grunt.registerTask('test', [
+    'webpack:build',
+    'mochaTest',
+    'newer:eslint',
+    'newer:jscs',
+  ]);
+
+};

README.md

@@ -7,6 +7,10 @@ Ultimately, it aims to support web extensions in a standard, portable,
 cross-platform way. Initially, it will provide a streamlined experience for developing
 [Firefox web extensions](https://developer.mozilla.org/en-US/Add-ons/WebExtensions).
 
+## Installation
+
+This tool is not yet ready for installation. Stay tuned.
+
 ## Should I Use It?
 
 This tool may require using a
@@ -20,6 +24,20 @@ consider [jpm](https://github.com/mozilla-jetpack/jpm/).
 Hi! This tool is under active development. To get involved you can watch the repo,
 file issues, create pull requests, or ask a question on
 [dev-addons](https://mail.mozilla.org/listinfo/dev-addons).
+Read on for how to develop new features.
+
+## Development
+
+You'll need:
+* [Node.js](https://nodejs.org/en/), 0.12 or higher
+* [npm](https://www.npmjs.com/) installed globally
+
+To get started, clone the source and run `npm install`.
+
+### Build web-ext
+
+Run `npm build` to build a new version of the `./bin/web-ext` command. You can
+continously rebuild the package as you edit files by running `npm watch-build`.
 
 ## Some Questions and Answers
 

bin/web-ext

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+
+require('../dist/web-ext').main();

package.json

@@ -2,7 +2,15 @@
   "name": "web-ext",
   "version": "0.0.1",
   "description": "A command line tool to help build, run, and test web extensions",
-  "main": "index.js",
+  "main": "dist/web-ext.js",
+  "bin": {
+    "web-ext": "bin/web-ext"
+  },
+  "scripts": {
+    "build": "node -e \"require('grunt').cli()\" null build",
+    "watch-build": "node -e \"require('grunt').cli()\" null watch-build",
+    "test": "node -e \"require('grunt').cli()\" null test"
+  },
   "homepage": "https://github.com/mozilla/web-ext",
   "repository": {
     "type": "git",
@@ -23,11 +31,36 @@
     "chrome",
     "opera"
   ],
-  "dependencies": {},
-  "devDependencies": {},
+  "dependencies": {
+    "babel-polyfill": "6.3.14",
+    "es6-promisify": "3.0.0",
+    "yargs": "3.32.0"
+  },
+  "devDependencies": {
+    "babel-core": "6.4.5",
+    "babel-eslint": "4.1.7",
+    "babel-loader": "6.2.1",
+    "babel-plugin-transform-class-properties": "6.4.0",
+    "babel-plugin-transform-es2015-modules-commonjs": "6.4.5",
+    "babel-preset-es2015": "6.1.2",
+    "babel-preset-stage-2": "6.1.2",
+    "chai": "3.5.0",
+    "eslint": "1.10.3",
+    "grunt": "0.4.5",
+    "grunt-contrib-clean": "0.7.0",
+    "grunt-contrib-copy": "0.8.2",
+    "grunt-eslint": "17.3.1",
+    "grunt-jscs": "2.7.0",
+    "grunt-mocha-test": "0.12.7",
+    "grunt-newer": "1.1.1",
+    "grunt-webpack": "1.0.11",
+    "load-grunt-configs": "0.4.3",
+    "load-grunt-tasks": "3.3.0",
+    "mocha": "2.4.5",
+    "sinon": "1.17.3",
+    "webpack": "1.12.12",
+    "webpack-dev-server": "1.14.0"
+  },
   "author": "Kumar McMillan",
-  "license": "MPL-2.0",
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
-  }
+  "license": "MPL-2.0"
 }

src/main.js

@@ -0,0 +1,3 @@
+export function main() {
+  console.log("It's nice! Not really. Sooooon.");
+}

tasks/mochaTest.js

@@ -0,0 +1,7 @@
+module.exports = {
+  options: {
+    timeout: 1000,
+    reporter: 'spec',
+  },
+  all: ['dist/tests.js'],
+};

tasks/webpack.js

@@ -0,0 +1,37 @@
+var grunt = require('grunt');
+var path = require('path');
+var webpackConfig = require('../webpack.config.js');
+
+var defaultResolve = webpackConfig.resolve;
+
+function noddyClone(obj) {
+  return JSON.parse(JSON.stringify(obj));
+}
+
+var buildResolve = noddyClone(defaultResolve);
+buildResolve.modulesDirectories.push('src/');
+
+var testConfig = {
+  entry: './tests/runner.js',
+  output: {
+    path: path.join(__dirname, '../dist'),
+    filename: 'tests.js',
+  },
+};
+
+module.exports = {
+  options: webpackConfig,
+  build: {
+    resolve: buildResolve,
+  },
+  watchBuild: {
+    watch: true,
+    keepalive: true,
+    resolve: buildResolve,
+  },
+  test: {
+    entry: testConfig.entry,
+    output: testConfig.output,
+    resolve: buildResolve,
+  },
+};

webpack.config.js

@@ -0,0 +1,50 @@
+var webpack = require('webpack');
+var path = require('path');
+var fs = require('fs');
+
+var nodeModules = {};
+
+// This is to filter out node_modules as we don't want them
+// to be made part of any bundles.
+fs.readdirSync('node_modules')
+  .filter(function(x) {
+    return ['.bin'].indexOf(x) === -1;
+  })
+  .forEach(function(mod) {
+    // jscs:disable requireTemplateStrings
+    nodeModules[mod] = 'commonjs ' + mod;
+    // jscs:enable requireTemplateStrings
+  });
+
+
+module.exports = {
+  entry: './src/main.js',
+  target: 'node',
+  output: {
+    path: path.join(__dirname, 'dist'),
+    filename: 'web-ext.js',
+    libraryTarget: 'commonjs2',
+  },
+  module: {
+    loaders: [
+      {
+        exclude: /(node_modules|bower_components)/,
+        test: /\.js$/,
+        // babel options are in .babelrc
+        loaders: ['babel'],
+      },
+    ],
+  },
+  externals: nodeModules,
+  plugins: [
+    new webpack.BannerPlugin('require("source-map-support").install();',
+                             { raw: true, entryOnly: false }),
+  ],
+  resolve: {
+    extensions: ['', '.js', '.json'],
+    modulesDirectories: [
+      'node_modules',
+    ],
+  },
+  devtool: 'sourcemap',
+};