Simple Chrome Extension generator

Maintainer: Stephen Collins

Chrome Extension generator that creates everything you need to get started with extension development. Includes grunt tasks for easy generation of debug and release builds.

Getting Started

• First make a new directory, and cd into it: mkdir my-new-chrome-extension && cd $_
• Install the generator: npm install -g generator-chrome-extension-simple
• Run: yo chrome-extension-simple

Need more information about Chrome Extension? Please visit Google Chrome Extension Develpment

Generators

Available generators:

• chrome-extension-simple (aka chrome-extension-simple:app)

App

Sets up a new Chrome Extension, generating all the boilerplate you need to get started.

yo chrome-extension-simple

Test Chrome Extension

To test, go to: chrome://extensions, enable Developer mode and load app as an unpacked extension by selecting the build directory within your project.

Grunt tasks

Debug

Debug task helps reduce your efforts during development.

grunt
(or)
grunt debug

Build

By default, generators compress the file that was created by building a js/css/html/resource file. You can distribute the compressed (.zip) file using the Chrome Developer Dashboard to publish to the Chrome Web Store.

Run this command to build your Chrome Extension project.

grunt build

Grunt will automatically increment your patch version and create a new compressed file for that version.

Bower Dependency Management

In an effort to reduce distributable package size, this generator includes a dependencies.json configuration file.

module.exports = {
  build: {
    options: {
      dependencies: [{
          "src": "bower/jquery/dist/jquery.min.js",
          "dest": "app/libs/js/jquery.min.js"
      }]
    }
  }
}

The dependencies property contains an array of objects with src and dest properties. src referrers to the relative path to a bower dependency, while dest specifies where to copy the file(s) during build. jQuery has been included by default as an example.

Options

• --skip-install

  Skips the automatic execution of bower and npm after scaffolding has finished.

License

MIT