sample-package-esqueleton
Advanced tools
Comparing version
{ | ||
"name": "sample-package-esqueleton", | ||
"version": "1.1.2", | ||
"version": "1.2.0", | ||
"description": "A simple esqueleton package meant for starter packages", | ||
"main": "index.js", | ||
"scripts": { | ||
"start": "node index.js", | ||
"dev": "echo dev-mode", | ||
"test": "jest --coverage", | ||
"docs": "jsdoc index.js -d docs" | ||
"test": "nyc mocha src/**/*.test.js --timeout=1000 --exit", | ||
"docs": "jsdoc src/** -d docs", | ||
"readme": "documentation build src/**/*.js -f md" | ||
}, | ||
"repository": { | ||
"type": "git", | ||
"url": "git+https://github.com/rmfranciacastillo/sample-package-esqueleton" | ||
"url": "git+https://github.com/rmfranciacastillo/sample-package-esqueleton" | ||
}, | ||
@@ -23,2 +22,4 @@ "keywords": [ | ||
"devDependencies": { | ||
"chai": "^4.2.0", | ||
"documentation": "^12.1.2", | ||
"dotenv": "^6.2.0", | ||
@@ -28,5 +29,5 @@ "eslint": "^5.12.1", | ||
"husky": "^1.3.1", | ||
"jest": "^23.6.0", | ||
"jest-chain": "^1.0.5", | ||
"jest-extended": "^0.11.0", | ||
"jsdoc": "^3.6.3", | ||
"mocha": "^6.2.1", | ||
"nyc": "^14.1.1", | ||
"standard": "^12.0.1" | ||
@@ -33,0 +34,0 @@ }, |
@@ -16,13 +16,9 @@ # Sample NPM Package - Esqueleton | ||
``` | ||
npm v6.5.0 | ||
npm v6.9.0 | ||
``` | ||
``` | ||
node v8.11.3 | ||
node v10.16.3 | ||
``` | ||
``` | ||
JSDoc 3.5.5 | ||
``` | ||
### Installing | ||
@@ -34,11 +30,5 @@ | ||
For installing [JSDoc](https://www.npmjs.com/package/jsdoc) you can install globally or locally | ||
``` | ||
npm install -g jsdoc | ||
``` | ||
## Running the tests | ||
Test will are running on Jest to run them just use | ||
Test are powered with Mocha and Chai | ||
@@ -61,3 +51,8 @@ ``` | ||
## Generate docs | ||
``` | ||
npm run docs | ||
``` | ||
## Versioning | ||
@@ -79,1 +74,2 @@ | ||
Environment variable access
Supply chain riskPackage accesses environment variables, which may be a sign of credential stuffing or data theft.
Found 1 instance in 1 package
0
-100%13767
-2.75%10
25%287
-3.37%72
-5.26%