2186046714

Build Type

github

Committed by GitHub

Commit Message

<a href="https://github.com/gulpjs/remove-bom-stream/commit/<a class=hub.com/gulpjs/remove-bom-stream/commit/<a class="double-link" href="https://git"><a class=hub.com/gulpjs/remove-bom-stream/commit/<a class="double-link" href="https://git"><a class=hub.com/gulpjs/remove-bom-stream/commit/<a class="double-link" href="https://git"><a class=hub.com/gulpjs/remove-bom-stream/commit/ba1f6aa68a600a73d1d4dce1cb71cc864d11b6e8">ba1f6aa68">&lt;a href=&quot;https://github.com/gulpjs/remove-bom-stream/commit/</a><a class="double-link" href="https://github.com/gulpjs/remove-bom-stream/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://git">&lt;a class=</a>hub.com/gulpjs/remove-bom-stream/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://git">&lt;a class=</a>hub.com/gulpjs/remove-bom-stream/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://git">&lt;a class=</a>hub.com/gulpjs/remove-bom-stream/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://git">&lt;a class=</a>hub.com/gulpjs/remove-bom-stream/commit/ba1f6aa68a600a73d1d4dce1cb71cc864d11b6e8">ba1f6aa68</a><a href="https://github.com/gulpjs/remove-bom-stream/commit/ba1f6aa68a600a73d1d4dce1cb71cc864d11b6e8">&quot;&gt;&amp;lt;a href=&amp;quot;https://github.com/gulpjs/remove-bom-stream/commit/&lt;/a&gt;&lt;a class=&quot;double-link&quot; href=&quot;https://github.com/gulpjs/remove-bom-stream/commit/&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://git&quot;&gt;&amp;lt;a class=&lt;/a&gt;hub.com/gulpjs/remove-bom-stream/commit/&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://git&quot;&gt;&amp;lt;a class=&lt;/a&gt;hub.com/gulpjs/remove-bom-stream/commit/&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://git&quot;&gt;&amp;lt;a class=&lt;/a&gt;hub.com/gulpjs/remove-bom-stream/commit/&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://git&quot;&gt;&amp;lt;a class=&lt;/a&gt;hub.com/gulpjs/remove-bom-stream/commit/ba1f6aa68a600a73d1d4dce1cb71cc864d11b6e8&quot;&gt;ba1f6aa68&lt;/a&gt;&lt;a href=&quot;https://github.com/gulpjs/remove-bom-stream/commit/ba1f6aa68a600a73d1d4dce1cb71cc864d11b6e8&quot;&gt;&amp;quot;&amp;gt;&amp;amp;lt;a href=&amp;amp;quot;https://github.com/gulpjs/remove-bom-stream/commit/&amp;lt;/a&amp;gt;&amp;lt;a... (continued)

Pull Request Pull Request #8: feat!: Require encoding option to avoid inspecting chunks for UTF-8 encoding

Run Details

11 of 12 branches covered (91.67%)

Branch coverage included in aggregate %.

22 of 23 new or added lines in 1 file covered. (95.65%)

25 of 26 relevant lines covered (96.15%)

124.04 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

94.74

/index.js

'use strict';

var through = require('through2');
var TextDecoder = require('util').TextDecoder;

var BOM = Buffer.from([0xEF, 0xBB, 0xBF], 'utf-8');

function removeBomStream(encoding) {
  encoding = (encoding || '').toLowerCase();
  var isUTF8 = (encoding === 'utf-8' || encoding === 'utf8');

  if (!isUTF8) {
    return through();
  }

  // Only used if encoding is UTF-8
  var decoder = new TextDecoder('utf-8', { ignoreBOM: false });

  var state = 0; // 0:Not removed, -1:In removing, 1:Already removed

  return through(onChunk);

  function onChunk(data, _, cb) {
    if (state === 1) {
      cb(null, data);
      return;
    }

    try {
      state = -1;

      var chunk = decoder.decode(data, { stream: true });

      // The first time we have data after a decode, it should have already removed the BOM
      if (chunk !== '') {
        chunk += decoder.decode(); // end of stream mode and clear inner buffer.

        var buffer = Buffer.from(chunk, 'utf-8');

        // Node<=v12, TextDecoder#decode returns a BOM if it receives a BOM separately.
        // Ref https://github.com/nodejs/node/pull/30132
        if (BOM.compare(buffer) !== 0) {
          state = 1;
          cb(null, buffer);
          return;
        }
      }

      cb();
    } catch (err) {
      cb(err);
    }
  }
}

module.exports = removeBomStream;

1	'use strict';
2
3	var through = require('through2');	12✔
4	var TextDecoder = require('util').TextDecoder;	12✔
5
6	var BOM = Buffer.from([0xEF, 0xBB, 0xBF], 'utf-8');	12✔
7
8	function removeBomStream(encoding) {
9	encoding = (encoding \|\| '').toLowerCase();	108!
10	var isUTF8 = (encoding === 'utf-8' \|\| encoding === 'utf8');	108✔
11
12	if (!isUTF8) {	108✔
13	return through();	36✔
14	}
15
16	// Only used if encoding is UTF-8
17	var decoder = new TextDecoder('utf-8', { ignoreBOM: false });	72✔
18
19	var state = 0; // 0:Not removed, -1:In removing, 1:Already removed	72✔
20
21	return through(onChunk);	72✔
22
23	function onChunk(data, _, cb) {
24	if (state === 1) {	636✔
25	cb(null, data);	528✔
26	return;	528✔
27	}
28
29	try {	108✔
30	state = -1;	108✔
31
32	var chunk = decoder.decode(data, { stream: true });	108✔
33
34	// The first time we have data after a decode, it should have already removed the BOM
35	if (chunk !== '') {	108✔
36	chunk += decoder.decode(); // end of stream mode and clear inner buffer.	75✔
37
38	var buffer = Buffer.from(chunk, 'utf-8');	75✔
39
40	// Node<=v12, TextDecoder#decode returns a BOM if it receives a BOM separately.
41	// Ref https://github.com/nodejs/node/pull/30132
42	if (BOM.compare(buffer) !== 0) {	75✔
43	state = 1;	72✔
44	cb(null, buffer);	72✔
45	return;	72✔
46	}
47	}
48
49	cb();	36✔
50	} catch (err) {
NEW 51	cb(err);	×
52	}
53	}
54	}
55
56	module.exports = removeBomStream;	12✔

gulpjs / remove-bom-stream / 2186046714

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous