https://github.com/breuleux/generator-earl-package

Generate scaffolding for an npm package written in Earl Grey.
https://github.com/breuleux/generator-earl-package

Last synced: about 2 months ago
JSON representation

Generate scaffolding for an npm package written in Earl Grey.

• Host: GitHub
• URL: https://github.com/breuleux/generator-earl-package
• Owner: breuleux
• Created: 2015-06-29T17:40:11.000Z (almost 10 years ago)
• Default Branch: master
• Last Pushed: 2017-02-03T08:11:22.000Z (over 8 years ago)
• Last Synced: 2025-04-14T20:09:44.444Z (about 2 months ago)
• Language: JavaScript
• Size: 5.86 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        

# generator-earl-package

Generate scaffolding for an npm package written in Earl Grey.

This generator will generate a proper skeleton for a package written

in the Earl Grey language which can be published to npm and required

from JavaScript as normal.

It generates `prepublish` hooks that compile your code to JavaScript

automatically, and a test file that uses `earl-mocha` (BDD mode).

## Usage

    npm install -g generator-earl-package

    yo earl-package

Resulting directory structure:

    package-root

      .gitignore

      .npmignore

      package.json

      src

        index.eg

      test

        mocha.opt

        test.eg

## Commands

The following commands are defined for convenience:

To compile the project to JS:

    npm run compile

Lazy version of `compile`:

    npm run refresh