Drop support for Node.js < 4; switch from underscore to lodash (html-to-text#150)

* Drop support for Node.js < 4

* Update mocha to version 5

* Update eslint to version 4.18.2

* Replace some uses of underscore with native ES5/ES6 methods.

* Switch from underscore to lodash

* Fixes html-to-text#13

* Replace underscore.string with native ES5/ES6 methods and lodash.

Author: realityking

.codeclimate.yml

@@ -4,7 +4,7 @@ engines:
     config:
       languages:
       - javascript
-  eslint:
+  eslint-4:
     enabled: true
   fixme:
     enabled: true

.eslintrc.yml

@@ -1,7 +1,3 @@
-ecmaFeatures:
-  modules: true
-  jsx: false
-
 env:
   amd: false
   browser: false
@@ -140,7 +136,7 @@ rules:
   func-style: 0
   id-length: 0
   id-match: 0
-  indent: [2, 2, { "SwitchCase": 1 }]
+  indent-legacy: [2, 2, { "SwitchCase": 1 }]
   jsx-quotes: 0
   key-spacing: 0
   linebreak-style: 0

.travis.yml

@@ -9,5 +9,6 @@ after_success:
 
 language: node_js
 node_js:
-  - "4.7.3"
-  - "6.9.5"
+  - "4"
+  - "6"
+  - "8"

lib/formatter.js

@@ -1,5 +1,10 @@
-var _ = require('underscore');
-var _s = require('underscore.string');
+var max = require('lodash/max');
+var compact = require('lodash/compact');
+var times = require('lodash/times');
+
+var trimStart = require('lodash/trimStart');
+var padEnd = require('lodash/padEnd');
+
 var he = require('he');
 
 var helper = require('./helper');
@@ -11,7 +16,7 @@ function formatText(elem, options) {
   if (options.isInPre) {
     return text;
   } else {
-    return helper.wordwrap(elem.trimLeadingSpace ? _s.lstrip(text) : text, options);
+    return helper.wordwrap(elem.trimLeadingSpace ? trimStart(text) : text, options);
   }
 }
 
@@ -68,7 +73,7 @@ function formatAnchor(elem, fn, options) {
     text = '';
   }
 
-  var result = elem.trimLeadingSpace ? _s.lstrip(text) : text;
+  var result = elem.trimLeadingSpace ? trimStart(text) : text;
 
   if (!options.ignoreHref) {
     // Get the href, if present
@@ -80,7 +85,7 @@ function formatAnchor(elem, fn, options) {
         if (options.linkHrefBaseUrl && href.indexOf('/') === 0) {
           href = options.linkHrefBaseUrl + href;
         }
-        if (!options.hideLinkHrefIfSameAsText || href !== _s.replaceAll(result, '\n', '')) {
+        if (!options.hideLinkHrefIfSameAsText || href !== helper.replaceAll(result, '\n', '')) {
           if (!options.noLinkBrackets) {
             result += ' [' + href + ']';
           } else {
@@ -97,19 +102,19 @@ function formatAnchor(elem, fn, options) {
 }
 
 function formatHorizontalLine(elem, fn, options) {
-  return '\n' + _s.repeat('-', options.wordwrap) + '\n\n';
+  return '\n' + '-'.repeat(options.wordwrap) + '\n\n';
 }
 
 function formatListItem(prefix, elem, fn, options) {
-  options = _.clone(options);
+  options = Object.assign({}, options);
   // Reduce the wordwrap for sub elements.
   if (options.wordwrap) {
     options.wordwrap -= prefix.length;
   }
   // Process sub elements.
   var text = fn(elem.children, options);
   // Replace all line breaks with line break + prefix spacing.
-  text = text.replace(/\n/g, '\n' + _s.repeat(' ', prefix.length));
+  text = text.replace(/\n/g, '\n' + ' '.repeat(prefix.length));
   // Add first prefix and line break at the end.
   return prefix + text + '\n';
 }
@@ -122,7 +127,7 @@ function formatUnorderedList(elem, fn, options) {
   var nonWhiteSpaceChildren = (elem.children || []).filter(function(child) {
     return child.type !== 'text' || !whiteSpaceRegex.test(child.data);
   });
-  _.each(nonWhiteSpaceChildren, function(elem) {
+  nonWhiteSpaceChildren.forEach(function(elem) {
     result += formatListItem(prefix, elem, fn, options);
   });
   return result + '\n';
@@ -152,12 +157,12 @@ function formatOrderedList(elem, fn, options) {
     var start = Number(elem.attribs.start || '1') - 1;
     // Calculate the maximum length to i.
     var maxLength = (nonWhiteSpaceChildren.length + start).toString().length;
-    _.each(nonWhiteSpaceChildren, function(elem, i) {
+    nonWhiteSpaceChildren.forEach(function(elem, i) {
       // Use different function depending on type
       var index = typeFunction(start, i);
       // Calculate the needed spacing for nice indentation.
       var spacing = maxLength - index.toString().length;
-      var prefix = ' ' + index + '. ' + _s.repeat(' ', spacing);
+      var prefix = ' ' + index + '. ' + ' '.repeat(spacing);
       result += formatListItem(prefix, elem, fn, options);
     });
   }
@@ -167,24 +172,24 @@ function formatOrderedList(elem, fn, options) {
 function tableToString(table) {
   // Determine space width per column
   // Convert all rows to lengths
-  var widths = _.map(table, function(row) {
-    return _.map(row, function(col) {
+  var widths = table.map(function(row) {
+    return row.map(function(col) {
       return col.length;
     });
   });
   // Invert rows with colums
   widths = helper.arrayZip(widths);
   // Determine the max values for each column
-  widths = _.map(widths, function(col) {
-    return _.max(col);
+  widths = widths.map(function(col) {
+    return max(col);
   });
 
   // Build the table
   var text = '';
-  _.each(table, function(row) {
+  table.forEach(function(row) {
     var i = 0;
-    _.each(row, function(col) {
-      text += _s.rpad(_s.strip(col), widths[i++], ' ') + '   ';
+    row.forEach(function(col) {
+      text += padEnd(col.trim(), widths[i++], ' ') + '   ';
     });
     text += '\n';
   });
@@ -193,7 +198,7 @@ function tableToString(table) {
 
 function formatTable(elem, fn, options) {
   var table = [];
-  _.each(elem.children, tryParseRows);
+  elem.children.forEach(tryParseRows);
   return tableToString(table);
 
   function tryParseRows(elem) {
@@ -205,27 +210,27 @@ function formatTable(elem, fn, options) {
       case "tbody":
       case "tfoot":
       case "center":
-        _.each(elem.children, tryParseRows);
+        elem.children.forEach(tryParseRows);
         return;
 
       case 'tr':
         var rows = [];
-        _.each(elem.children, function(elem) {
-          var tokens, times;
+        elem.children.forEach(function(elem) {
+          var tokens, count;
           if (elem.type === 'tag') {
             switch (elem.name.toLowerCase()) {
               case 'th':
                 tokens = formatHeading(elem, fn, options).split('\n');
-                rows.push(_.compact(tokens));
+                rows.push(compact(tokens));
                 break;
 
               case 'td':
                 tokens = fn(elem.children, options).split('\n');
-                rows.push(_.compact(tokens));
+                rows.push(compact(tokens));
                 // Fill colspans with empty values
                 if (elem.attribs && elem.attribs.colspan) {
-                  times = elem.attribs.colspan - 1 || 0;
-                  _.times(times, function() {
+                  count = elem.attribs.colspan - 1 || 0;
+                  times(count, function() {
                     rows.push(['']);
                   });
                 }
@@ -234,8 +239,8 @@ function formatTable(elem, fn, options) {
           }
         });
         rows = helper.arrayZip(rows);
-        _.each(rows, function(row) {
-          row = _.map(row, function(col) {
+        rows.forEach(function(row) {
+          row = row.map(function(col) {
             return col || '';
           });
           table.push(row);

lib/helper.js

@@ -1,5 +1,5 @@
-var _ = require('underscore');
-var _s = require('underscore.string');
+var zip = require('lodash/zip');
+var trimEnd = require('lodash/trimEnd');
 
 // Split a long word up to fit within the word wrap limit.  Use either a
 // character to split looking back from the word wrap limit, or
@@ -55,16 +55,16 @@ exports.wordwrap = function wordwrap(text, options) {
   var length = options.lineCharCount;
 
   // Preserve leading space
-  var result = _s.startsWith(text, ' ') ? ' ' : '';
+  var result = text.startsWith(' ') ? ' ' : '';
   length += result.length;
   var buffer = [];
   // Split the text into words, decide to preserve new lines or not.
   var words = preserveNewlines
     ? text.replace(/\n/g, '\n ').split(/\ +/)
-    : _s.words(text);
+    : text.trim().split(/\s+/);
 
   // Determine where to end line word by word.
-  _.each(words, function(word) {
+  words.forEach(function(word) {
     // Add buffer to result if we can't fit any more words in the buffer.
     if ((max || max === 0) && length > 0 && ((length + word.length > max) || (length + word.indexOf('\n') > max))) {
       // Concat buffer and add it to the result
@@ -101,17 +101,17 @@ exports.wordwrap = function wordwrap(text, options) {
   result += buffer.join(' ');
 
   // Preserve trailing space
-  if (!_s.endsWith(text, ' ')) {
-    result = _s.rtrim(result);
-  } else if (!_s.endsWith(result, ' ')) {
+  if (!text.endsWith(' ')) {
+    result = trimEnd(result);
+  } else if (!result.endsWith(' ')) {
     result = result + ' ';
   }
 
   return result;
 };
 
 exports.arrayZip = function arrayZip(array) {
-  return _.zip.apply(_, array);
+  return zip.apply(null, array);
 };
 
 exports.splitCssSearchTag = function splitCssSearchTag(tagString) {
@@ -131,3 +131,9 @@ exports.splitCssSearchTag = function splitCssSearchTag(tagString) {
 
   return splitTag;
 };
+
+exports.replaceAll = function replaceAll(str, find, replace) {
+  var reg = new RegExp(find, 'g');
+
+  return str.replace(reg, replace);
+};

lib/html-to-text.js

@@ -1,8 +1,8 @@
 var fs = require('fs');
 var util = require('util');
 
-var _ = require('underscore');
-var _s = require('underscore.string');
+var includes = require('lodash/includes');
+var trimEnd = require('lodash/trimEnd');
 var htmlparser = require('htmlparser2');
 
 var helper = require('./helper');
@@ -15,8 +15,7 @@ var SKIP_TYPES = [
 ];
 
 function htmlToText(html, options) {
-  options = options || {};
-  _.defaults(options, {
+  options = Object.assign({
     wordwrap: 80,
     tables: [],
     preserveNewlines: false,
@@ -38,7 +37,7 @@ function htmlToText(html, options) {
       forceWrapOnLimit: false
     },
     unorderedListItemPrefix: ' * '
-  });
+  }, options || {});
 
   var handler = new htmlparser.DefaultHandler(function (error, dom) {
 
@@ -54,7 +53,7 @@ function htmlToText(html, options) {
   for (var idx = 0; idx < baseElements.length; ++idx) {
     result += walk(filterBody(handler.dom, options, baseElements[idx]), options);
   }
-  return _s.rtrim(result);
+  return trimEnd(result);
 }
 
 function filterBody(dom, options, baseElement) {
@@ -64,7 +63,7 @@ function filterBody(dom, options, baseElement) {
 
   function walk(dom) {
     if (result) return;
-    _.each(dom, function(elem) {
+    dom.forEach(function(elem) {
       if (result) return;
       if (elem.name === splitTag.element) {
         var documentClasses = elem.attribs && elem.attribs.class ? elem.attribs.class.split(" ") : [];
@@ -91,28 +90,31 @@ function containsTable(attr, tables) {
   }
   function checkPrefix(prefix) {
     return function(key) {
-      return _s.startsWith(key, prefix);
+      return key.startsWith(prefix);
     };
   }
   function filterByPrefix(tables, prefix) {
-    return _(tables).chain()
+    return tables
       .filter(checkPrefix(prefix))
-      .map(removePrefix)
-      .value();
+      .map(removePrefix);
   }
   var classes = filterByPrefix(tables, '.');
   var ids = filterByPrefix(tables, '#');
-  return attr && (_.include(classes, attr['class']) || _.include(ids, attr['id']));
+  return attr && (includes(classes, attr['class']) || includes(ids, attr['id']));
 }
 
 function walk(dom, options, result) {
   if (arguments.length < 3) {
     result = '';
   }
   var whiteSpaceRegex = /\s$/;
-  var format = _.assign({}, defaultFormat, options.format);
+  var format = Object.assign({}, defaultFormat, options.format);
+
+  if (!dom) {
+    return result;
+  }
 
-  _.each(dom, function(elem) {
+  dom.forEach(function(elem) {
     switch(elem.type) {
       case 'tag':
         switch(elem.name.toLowerCase()) {
@@ -149,7 +151,7 @@ function walk(dom, options, result) {
             result += format.orderedList(elem, walk, options);
             break;
           case 'pre':
-            var newOptions = _(options).clone();
+            var newOptions = Object.assign({}, options);
             newOptions.isInPre = true;
             result += format.paragraph(elem, walk, newOptions);
             break;
@@ -171,7 +173,7 @@ function walk(dom, options, result) {
         }
         break;
       default:
-        if (!_.include(SKIP_TYPES, elem.type)) {
+        if (!includes(SKIP_TYPES, elem.type)) {
           result = walk(elem.children || [], options, result);
         }
     }