extension-cli
Version:
CLI tool for building browser extensions
88 lines (53 loc) • 4.49 kB
Markdown
# Extension CLI
[](https://www.npmjs.com/package/extension-cli)
[](https://travis-ci.com/github/MobileFirstLLC/extension-cli)
[](https://codeclimate.com/github/MobileFirstLLC/extension-cli/maintainability)
[](https://github.com/MobileFirstLLC/extension-cli/commits/master)
[](https://www.npmjs.com/package/extension-cli)
<!-- [](https://coveralls.io/github/MobileFirstLLC/extension-cli) hide coverage because it represents only utilities and may signal incorrectly; add back when this includes all of CLI commands -->
**Extension CLI is a command-line application that facilitates chromium∗-based web extension development by providing
a systematic way to build, test and document extension projects. It handles the project setup and builds and lets you focus
on the extension you are creating.**
* * *
## Features
- 🖥️ **Javascript Bundling** — Compiles, bundles and minifies javascript files<br/>
- 🎨 **CSS Bundling** — Compiles, bundles, and minifies CSS and [SASS](https://sass-lang.com/guide) files <br/>
- 💄 **Linting** — lint JavaScript using [ESLint](https://eslint.org/) <br/>
- 📦 **ZIP Generation** — Generates a `.zip` file for publishing <br/>
- 📝 **Document Source Code** — Generates code documentation using [JSDoc](https://jsdoc.app/about-getting-started.html) <br/>
- ⚗️ **Unit Testing** — Provides a unit test environment preloaded with [mocha](https://mochajs.org), [chai](https://www.chaijs.com/) and [sinon-chrome](https://github.com/acvetkov/sinon-chrome) <br/>
- ⚔️ **Cross-Browser Compatibility** - develop extensions for Chrome, Edge, Firefox, Opera and Brave. <br/>
## Getting Started
**Note:** Using this CLI assumes you have Node.js installed. If you do not, you can [install it here](https://nodejs.org/en/download/).
##### Create new extension project
```text
npx extension-cli
```
##### Add to an existing project
```text
npm install extension-cli
```
### Commands Reference
Command | Description
--- | ---
**xt-build** | Run builds; env flags: `-e prod` and `-e dev`
**xt-test**| Run unit tests
**xt-docs**| Generate docs
**xt-sync**| Update project config files to match the latest defaults supplied by this CLI
**xt-clean** | Remove automatically generated files
* * *
## Read the Docs
<img align="left" width="64" src="https://raw.githubusercontent.com/MobileFirstLLC/extension-cli/master/guide/assets/images/guide.svg" alt="" />
<br/> <strong><a href="https://oss.mobilefirst.me/extension-cli/">User Guide →</a></strong><br/><br/>
### CLI Developer Guide
If you are interested in extending this project or forking **[see this guide →](https://oss.mobilefirst.me/extension-cli/13-cli-development/)**
* * *
## Motivation
After developing multiple browser extensions, it became clear that there are several steps in the development process that stay the same between every project.
Instead of setting up these tasks individually for each project, it made more sense to combine everything in a utility tool that could be shared between projects.
This approach helps with creating a common, consistent development approach between multiple projects, reduces time to get started, and makes it easier to update build tools and scripts across multiple projects as many npm packages inevitably need to be updated (frequently!).
* * *
**Issues & Feature Requests:** [Submit on Github](https://github.com/MobileFirstLLC/extension-cli/issues/new/choose)
**Maker:** made by <a href="https://github.com/MobileFirstLLC/extension-cli/graphs/contributors" target="_blank" rel="noreferrer noopener">developers</a> behind several popular extensions!
**License:** [MIT](https://github.com/MobileFirstLLC/extension-cli/blob/master/LICENSE)