generator-whs-plugin

Whitestorm.js plugin generator

INSTRUCTION: Installation

• Make a new repository.
• Install Yeoman: npm install -g yo
• Install Whitestorm.js plugin generator: npm install -g generator-whs-plugin
• Run yo whs-plugin.

INSTRUCTION: Development

• Run gulp dev in repo folder. This will watch all files you edit in src (watched by webpack dev server) and automatically compile them in real-time.
• Open http://localhost:8080/ in browser. Now you should see a basic plugin that creates dynamic sphere shape with green material.

• Edit files in src folder. All your changes should be compiled immediately.

• index.js is a main file. Your plugin will export the same as this file export.

INSTRUCTION: Publishing

As your package.json file is complete and plugin is written - you can publish it to NPM.

• Run npm publish.
• Profit!

CLI

gulp build - default command

This command builds all sources for node.js and browser environment.

gulp build:node

This command builds all sources only for node.js environment - lib/ folder

gulp build:browser

This command builds all sources only for browser environment - build/ folder.

gulp dev - Development mode

This command runs development mode where you can make changes in sources and all your changes will be applied immediately. After running this command you should see all examples by http://localhost:8080/

gulp build:clean

Removes all files from build/ and lib/

gulp vendor

If you are using Github pages or other deploy service to run examples/showcase of a plugin - This command will be useful: it copies whitestorm.js file from node_modules/.../ to whs/ folder.