Top Related Projects
Scaffold out a Chrome extension
⚡️ A template for building cross browser extensions for Chrome, Opera & Firefox.
🖥🔋Web Extension starter to build "Write Once Run on Any Browser" extension
🚀 The CLI for your next Chrome Extension
Quick Overview
Generator-chrome-extension is a Yeoman generator for creating Chrome extensions. It provides a scaffolding tool to quickly set up the basic structure and files needed for a Chrome extension project, including manifest files, background scripts, and content scripts.
Pros
- Streamlines the process of creating a new Chrome extension project
- Generates a well-organized file structure following best practices
- Includes options for different types of extensions (browser action, page action, etc.)
- Supports modern JavaScript features and build tools
Cons
- May require familiarity with Yeoman and its ecosystem
- Generated project structure might not fit all use cases or preferences
- Limited customization options during initial generation
- Maintenance and updates may lag behind the latest Chrome extension API changes
Getting Started
To use generator-chrome-extension, follow these steps:
-
Install Yeoman and the generator:
npm install -g yo generator-chrome-extension
-
Create a new directory for your project and navigate to it:
mkdir my-chrome-extension && cd my-chrome-extension
-
Run the generator:
yo chrome-extension
-
Follow the prompts to configure your extension.
-
Once generated, you can start developing your Chrome extension using the created file structure and build tools.
Competitor Comparisons
Scaffold out a Chrome extension
Pros of generator-chrome-extension
- Streamlined setup process for Chrome extension development
- Includes boilerplate code and structure for quick start
- Supports modern JavaScript features and build tools
Cons of generator-chrome-extension
- May include unnecessary files or dependencies for simple extensions
- Requires familiarity with Yeoman and its ecosystem
- Limited customization options during initial generation
Code Comparison
generator-chrome-extension:
// Example of generated manifest.json
{
"name": "__MSG_appName__",
"version": "0.0.1",
"manifest_version": 2,
"description": "__MSG_appDescription__",
"icons": {
"16": "images/icon-16.png",
"128": "images/icon-128.png"
}
}
Both repositories appear to be the same project, as the comparison is between identical repositories. The code example provided is a typical manifest.json file that would be generated by the generator-chrome-extension tool. This file is essential for Chrome extensions, defining metadata and permissions.
The generator-chrome-extension project aims to simplify the process of creating Chrome extensions by providing a scaffolding tool. It sets up a basic project structure, including necessary files like manifest.json, background scripts, and content scripts. This can save developers time and ensure a consistent starting point for extension development.
⚡️ A template for building cross browser extensions for Chrome, Opera & Firefox.
Pros of extension-boilerplate
- Simpler setup process, ready to use out of the box
- Includes a basic UI with popup and options pages
- Provides a more comprehensive boilerplate structure
Cons of extension-boilerplate
- Less customizable initial setup compared to generator-chrome-extension
- May include unnecessary files for some projects
- Limited to a specific structure, which might not suit all extension types
Code Comparison
extension-boilerplate:
import ext from "./utils/ext";
ext.runtime.onMessage.addListener(
function(request, sender, sendResponse) {
if(request.action === "perform-save") {
console.log("Extension Type: ", "/* @echo extension */");
console.log("PERFORM AJAX", request.data);
sendResponse({ action: "saved" });
}
}
);
generator-chrome-extension:
chrome.runtime.onInstalled.addListener(function (details) {
console.log('previousVersion', details.previousVersion);
});
chrome.tabs.onUpdated.addListener(function (tabId) {
chrome.tabs.get(tabId, function (tab) {
if (tab.url.indexOf('chrome://') === 0) {
return;
}
});
});
The code snippets show different approaches to handling extension events. extension-boilerplate uses a custom ext
utility, while generator-chrome-extension directly uses Chrome APIs. The former provides a more abstracted approach, while the latter offers more direct control over Chrome-specific functionality.
🖥🔋Web Extension starter to build "Write Once Run on Any Browser" extension
Pros of web-extension-starter
- Supports multiple browsers (Chrome, Firefox, Opera, Edge) out of the box
- Uses modern technologies like TypeScript, React, and Webpack
- Includes a comprehensive set of linting and formatting tools
Cons of web-extension-starter
- May have a steeper learning curve for beginners due to its use of advanced technologies
- Potentially more complex setup process compared to generator-chrome-extension
Code Comparison
web-extension-starter:
import React from 'react';
import ReactDOM from 'react-dom';
import Popup from './Popup';
ReactDOM.render(<Popup />, document.getElementById('popup-root'));
generator-chrome-extension:
document.addEventListener('DOMContentLoaded', function() {
var checkPageButton = document.getElementById('checkPage');
checkPageButton.addEventListener('click', function() {
chrome.tabs.getSelected(null, function(tab) {
alert("Hello from your Chrome extension!");
});
}, false);
}, false);
The web-extension-starter uses React for rendering the popup, while generator-chrome-extension uses vanilla JavaScript for DOM manipulation and event handling. This showcases the more modern approach of web-extension-starter, which can lead to more maintainable and scalable code but may require more setup and knowledge of React.
🚀 The CLI for your next Chrome Extension
Pros of chrome-extension-cli
- More recent updates and active maintenance
- Simpler setup process with fewer dependencies
- Better support for modern JavaScript features and tooling
Cons of chrome-extension-cli
- Less customization options during initial setup
- Fewer boilerplate templates available
- Limited documentation compared to generator-chrome-extension
Code Comparison
generator-chrome-extension:
'use strict';
const Generator = require('yeoman-generator');
const chalk = require('chalk');
const yosay = require('yosay');
module.exports = class extends Generator {
// ...
};
chrome-extension-cli:
#!/usr/bin/env node
const fs = require('fs-extra');
const path = require('path');
const chalk = require('chalk');
const { program } = require('commander');
// ...
Both projects use similar dependencies like chalk for colorized output, but chrome-extension-cli uses a more modern approach with ES6 modules and the commander library for CLI argument parsing. generator-chrome-extension relies on the Yeoman framework, which provides a more structured but potentially more complex setup.
chrome-extension-cli offers a more streamlined experience for developers who want to quickly set up a Chrome extension project with minimal configuration. However, generator-chrome-extension may be better suited for those who need more customization options and don't mind a slightly steeper learning curve.
Convert
designs to code with AI
Introducing Visual Copilot: A new AI model to turn Figma designs to high quality code using your components.
Try Visual CopilotREADME
Chrome Extension generator 
Maintainer: Jimmy Moon
Chrome Extension generator that creates everything you need to get started with extension development. You can choose Browser UI(Browser,Page Action, Omnibox) type and select into permissions what you need.
Getting Started
# Please make sure that `yo`, `gulp` and `bower` was installed on your system using this command:
npm install --global yo gulp-cli bower
# Install the generator:
npm install -g generator-chrome-extension
# Make a new directory, and `cd` get into it:
mkdir my-new-chrome-extension && cd $_
# Generate a new project
yo chrome-extension
# Transform updated source written by ES2015 (default option)
gulp babel
# or Using watch to update source continuously
gulp watch
# Make a production version extension
gulp build
Test Chrome Extension
To test, go to: chrome://extensions, enable Developer mode and load app as an unpacked extension.
Need more information about Chrome Extension? Please visit Google Chrome Extension Development
Generators
Available generators:
App
Sets up a new Chrome Extension, generating all the boilerplate you need to get started.
yo chrome-extension
gulp tasks
Babel
The generator supports ES 2015 syntax through babel transforming. You may have a source files in script.babel
if your project has been generated without --no-babel
options. While developing, When those of source has been changed, gulp babel
should be run before test and run a extension on Chrome.
gulp babel
If you would like to have a continuous transforming by babel you can use watch
task
Watch
Watch task helps you reduce your efforts during development extensions. If the task detects your changes of source files, re-compile your sources automatically or Livereload(chromereload.js) reloads your extension. If you would like to know more about Live-reload and preview of Yeoman? Please see Getting started with Yeoman and generator-webapp for your understanding.
gulp watch
You need to load/reload extension after starting gulp watch
for Live-reload to work.
For content scripts you need to refresh pages where it is used.
Build and Package
It will build your app as a result you can have a distribution version of the app in dist
. Run this command to build your Chrome Extension app.
gulp build
You can also distribute your project with compressed file using the Chrome Developer Dashboard at Chrome Web Store. This command will compress your app built by gulp build
command.
gulp package
Options
-
--no-babel
If you wouldn't use Babel ES2015 transpiler.
-
--skip-install
Skips the automatic execution of
bower
andnpm
after scaffolding has finished. -
--test-framework=[framework]
Defaults to
mocha
. Can be switched for another supported testing framework likejasmine
. -
--sass
Add support for Sass.
-
--all-permissions
All of permissions of chrome extension will be shown.
ES2015 and babel
ES2015 is the default option
in the generator that means you can use es2015 now for developing the Chrome extensions. However, at this moment, you need to execute babel
task of gulp to compile to test and run your extension on Chrome, because ES2015 is not full functionality on Chrome as yet.
The sources written by es2015 is located at scripts.babel
and runnable sources will be at script
after compiling by gulp babel
. May you don't want to use babel and ES2015 use --no-babel
option when scaffolding a new project.
yo chrome-extension --no-babel
Sass
This generator supports sass
through --sass
options and generate scss
boilerplate files at styles.scss
that those of scss
files will be compiled to styles
via gulp style
task. To do this, libsass
is featured in the generator. Please see this for further information.
yo chrome-extension --sass
All of Permissions for Chrome Extension
Need to add more permissions for chrome extension? You can get all list of permissions using --all-permissions
option when scaffolding a new project.
yo chrome-extension --all-permissions
Contribute
See the contributing docs
License
Top Related Projects
Scaffold out a Chrome extension
⚡️ A template for building cross browser extensions for Chrome, Opera & Firefox.
🖥🔋Web Extension starter to build "Write Once Run on Any Browser" extension
🚀 The CLI for your next Chrome Extension
Convert
designs to code with AI
Introducing Visual Copilot: A new AI model to turn Figma designs to high quality code using your components.
Try Visual Copilot