-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #25 from yusufshakeel/dev
v0.8.12
- Loading branch information
Showing
7 changed files
with
645 additions
and
248 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,46 +1,71 @@ | ||
### Install | ||
|
||
To install all the dependencies and start developing/using run the following command. | ||
|
||
``` | ||
> npm install | ||
``` | ||
|
||
### Test | ||
|
||
To run the test suite execute the following command. | ||
|
||
``` | ||
> npm run test | ||
``` | ||
|
||
### JSDocs | ||
|
||
To generate JS Documentation run the following command. | ||
|
||
``` | ||
> npm run generate-docs | ||
``` | ||
|
||
### Madge | ||
|
||
To check for circular dependencies. If it exists then steps must be taken to fix it. | ||
|
||
``` | ||
> npm run search-circular-dependencies | ||
``` | ||
|
||
### JSCPD | ||
|
||
To check for duplicate code. If it exists then steps must be taken to fix it. | ||
|
||
``` | ||
> npm run search-duplicate-code | ||
``` | ||
|
||
### Precommit | ||
|
||
Run the following command before making Git Commit. | ||
|
||
``` | ||
> npm run precommit | ||
``` | ||
|
||
This will generate documentation, run test suites and any other steps that you have configures in the `package.json` file. | ||
|
||
### Update the version in package.json | ||
|
||
Run the following command to update the version of the project in `package.json` file. | ||
|
||
``` | ||
> npm version VERSION | ||
``` | ||
|
||
Example: | ||
|
||
``` | ||
> npm version 1.0.0 | ||
``` | ||
``` | ||
|
||
### Performance log | ||
|
||
Run the following command to generate performance log. | ||
|
||
``` | ||
> npm run performance | ||
``` |
Oops, something went wrong.