hull-connector-tester - npm Package Compare versions

Comparing version 0.0.12 to 0.0.13

CHANGELOG.md

 # CHANGELOG
 
+## v0.0.13
+- update docs
+
 ## v0.0.12
@@ -4,0 +7,0 @@ - update readme

package.json

 {
   "name": "hull-connector-tester",
-  "version": "0.0.12",
+  "version": "0.0.13",
   "description": "",
@@ -5,0 +5,0 @@ "main": "src/bin.js",

README.md

@@ -8,2 +8,4 @@ # Hull Connector Tester
 
+You can think of it as code quality check tool, maybe we will even have badges/shields (as http://shields.io/) in future :)
+
 ## Continuous Integration usage
@@ -29,8 +31,11 @@
 
+## What are current checks?
 
+Please review all files in [src/checks](./src/checks) directory. Each function perform one check and the purpose is descibed in the docblock.
+
 ## How to add new check?
 
 1. Add new file in [src/checks](./src/checks) directory with the name of the check
-2. Create a function taking no arguments and returning `true` in case of success or `string` in case of error with error message
+2. Create a function taking no arguments and returning `true` in case of success or `string` in case of error with the error message
 3. Export this new check in [src/checks/index.js](./src/checks/index.js)
-4. bump version and update [CHANGELOG.md](./CHANGELOG.md)
+4. Bump version and update [CHANGELOG.md](./CHANGELOG.md)

src/checks/hull-node-version.js

 const fs = require("fs");
 
-module.exports = function checkPackageEngines() {
+/**
+ * This check enforces latest hull-node version
+ * @return {boolean|string}
+ */
+module.exports = function checkHullNodeVersion() {
 
@@ -5,0 +9,0 @@ const allowedVersions = ["0.13.14"];

src/checks/manifest-json-lint.js

 const fs = require("fs");
 const jsonlint = require("jsonlint");
 
-module.exports = function lintManifestJson() {
+
+/**
+ * This check make sure that the manifest.json file is a valid json
+ * @return {boolean|string}
+ */
+module.exports = function checkManifestJsonLint() {
   const manifestJson = fs.readFileSync(`${process.cwd()}/manifest.json`, "utf-8");
@@ -6,0 +11,0 @@ try {

src/checks/package-engines.js

 const fs = require("fs");
 
+/**
+ * This check enforces specific versions of
+ * node, npm and yarn being specified in package.json
+ * @return {boolean|string}
+ */
 module.exports = function checkPackageEngines() {
@@ -4,0 +9,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Native code

Supply chain risk

Contains native code (e.g., compiled binaries or shared libraries). Including native code can obscure malicious behavior.

Found 1 instance in 1 package

Improved metrics

Lines of code

77

increased by20.31%

Number of lines in readme file

39

increased by14.71%

Number of medium supply chain risk alerts

0

decreased by-100%

Worsened metrics

Total package byte prevSize

6080

decreased by-93.14%

Number of package files

9

decreased by-77.5%

No dependency changes