@commitlint/format - npm Package Compare versions

Comparing version 7.2.0 to 7.2.1

CHANGELOG.md

@@ -6,2 +6,10 @@ # Change Log
 
+<a name="7.2.1"></a>
+## [7.2.1](https://github.com/marionebl/commitlint/compare/v7.2.0...v7.2.1) (2018-10-11)
+
+
+
+
+**Note:** Version bump only for package @commitlint/format
+
 <a name="7.2.0"></a>
@@ -8,0 +16,0 @@ # [7.2.0](https://github.com/marionebl/commitlint/compare/v7.1.2...v7.2.0) (2018-10-05)

package.json

 {
   "name": "@commitlint/format",
-  "version": "7.2.0",
+  "version": "7.2.1",
   "description": "Format commitlint reports",
@@ -5,0 +5,0 @@ "main": "lib/index.js",

README.md

@@ -16,25 +16,40 @@ > Format commitlint reports
 
-format({
-  warnings: [
+const output = format({
+  valid: false,
+  errorCount: 1,
+  warningCount: 1,
+  results: [
     {
-      level: 0,
-      name: 'some-hint',
-      message: 'This will not show up as it has level 0'
-    },
-    {
-      level: 1,
-      name: 'some-warning',
-      message: 'This will show up yellow as it has level 1'
+      valid: false,
+      input: 'some: commit message',
+      errors: [
+        {
+          valid: false,
+          level: 2,
+          name: 'some-error',
+          message: 'This will show up red as it has level 2'
+        }
+      ],
+      warnings: [
+        {
+          valid: true,
+          level: 0,
+          name: 'some-hint',
+          message: 'This will not show up as it has level 0'
+        },
+        {
+          valid: false,
+          level: 1,
+          name: 'some-warning',
+          message: 'This will show up yellow as it has level 1'
+        }
+      ]
     }
-  ],
-  errors: [
-    {
-      level: 2,
-      name: 'some-error',
-      message: 'This will show up red as it has level 2'
-    }
-  ]
+  ]  
 }, {
   color: false
 });
+
+process.stdout.write(output);
+
 /* => [
@@ -49,1 +64,2 @@ '✖   This will show up red as it has level 2 [some-error]',
 Consult [docs/api](http://marionebl.github.io/commitlint/#/reference-api) for comprehensive documentation.
+

No alert changes

Improved metrics

Total package byte prevSize

21867

increased by2.38%

Number of lines in readme file

64

increased by33.33%

No dependency changes