Collapse boilerplate in a single commit

First prototype

Added the README

Fixed the hot module replacement

Minor adjustments on readme

Normalizing the env vars and using it capitalized

Added info about the react.js branch

Fix babel transpiling

Using yarn

Removing the babel package, just the babel-core does the job

Using just the dependencies key on package.json

Since it isn't a lib package doesn't matter the separation between
devDependencies and dependencies.

Updating the css-loader

Updating the fs-extra

Moving the utility packages to utils folder

Better description

Adds the license

closes #3

Write the env vars on the bundle file

http://dev.topheman.com/make-your-react-production-minified-version-with-webpack/

Fixs the hot reload setup

Sringifies the env object to define plugin

Uses the webpack html plugin to generate the pages in a less hacky way

Uses the write-file-webpack-plugin

this plugin allows the webpack write on disk all files, even running
with the webserver, which is necessary to the hot reload.

this plugin also help us to remove nasty hacks and expose bundles to
other extension features.

Allows exclude some entry points to be hot reloaded

It's useful for content scripts that can't keep the connection with the
webpack endpoint.

Updates the webpack

Updates the README with instructions about the content scripts

resolves #4

Updates to Webpack 2

closes #8

Expand the DefinePlugin usage

In Webpack 1, the replaced value at compile time by define plugin was placed with
parenthesis, like ({"NODE_ENV":"development","PORT":3000}), now, it not works in
this way, breaking the app.

So, to simplify the things, this commit just passes the NODE_ENV var.

Fix README

Exclude /node_modules/ from babel and css transpiling #9

Source maps to help debugging

closes #10

Removes the forbidden webpack config 'chromeExtensionBoilerplate'
before build and webserver's start

Although I know that it's not a good practice, right now I don't know a
good way to keep the boilerplate configs simple as it is today without
this hacky solution, so, until we came with a better solution, we'll
remove the key before build and webserver's start.

  #9

Update README.md

Removing babel.js

Basically, we don't need transpiling with babel since Webpack 2 take care of
ES6 modules transpiling and the ES2015 is supported by Chrome.

  kudos @gagarine

  resolve #16

Setup boilerplate to load images and other assets in html and css

resolves #18
resolves #23
resolves #14
resolves #12

Added icons and images boilerplate

Split dependencies on package.json

resolves #15

Webpack config improvements (#26)

- Use CopyWebpackPlugin to generate `manifest.json` file
- Use CleanWebpackPlugin to clear build folder

Minor README adjustments

* explicitly the required node version
* pointing to yarn install instructions page instead suggest install
with npm. the yarn page will be always updated to the best way to install
the yarn.

closes #28

Adding the contribution guidelines

.gitignore

@@ -0,0 +1,3 @@
+node_modules
+build
+secrets.*.js

LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2016 Samuel Simões
+
+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

@@ -0,0 +1,113 @@
+# Chrome Extension Webpack Boilerplate
+
+A basic foundation boilerplate for rich Chrome Extensions using [Webpack](https://webpack.github.io/) to help you write modular and modern Javascript code, load CSS easily and [automatic reload the browser on code changes](https://webpack.github.io/docs/webpack-dev-server.html#automatic-refresh).
+
+## Developing a new extension
+_I'll assume that you already read the [Webpack docs](https://webpack.github.io/docs) and the [Chrome Extension](https://developer.chrome.com/extensions/getstarted) docs._
+
+
+1. Check if your Node.js version is >= 6.
+2. Clone the repository.
+3. Install [yarn](https://yarnpkg.com/lang/en/docs/install/).
+4. Run `yarn`.
+5. Change the package's name and description on `package.json`.
+6. Change the name of your extension on `src/manifest.json`.
+7. Run `npm run start`
+8. Load your extension on Chrome following:
+    1. Access `chrome://extensions/`
+    2. Check `Developer mode`
+    3. Click on `Load unpacked extension`
+    4. Select the `build` folder.
+8. Have fun.
+
+## Structure
+All your extension's development code must be placed in `src` folder, including the extension manifest.
+
+The boilerplate is already prepared to have a popup, a options page and a background page. You can easily customize this.
+
+Each page has its own [assets package defined](https://github.com/samuelsimoes/chrome-extension-webpack-boilerplate/blob/master/webpack.config.js#L16-L20). So, to code on popup you must start your code on `src/js/popup.js`, for example.
+
+You must use the [ES6 modules](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/import) to a better code organization. The boilerplate is already prepared to that and [here you have a little example](https://github.com/samuelsimoes/chrome-extension-webpack-boilerplate/blob/master/src/js/popup.js#L2-L4).
+
+## Webpack auto-reload and HRM
+To make your workflow much more efficient this boilerplate uses the [webpack server](https://webpack.github.io/docs/webpack-dev-server.html) to development (started with `npm run server`) with auto reload feature that reloads the browser automatically every time that you save some file o your editor.
+
+You can run the dev mode on other port if you want. Just specify the env var `port` like this:
+
+```
+$ PORT=6002 npm run start
+```
+
+## Content Scripts
+
+Although this boilerplate uses the webpack dev server, it's also prepared to write all your bundles files on the disk at every code change, so you can point, on your extension manifest, to your bundles that you want to use as [content scripts](https://developer.chrome.com/extensions/content_scripts), but you need to exclude these entry points from hot reloading [(why?)](https://github.com/samuelsimoes/chrome-extension-webpack-boilerplate/issues/4#issuecomment-261788690). To do so you need to expose which entry points are content scripts on the `webpack.config.js` using the `chromeExtensionBoilerplate -> notHotReload` config. Look the example below.
+
+Let's say that you want use the `myContentScript` entry point as content script, so on your `webpack.config.js` you will configure the entry point and exclude it from hot reloading, like this:
+
+```js
+{
+  …
+  entry: {
+    myContentScript: "./src/js/myContentScript.js"
+  },
+  chromeExtensionBoilerplate: {
+    notHotReload: ["myContentScript"]
+  }
+  …
+}
+```
+
+and on your `src/manifest.json`:
+
+```json
+{
+  "content_scripts": [
+    {
+      "matches": ["https://www.google.com/*"],
+      "js": ["myContentScript.bundle.js"]
+    }
+  ]
+}
+
+```
+
+## Packing
+After the development of your extension run the command
+
+```
+$ NODE_ENV=production npm run build
+```
+Now, the content of `build` folder will be the extension ready to be submitted to the Chrome Web Store. Just take a look at the [official guide](https://developer.chrome.com/webstore/publish) to more infos about publishing.
+
+## Secrets
+If you are developing an extension that talks with some API you probably are using different keys for testing and production. Is a good practice you not commit your secret keys and expose to anyone that have access to the repository.
+
+To this task this boilerplate import the file `./secrets.<THE-NODE_ENV>.js` on your modules through the module named as `secrets`, so you can do things like this:
+
+_./secrets.development.js_
+
+```js
+export default { key: "123" };
+```
+
+_./src/popup.js_
+
+```js
+import secrets from "secrets";
+ApiCall({ key: secrets.key });
+```
+:point_right: The files with name `secrets.*.js` already are ignored on the repository.
+
+## With React.js
+:bulb: If you want use [React.js](https://facebook.github.io/react/) with this boilerplate, check the **[react branch](https://github.com/samuelsimoes/chrome-extension-webpack-boilerplate/tree/react)**.
+
+
+## Contributing
+
+1. **Please!! Do not create a pull request without an issue before discussing the problem.**
+2. On your PR make sure that you are following the current codebase style.
+3. Your PR must be single purpose. Resolve just one problem on your PR.
+4. Make sure to commit in the same style that we are committing until now on the project.
+
+-------------
+Samuel Simões ~ [@samuelsimoes](https://twitter.com/samuelsimoes) ~ [Blog](http://blog.samuelsimoes.com/)

package.json

@@ -0,0 +1,22 @@
+{
+  "name": "chrome-extension-webpack",
+  "version": "0.0.1",
+  "description": "A boilerplate to chrome extension with webpack",
+  "scripts": {
+    "build": "node utils/build.js",
+    "start": "node utils/webserver.js"
+  },
+  "devDependencies": {
+    "clean-webpack-plugin": "^0.1.17",
+    "copy-webpack-plugin": "^4.2.0",
+    "css-loader": "^0.25.0",
+    "file-loader": "^0.11.2",
+    "fs-extra": "^0.30.0",
+    "html-loader": "^0.4.5",
+    "html-webpack-plugin": "2.24.1",
+    "style-loader": "^0.13.0",
+    "webpack": "2.2.1",
+    "webpack-dev-server": "^2.3.0",
+    "write-file-webpack-plugin": "3.4.2"
+  }
+}

src/background.html

@@ -0,0 +1,9 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="UTF-8">
+  <title></title>
+</head>
+<body>
+</body>
+</html>

src/js/background.js

@@ -0,0 +1,2 @@
+import '../img/icon-128.png'
+import '../img/icon-34.png'

src/js/options.js

@@ -0,0 +1 @@
+import "../css/options.css";

src/js/popup.js

@@ -0,0 +1,4 @@
+import "../css/popup.css";
+import hello from "./popup/example";
+
+hello();

src/js/popup/example.js

@@ -0,0 +1,3 @@
+export default function () {
+  alert("hello! (find me on src/js/popup/example.js)");
+};

src/manifest.json

@@ -0,0 +1,16 @@
+{
+  "name": "Chrome Extension Webpack",
+  "options_page": "options.html",
+  "background": {
+    "page": "background.html"
+  },
+  "browser_action": {
+    "default_popup": "popup.html",
+    "default_icon": "icon-34.png"
+  },
+  "icons": {
+    "128": "icon-128.png"
+  },
+  "manifest_version": 2,
+  "content_security_policy": "script-src 'self' 'unsafe-eval'; object-src 'self'"
+}

src/options.html

@@ -0,0 +1,9 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="UTF-8">
+  <title></title>
+</head>
+<body>
+</body>
+</html>

src/popup.html

@@ -0,0 +1,11 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="UTF-8">
+  <title></title>
+</head>
+<body>
+  <h1>Hello!</h1>
+  <img src="img/icon-128.png">
+</body>
+</html>

utils/build.js

@@ -0,0 +1,9 @@
+var webpack = require("webpack"),
+    config = require("../webpack.config");
+
+delete config.chromeExtensionBoilerplate;
+
+webpack(
+  config,
+  function (err) { if (err) throw err; }
+);

utils/env.js

@@ -0,0 +1,5 @@
+// tiny wrapper with default env vars
+module.exports = {
+  NODE_ENV: (process.env.NODE_ENV || "development"),
+  PORT: (process.env.PORT || 3000)
+};

utils/webserver.js

@@ -0,0 +1,34 @@
+var WebpackDevServer = require("webpack-dev-server"),
+    webpack = require("webpack"),
+    config = require("../webpack.config"),
+    env = require("./env"),
+    path = require("path");
+
+var options = (config.chromeExtensionBoilerplate || {});
+var excludeEntriesToHotReload = (options.notHotReload || []);
+
+for (var entryName in config.entry) {
+  if (excludeEntriesToHotReload.indexOf(entryName) === -1) {
+    config.entry[entryName] =
+      [
+        ("webpack-dev-server/client?http://localhost:" + env.PORT),
+        "webpack/hot/dev-server"
+      ].concat(config.entry[entryName]);
+  }
+}
+
+config.plugins =
+  [new webpack.HotModuleReplacementPlugin()].concat(config.plugins || []);
+
+delete config.chromeExtensionBoilerplate;
+
+var compiler = webpack(config);
+
+var server =
+  new WebpackDevServer(compiler, {
+    hot: true,
+    contentBase: path.join(__dirname, "../build"),
+    headers: { "Access-Control-Allow-Origin": "*" }
+  });
+
+server.listen(env.PORT);

webpack.config.js

@@ -0,0 +1,94 @@
+var webpack = require("webpack"),
+    path = require("path"),
+    fileSystem = require("fs"),
+    env = require("./utils/env"),
+    CleanWebpackPlugin = require("clean-webpack-plugin"),
+    CopyWebpackPlugin = require("copy-webpack-plugin"),
+    HtmlWebpackPlugin = require("html-webpack-plugin"),
+    WriteFilePlugin = require("write-file-webpack-plugin");
+
+// load the secrets
+var alias = {};
+
+var secretsPath = path.join(__dirname, ("secrets." + env.NODE_ENV + ".js"));
+
+var fileExtensions = ["jpg", "jpeg", "png", "gif", "eot", "otf", "svg", "ttf", "woff", "woff2"];
+
+if (fileSystem.existsSync(secretsPath)) {
+  alias["secrets"] = secretsPath;
+}
+
+var options = {
+  entry: {
+    popup: path.join(__dirname, "src", "js", "popup.js"),
+    options: path.join(__dirname, "src", "js", "options.js"),
+    background: path.join(__dirname, "src", "js", "background.js")
+  },
+  output: {
+    path: path.join(__dirname, "build"),
+    filename: "[name].bundle.js"
+  },
+  module: {
+    rules: [
+      {
+        test: /\.css$/,
+        loader: "style-loader!css-loader",
+        exclude: /node_modules/
+      },
+      {
+        test: new RegExp('\.(' + fileExtensions.join('|') + ')$'),
+        loader: "file-loader?name=[name].[ext]",
+        exclude: /node_modules/
+      },
+      {
+        test: /\.html$/,
+        loader: "html-loader",
+        exclude: /node_modules/
+      }
+    ]
+  },
+  resolve: {
+    alias: alias
+  },
+  plugins: [
+    // clean the build folder
+    new CleanWebpackPlugin(["build"]),
+    // expose and write the allowed env vars on the compiled bundle
+    new webpack.DefinePlugin({
+      "process.env.NODE_ENV": JSON.stringify(env.NODE_ENV)
+    }),
+    new CopyWebpackPlugin([{
+      from: "src/manifest.json",
+      transform: function (content, path) {
+        // generates the manifest file using the package.json informations
+        return Buffer.from(JSON.stringify({
+          description: process.env.npm_package_description,
+          version: process.env.npm_package_version,
+          ...JSON.parse(content.toString())
+        }))
+      }
+    }]),
+    new HtmlWebpackPlugin({
+      template: path.join(__dirname, "src", "popup.html"),
+      filename: "popup.html",
+      chunks: ["popup"]
+    }),
+    new HtmlWebpackPlugin({
+      template: path.join(__dirname, "src", "options.html"),
+      filename: "options.html",
+      chunks: ["options"]
+    }),
+    new HtmlWebpackPlugin({
+      template: path.join(__dirname, "src", "background.html"),
+      filename: "background.html",
+      chunks: ["background"]
+    }),
+    new WriteFilePlugin()
+  ]
+};
+
+if (env.NODE_ENV === "development") {
+  options.devtool = "cheap-module-eval-source-map";
+}
+
+module.exports = options;