https://github.com/c0bra/generator-browser-widget

Yeoman generator for browser widgets using rollup, jest, and cypress
https://github.com/c0bra/generator-browser-widget

browser generator module plugin yeoman

Last synced: 2 months ago
JSON representation

Yeoman generator for browser widgets using rollup, jest, and cypress

• Host: GitHub
• URL: https://github.com/c0bra/generator-browser-widget
• Owner: c0bra
• License: mit
• Created: 2018-03-22T14:55:28.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2018-06-27T15:22:46.000Z (over 6 years ago)
• Last Synced: 2024-10-10T12:50:44.459Z (3 months ago)
• Topics: browser, generator, module, plugin, yeoman
• Language: JavaScript
• Homepage:
• Size: 64.5 KB
• Stars: 5
• Watchers: 4
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# generator-browser-widget

> Yeoman generator for creating reusable browser widgets

Inspiration from Sindre's [generator-nm](https://github.com/sindresorhus/generator-nm)

# Features

* Build & bundle with [rollup](https://github.com/rollup/rollup)

* Transpile with [babel](https://babeljs.io)

* Or with [TypeScript](https://www.typescriptlang.org/)

* Build components with [svelte](http://svelte.technology)

* Handle your CSS with [PostCSS](postcss)

* Unit test with [jest](https://facebook.github.io/jest/)

* E2E test in the browser with [cypress.io](https://www.cypress.io/) (Useful for testing widgets and visual components, but JS code can be tested too)

* Publish code coverage to [coveralls.io](https://coveralls.io)

* Local development server with live-reload using [live-server](https://www.npmjs.com/package/live-server)

* Create a static [gh-pages](https://pages.github.com/) site with [VuePress](https://vuepress.vuejs.org/)

# Install

    $ npm i -g yo generator-browser-widget

# Usage

Scaffold your module with the generator:

    $ yo browser-widget

Run the local development server. Your browser and cypress will open up.

    $ npm run dev

Other npm scripts

    $ npm run build

    $ npm run test # test with jest

    $ npm run e2e # run cypress e2e tests

# License

MIT © [Brian Hann](https://brianhann.com)