# generator-browser-modern-extension

> Scaffold out a boilerplate for creating a browser extension with up-to-date tools and autoreload

Latest version **1.0.4** (published 2019-08-04) · MIT license · 0 weekly downloads

## Install

```sh
npm install generator-browser-modern-extension
pnpm add generator-browser-modern-extension
yarn add generator-browser-modern-extension
bun add generator-browser-modern-extension
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.4 |
| Published | 2019-08-04 |
| First published | 2019-01-08 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 5 |
| Unpacked size | 30.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Marco Fugaro |
| Maintainers | marcofugaro |
| Keywords | boilerplate, template, scaffold, browser, generator, extension, autoreload, yeoman-generator |

## Links

- npm: https://www.npmjs.com/package/generator-browser-modern-extension
- Repository: https://github.com/marcofugaro/generator-browser-modern-extension
- npm.io page: https://npm.io/package/generator-browser-modern-extension

## Dependencies (5)

- [lodash](https://npm.io/package/lodash.md) ^4.17.15
- [superb](https://npm.io/package/superb.md) ^4.0.0
- [is-scoped](https://npm.io/package/is-scoped.md) ^2.1.0
- [normalize-url](https://npm.io/package/normalize-url.md) ^4.3.0
- [yeoman-generator](https://npm.io/package/yeoman-generator.md) ^3.2.0

## Alternatives

- [@opentelemetry/exporter-zipkin](https://npm.io/package/@opentelemetry/exporter-zipkin.md) — 14.8M weekly downloads
- [pusher-js](https://npm.io/package/pusher-js.md) — 2.0M weekly downloads
- [browserify](https://npm.io/package/browserify.md) — 1.7M weekly downloads
- [sqs-consumer](https://npm.io/package/sqs-consumer.md) — 1.7M weekly downloads
- [@sanity/eventsource](https://npm.io/package/@sanity/eventsource.md) — 930.8K weekly downloads

## Recent versions

- 1.0.4 (latest) — 2019-08-04
- 1.0.3 — 2019-08-04
- 1.0.2 — 2019-01-08
- 1.0.1 — 2019-01-08
- 1.0.0 — 2019-01-08

## README

# generator-browser-modern-extension [![Build Status][travis-image]][travis-url]

> Scaffold out a boilerplate for creating a browser extension with up-to-date tools and autoreload of the extension

The boilerplate repo is [here](https://github.com/marcofugaro/browser-modern-extension-boilerplate).

<img src="screenshots/demo.gif" width="600">

## Features

This project is born because of the lack of browser extension starter kits which aren't from 2013 and don't use bower.

[Gulp 4](https://github.com/gulpjs/gulp) is used to manage all the tasks and wire the tools together, it was chosen because it's easily hackable and configurable, you can make it fit and scale with your wildest browser extension!

It uses [webpack](https://webpack.js.org/) to bundle javascript and [SCSS](http://sass-lang.com/) as a preprocessor. [Babel](http://babeljs.io/) transpiles all the future js stuff that hasn't landed in chrome yet, and there are customizable [eslint](https://eslint.org/) and [stylelint](https://stylelint.io/) config files.

The development mode has **autoreload** of the chrome extension, meaning that when you change a file, the extension is loaded again in chrome! 🔥

It comes with the [webextension-polyfill](https://github.com/mozilla/webextension-polyfill), which basically lets you write **async/await code** instead of the callback hell of the chrome extension apis. 💣

<img src="screenshots/start.png" width="700">

It also bundles your extension when you're done, ready to be pusblished to the extension store!

<img src="screenshots/bundle.png" width="700">

## Install

```bash
npm install -g yo
npm install -g generator-browser-modern-extension
```

## Usage

First make sure you're in your project folder (`mkdir my-awesome-project && cd my-awesome-project/`), then run

```bash
yo browser-modern-extension
```
or just
```bash
yo
```
and select `Browser Modern Extension`.

[travis-image]: https://travis-ci.org/marcofugaro/generator-chrome-modern-extension.svg?branch=master
[travis-url]: https://travis-ci.org/marcofugaro/generator-chrome-modern-extension

---
_Source: https://npm.io/package/generator-browser-modern-extension · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._