https://github.com/breuleux/generator-quaint-plugin

Quaint plugin generator
https://github.com/breuleux/generator-quaint-plugin

Last synced: about 1 month ago
JSON representation

Quaint plugin generator

• Host: GitHub
• URL: https://github.com/breuleux/generator-quaint-plugin
• Owner: breuleux
• Created: 2016-01-25T23:46:20.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2017-02-03T08:15:34.000Z (over 8 years ago)
• Last Synced: 2025-02-12T09:46:20.439Z (3 months ago)
• Language: JavaScript
• Size: 9.77 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        

# generator-quaint-plugin

Generate scaffolding for a Quaint plugin written in Earl Grey.

## Usage

    npm install -g generator-quaint-plugin

    yo quaint-plugin

You may write your plugin in JavaScript, or in

[Earl Grey](http://earl-grey.io).

[Relevant documentation.](http://breuleux.github.io/quaint/plugins/write.html)

## JavaScript 

Resulting directory structure:

    quaint-my-plugin

      .gitignore

      .npmignore

      package.json

      quaint-setup.js

      lib

        index.js

        setup.js

* `index.js` contains the plugin code

* `setup.js` contains the code to configure the plugin interactively

## Earl Grey

Resulting directory structure:

    package-root

      .gitignore

      .npmignore

      package.json

      quaint-setup.js

      src

        index.eg

        setup.eg

      test

        mocha.opt

        test.eg

* `index.eg` contains the plugin code

* `setup.eg` contains the code to configure the plugin interactively

### Commands

In an Earl Grey project, the following commands are defined for

convenience:

To compile the project to JS:

    npm run compile

Lazy version of `compile`:

    npm run refresh