Add more info to messages

Author: wooorm

index.js

@@ -15,7 +15,7 @@ var spacheFormula = require('spache-formula')
 
 module.exports = readability
 
-var source = 'retext-readability'
+var origin = 'retext-readability:readability'
 var defaultTargetAge = 16
 var defaultWordynessThreshold = 5
 var defaultThreshold = 4 / 7
@@ -149,6 +149,7 @@ function report(file, node, threshold, target, results) {
   var index = -1
   var failCount = 0
   var confidence
+  var label
   var message
 
   while (++index < length) {
@@ -157,17 +158,19 @@ function report(file, node, threshold, target, results) {
     }
   }
 
-  if (failCount / length >= threshold) {
-    confidence = failCount + '/' + length
+  confidence = failCount / length
+
+  if (confidence >= threshold) {
+    label = failCount + '/' + length
 
     message = file.message(
-      'Hard to read sentence (confidence: ' + confidence + ')',
+      'Hard to read sentence (confidence: ' + label + ')',
       node,
-      source
+      origin
     )
-    message.confidence = confidence
-    message.source = source
     message.actual = toString(node)
-    message.expected = null
+    message.expected = []
+    message.confidence = confidence
+    message.confidenceLabel = label
   }
 }

test.js

@@ -5,6 +5,45 @@ var retext = require('retext')
 var readability = require('.')
 
 test('readability', function(t) {
+  retext()
+    .use(readability)
+    .process(
+      [
+        'Oberon, also designated Uranus IV, is the outermost ',
+        'major moon of the planet Uranus and quite large',
+        'and massive for a Uranian moon.',
+        ''
+      ].join('\n'),
+      function(err, file) {
+        t.deepEqual(
+          [err].concat(file.messages),
+          [
+            null,
+            {
+              message: 'Hard to read sentence (confidence: 4/7)',
+              name: '1:1-3:32',
+              reason: 'Hard to read sentence (confidence: 4/7)',
+              line: 1,
+              column: 1,
+              location: {
+                start: {line: 1, column: 1, offset: 0},
+                end: {line: 3, column: 32, offset: 132}
+              },
+              source: 'retext-readability',
+              ruleId: 'readability',
+              fatal: false,
+              actual:
+                'Oberon, also designated Uranus IV, is the outermost \nmajor moon of the planet Uranus and quite large\nand massive for a Uranian moon.',
+              expected: [],
+              confidence: 4 / 7,
+              confidenceLabel: '4/7'
+            }
+          ],
+          'should emit messages'
+        )
+      }
+    )
+
   retext()
     .use(readability)
     .process('The cat sat on the mat', function(err, file) {