https://github.com/cloud-elements/doctor-core
The core functionality of Doctor - The Cloud Elements Asset Management Tool
https://github.com/cloud-elements/doctor-core
Last synced: 5 days ago
JSON representation
The core functionality of Doctor - The Cloud Elements Asset Management Tool
- Host: GitHub
- URL: https://github.com/cloud-elements/doctor-core
- Owner: cloud-elements
- Created: 2020-11-24T09:05:12.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2022-07-07T04:34:10.000Z (over 3 years ago)
- Last Synced: 2025-10-19T20:31:04.175Z (4 months ago)
- Language: JavaScript
- Size: 462 KB
- Stars: 0
- Watchers: 7
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# doctor-core
The doctor-core holds the core functionality of Doctor tool (The Cloud Elements Asset Management Tool) which will be used internally by [doctor-service](https://github.com/cloud-elements/doctor-service).
### doctor-core unit tests
Run all the unit test cases via the following command
```
$ npm run test:unit
```
> __PROTIP:__ `node` version must be >= `v12.18.3`
Run a single unit test file via the following command
```
$ jest getExtendedElements.test.js
```
Run all the unit test cases with coverage and view the code coverage report via the following command
```
$ npm run test:unit:coverage
```
#### Important notes
1. Debug and console.logs in doctor-core are disabled by default. To enable them, the `ENABLE_DEBUG_LOG` environment variable must be set to true (true for CLI by default).
2. Some of the features won't work if you are not following the node version specified in the package.json file.
#### Steps to link local doctor-core project as a dependency in doctor-cli or doctor-service
```
cd # go into the doctor-core project directory
npm link # creates global link
cd # go into some other project directory.
npm link @cloudelements/doctor-core # link-install the package
```