@fabernovel/heart-cli - npm Package Compare versions

Comparing version 3.0.2 to 3.1.0

CHANGELOG.json

@@ -5,2 +5,27 @@ {
     {
+      "version": "3.1.0",
+      "tag": "@fabernovel/heart-cli_v3.1.0",
+      "date": "Thu, 16 Jan 2020 14:51:38 GMT",
+      "comments": {
+        "minor": [
+          {
+            "comment": "Initial release of automated tests"
+          }
+        ],
+        "patch": [
+          {
+            "comment": "Fix the console message if there is no link to an online report"
+          },
+          {
+            "comment": "Update the link to the purpose of Heart in the README, to redirect to the fabernovel.com website instead of the wiki"
+          }
+        ],
+        "dependency": [
+          {
+            "comment": "Updating dependency \"@fabernovel/heart-core\" from `^3.0.1` to `^3.1.0`"
+          }
+        ]
+      }
+    },
+    {
       "version": "3.0.2",
@@ -7,0 +32,0 @@ "tag": "@fabernovel/heart-cli_v3.0.2",

CHANGELOG.md

 # Change Log - @fabernovel/heart-cli
 
-This log was last generated on Fri, 19 Jul 2019 09:41:14 GMT and should not be manually modified.
+This log was last generated on Thu, 16 Jan 2020 14:51:38 GMT and should not be manually modified.
 
+## 3.1.0
+Thu, 16 Jan 2020 14:51:38 GMT
+
+### Minor changes
+
+- Initial release of automated tests
+
+### Patches
+
+- Fix the console message if there is no link to an online report
+- Update the link to the purpose of Heart in the README, to redirect to the fabernovel.com website instead of the wiki
+
 ## 3.0.2
@@ -6,0 +18,0 @@ Fri, 19 Jul 2019 09:41:14 GMT

lib/App.js

@@ -20,3 +20,7 @@ "use strict";
             const reportName = report.service ? `[${report.service.name}] ` : '';
-            console.log(`${reportName}${report.analyzedUrl}: ${report.note}, view full report: ${report.resultUrl}`);
+            let message = `${reportName}${report.analyzedUrl}: ${report.note}`;
+            if (report.resultUrl) {
+                message += `, view full report: ${report.resultUrl}`;
+            }
+            console.log(message);
             this.eventEmitter.emit("analysis.done" /* DONE */, report);
@@ -23,0 +27,0 @@ // /!\ do not exit the node process at this point,

lib/command/AnalysisCommand.d.ts

@@ -5,5 +5,5 @@ import { ModuleAnalysisInterface } from '@fabernovel/heart-core';
     /**
-     * Create an command dedicated to the given analysis module
+     * Create a command dedicated to the given analysis module
      */
     static create(program: CommanderStatic, module: ModuleAnalysisInterface, callback: (config: object) => void): void;
 }

lib/command/AnalysisCommand.js

@@ -6,3 +6,3 @@ "use strict";
     /**
-     * Create an command dedicated to the given analysis module
+     * Create a command dedicated to the given analysis module
      */
@@ -9,0 +9,0 @@ static create(program, module, callback) {

lib/command/ServerCommand.d.ts

@@ -6,5 +6,5 @@ import { ModuleServerInterface } from '@fabernovel/heart-core';
     /**
-     * Create an command dedicated to the given server module
+     * Create a command dedicated to the given server module
      */
     static create(program: CommanderStatic, module: ModuleServerInterface, callback: (port: number) => void): void;
 }

lib/command/ServerCommand.js

@@ -5,3 +5,3 @@ "use strict";
     /**
-     * Create an command dedicated to the given server module
+     * Create a command dedicated to the given server module
      */
@@ -8,0 +8,0 @@ static create(program, module, callback) {

lib/module/ModuleLoader.d.ts

 import { ModuleInterface } from '@fabernovel/heart-core';
 export default class ModuleLoader {
-    private readonly ENVIRONMNENT_VARIABLE_MODEL;
+    private readonly ENVIRONMENT_VARIABLE_MODEL;
     private readonly PACKAGE_PREFIX;
     private readonly ROOT_PATH;
-    private debug;
+    private readonly debug;
     constructor(debug?: boolean);
@@ -8,0 +8,0 @@ /**

lib/module/ModuleLoader.js

@@ -18,3 +18,3 @@ "use strict";
         // file that contains the list of required environment variables
-        this.ENVIRONMNENT_VARIABLE_MODEL = '.env.sample';
+        this.ENVIRONMENT_VARIABLE_MODEL = '.env.sample';
         this.PACKAGE_PREFIX = '@fabernovel/heart-';
@@ -45,3 +45,3 @@ // assume that the root path is the one from where the script has been called
                     // according to the .env.sample of the loaded modules
-                    const missingDotEnvVariables = this.getMissingEnvironmentVariables(modulesPaths, this.ENVIRONMNENT_VARIABLE_MODEL);
+                    const missingDotEnvVariables = this.getMissingEnvironmentVariables(modulesPaths, this.ENVIRONMENT_VARIABLE_MODEL);
                     if (missingDotEnvVariables.length > 0) {
@@ -48,0 +48,0 @@ throw new MissingEnvironmentVariables_1.default(missingDotEnvVariables);

package.json

 {
   "name": "@fabernovel/heart-cli",
-  "version": "3.0.2",
+  "version": "3.1.0",
   "description": "Runner module of Heart, which starts an analysis by using a CLI",
@@ -34,3 +34,3 @@ "homepage": "https://gitlab.com/fabernovel/heart",
     "prepare": "npm run build",
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "test": "jest --passWithNoTests"
   },
@@ -41,3 +41,3 @@ "engines": {
   "dependencies": {
-    "@fabernovel/heart-core": "^3.0.1",
+    "@fabernovel/heart-core": "^3.1.0",
     "commander": "^2.20.0",
@@ -49,4 +49,7 @@ "dotenv": "^8.0.0",
     "@types/dotenv": "^6.1.1",
+    "@types/jest": "^24.0.17",
     "@types/node": "^10.14.10",
     "@types/node-fetch": "^2.3.7",
+    "jest": "^24.9.0",
+    "ts-jest": "^24.0.2",
     "tslint": "^5.18.0",
@@ -53,0 +56,0 @@ "typescript": "^3.5.2"

README.md

@@ -1,2 +0,2 @@
-# Description
+# Heart CLI
 
@@ -7,3 +7,3 @@ _Heart CLI_ is the control module of _Heart_. It allows every other module to work together, and is able to control the _Heart API_ and the _analysis_ modules. All of that by exposing a small CLI.
 
-Read more about the purpose, design and general installation of _Heart_ on [the dedicated wiki](https://gitlab.com/fabernovel/heart/wikis/What-is-Heart).
+Read more about [the purpose, design and general installation of _Heart_](https://www.fabernovel.com/en/clients/cases/heart-a-tool-for-automating-web-quality-metrics).
 
@@ -10,0 +10,0 @@ # Package manager

New alerts

Network access

Supply chain risk

This module accesses the network.

Found 1 instance in 1 package

Shell access

Supply chain risk

This module accesses the system shell. Accessing the system shell increases the risk of executing arbitrary code.

Found 1 instance in 1 package

Fixed alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

No tests

Quality

Package does not have any tests. This is a strong signal of a poorly maintained or low quality package.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

46042

increased by37.51%

Number of package files

44

increased by69.23%

Lines of code

653

increased by38.35%

Number of low quality alerts

0

decreased by-100%

Worsened metrics

Dev dependency count

8

increased by60%

Number of medium supply chain risk alerts

2

increased by100%

Dependency changes

• Updated@fabernovel/heart-core@^3.1.0