1.0.0 • Published 7 years ago
au-dirty v1.0.0
au-dirty - An Aurelia plugin for class dirty tracking
This plugin provides n easy way to track dirty state of a class.
Building The Code
To build the code, follow these steps.
- Ensure that NodeJS is installed. This provides the platform on which the build tooling runs.
From the project folder, execute the following command:
npm install
To build the code, you can now run:
npm run build
You will find the compiled code in the
dist
folder, available in five module formats: AMD, CommonJS, ES2015, ES2017 and System.
Running The Tests
To run the unit tests, first ensure that you have followed the steps above in order to install all dependencies and successfully build the library. Once you have done that, proceed with these additional steps:
Ensure that the Karma CLI is installed. If you need to install it, use the following command:
npm install -g karma-cli
You can now run the tests with this command:
npm test
Alternatively, you can run the tests in watch mode with this command:
npm run develop
Installing the plugin
In a CLI-based app
{
"name": "au-dirty",
"path": "../node_modules/au-dirty/dist/amd",
"main": "au-dirty",
"resources": ["**/*.{css,html}"]
}