EquivalentJS Plugin Scaffold Example

A module plugin is a loose coupled module class and their dependencies which loaded into equivalent-js framework stack.

an example scaffold for an EquivalentJS plugin

How to use the framework:

• Module Manager
• Test Runner
• Doc Runner

How to build and use equivalent-js plugins:

• Module Plugin

Requirements

Install dependencies with npmjs at project root folder

npm install

Configuration

The equivalent-js plugin package has a dev requirement to the equivalent-js framework.

Inside the plugin project dev environment the EquivalentJS Dependency Injection Container (DIC) loads the plugin that is developed currently.

It is also possible to require other equivalent-js plugins in package.json to build new plugins based on others.

All in package.json required equivalent-js plugins get also added to this DIC stack.

Also the test and doc runner are available and are reduced to the framework and plugin scope.

For plugin development at parameters.json the configuration property "plugins" holds the collection of loadable equivalent-js plugins.

The boolean indicates the plugin is active and the framework try to load it.

{
  "plugins": {
    "equivalent-js-plugin-scaffold-example": true
  }
}

Documentation, scripts and stylesheets

Generate scripts and stylesheets (Sass) and documentation (JSDoc & JSDoc Type)

npm run dev:run

or

npm run dev:watch

Run demo application in browser with loaded plugins

npm run dev:http

http://127.0.0.1:8084/index.html

Build all EquivalentJS modules as concatenated minified library file

npm run prod:minify

http://127.0.0.1:8084/prod.html

How to contribute

Contributing

Appendix

Code of Conduct

...live long and prosper