Improve hesitation formatting at the end of a sentence.

Fixes #13

Author: nfriedly

speech-to-text/format-stream.js

@@ -31,7 +31,7 @@ function FormatStream(opts) {
 }
 util.inherits(FormatStream, Transform);
 
-var reHesitation = /%HESITATION\s/g; // when the service detects a "hesitation" pause, it literally puts the string "%HESITATION" into the transcription
+var reHesitation = /%HESITATION/g; // when the service detects a "hesitation" pause, it literally puts the string "%HESITATION" into the transcription
 var reRepeatedCharacter = /([a-z])\1{2,}/ig; // detect the same character repeated three or more times and remove it
 var reDUnderscoreWords = /D_[^\s]+/g; // replace D_(anything)
 
@@ -75,6 +75,10 @@ FormatStream.prototype.period = function period(text) {
   if (!text) {
     return ' ';
   }
+  // just add a space if the sentence ends in an ellipse
+  if (this.options.hesitation && text.substr(-1) === this.options.hesitation) {
+    return text + ' ';
+  }
   return text + (this.isJaCn ? '。' : '. ');
 };
 

test/format-stream-spec.js

@@ -81,6 +81,20 @@ describe('FormatStream', function() {
     stream.write(source);
   });
 
+  // https://github.com/watson-developer-cloud/speech-javascript-sdk/issues/13
+  it('should handle %HESITATIONs at the end of a sentence (and not add a period)', function(done) {
+    var stream = new FormatStream();
+    stream.setEncoding('utf8');
+    var source = '%HESITATION asdf %HESITATION ';
+    var expected = '… asdf … ';
+    stream.on('data', function(actual) {
+      assert.equal(actual, expected);
+      done();
+    });
+    stream.on('error', done);
+    stream.write(source);
+  });
+
   /*
   { results:
     [ { alternatives: