@croct/plug-rule-engine
v0.2.0TypeScript
A rule engine built on top of the Croct Plug.
0/weekUpdated 3 years agoMITUnpacked: 32.3 KB
Published by Croct
npm install @croct/plug-rule-engine
Rule Engine Plugin
A PlugJS plugin for building real-time rule engines.
📦Releases
·
🐞Report Bug
·
✨Request Feature
Installation
The recommended way to install this plugin is using NPM. It pairs nicely with module bundlers such as Rollup, Webpack or Browserify and includes Typescript typings.
Run the following command to install the latest version:
``sh`
npm install @croct/plug-rule-engine
Basic usage
`typescript
import croct from '@croct/plug';
import '@croct/plug-rule-engine';
croct.plug({
plugins: {
ruleEngine: {
extensions: [],
pages: {
'/home': [
{
rules: [],
},
],
},
},
}
});
`
Contributing
Contributions to the package are always welcome!
- Report any bugs or issues on the issue tracker.
- For major changes, please open an issue first to discuss what you would like to change.
- Please make sure to update tests as appropriate.
Testing
Before running the test suites, the development dependencies must be installed:
`sh`
npm install
Then, to run all tests:
`sh`
npm run test
Run the following command to check the code against the style guide:
`sh`
npm run lint
Building
Before building the project, the dependencies must be installed:
`sh`
npm install
Then, to build the CommonJS module:
`sh``
npm run build
Copyright Notice
This project is released under the MIT License.