Initial commit

Extracted from https://github.com/tmpvar/jsdom/blob/7ce11776ce161e8d5921a7a183585327400f786b/lib/jsdom/living/helpers/encoding.js (omitting the <meta charset> parts).

Author: domenic

.editorconfig

@@ -0,0 +1,9 @@
+root = true
+
+[*]
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+charset = utf-8
+indent_style = space
+indent_size = 2

.eslintrc.json

@@ -0,0 +1,237 @@
+{
+  "root": true,
+  "env": {
+    "node": true,
+    "es6": true
+  },
+  "parserOptions": {
+    "ecmaVersion": 6
+  },
+  "rules": {
+    // Possible errors
+    "comma-dangle": ["error", "never"],
+    "no-cond-assign": ["error", "except-parens"],
+    "no-console": "error",
+    "no-constant-condition": "off",
+    "no-control-regex": "off",
+    "no-debugger": "error",
+    "no-dupe-args": "error",
+    "no-dupe-keys": "error",
+    "no-duplicate-case": "error",
+    "no-empty": "error",
+    "no-empty-character-class": "error",
+    "no-ex-assign": "error",
+    "no-extra-boolean-cast": "error",
+    "no-extra-parens": ["error", "all", { "conditionalAssign": false, "nestedBinaryExpressions": false, "returnAssign": false }],
+    "no-extra-semi": "error",
+    "no-func-assign": "error",
+    "no-inner-declarations": "off",
+    "no-invalid-regexp": "error",
+    "no-irregular-whitespace": "error",
+    "no-negated-in-lhs": "error",
+    "no-obj-calls": "error",
+    "no-regex-spaces": "error",
+    "no-sparse-arrays": "error",
+    "no-unexpected-multiline": "error",
+    "no-unreachable": "error",
+    "no-unsafe-finally": "off",
+    "use-isnan": "error",
+    "valid-jsdoc": "off",
+    "valid-typeof": "error",
+
+    // Best practices
+    "accessor-pairs": "error",
+    "array-callback-return": "error",
+    "block-scoped-var": "off",
+    "complexity": "off",
+    "consistent-return": "error",
+    "curly": ["error", "all"],
+    "default-case": "off",
+    "dot-location": ["error", "property"],
+    "dot-notation": "error",
+    "eqeqeq": "error",
+    "guard-for-in": "off",
+    "no-alert": "error",
+    "no-caller": "error",
+    "no-case-declarations": "error",
+    "no-div-regex": "off",
+    "no-else-return": "error",
+    "no-empty-function": "error",
+    "no-empty-pattern": "error",
+    "no-eq-null": "error",
+    "no-eval": "error",
+    "no-extend-native": "error",
+    "no-extra-bind": "error",
+    "no-extra-label": "error",
+    "no-fallthrough": "error",
+    "no-floating-decimal": "error",
+    "no-implicit-coercion": "error",
+    "no-implicit-globals": "error",
+    "no-implied-eval": "error",
+    "no-invalid-this": "error",
+    "no-iterator": "error",
+    "no-labels": ["error", { "allowLoop": true }],
+    "no-lone-blocks": "error",
+    "no-loop-func": "off",
+    "no-magic-numbers": "off",
+    "no-multi-spaces": "error",
+    "no-multi-str": "error",
+    "no-native-reassign": "error",
+    "no-new": "error",
+    "no-new-func": "error",
+    "no-new-wrappers": "error",
+    "no-octal": "error",
+    "no-octal-escape": "error",
+    "no-param-reassign": "off",
+    "no-process-env": "error",
+    "no-proto": "error",
+    "no-redeclare": "error",
+    "no-return-assign": ["error", "except-parens"],
+    "no-script-url": "off",
+    "no-self-assign": "error",
+    "no-self-compare": "error",
+    "no-sequences": "error",
+    "no-throw-literal": "error",
+    "no-unmodified-loop-condition": "error",
+    "no-unused-expressions": "error",
+    "no-unused-labels": "error",
+    "no-useless-call": "error",
+    "no-useless-concat": "error",
+    "no-useless-escape": "error",
+    "no-void": "error",
+    "no-warning-comments": "off",
+    "no-with": "error",
+    "radix": ["error", "as-needed"],
+    "vars-on-top": "off",
+    "wrap-iife": ["error", "outside"],
+    "yoda": ["error", "never"],
+
+    // Strict Mode
+    "strict": ["error", "global"],
+
+    // Variables
+    "init-declarations": "off",
+    "no-catch-shadow": "error",
+    "no-delete-var": "error",
+    "no-label-var": "error",
+    "no-restricted-globals": "off",
+    "no-shadow": "error",
+    "no-shadow-restricted-names": "error",
+    "no-undef": "error",
+    "no-undef-init": "error",
+    "no-undefined": "off",
+    "no-unused-vars": "error",
+    "no-use-before-define": ["error", "nofunc"],
+
+    // Node.js and CommonJS
+    "callback-return": "off",
+    "global-require": "error",
+    "handle-callback-err": "error",
+    "no-mixed-requires": ["error", true],
+    "no-new-require": "error",
+    "no-path-concat": "error",
+    "no-process-exit": "error",
+    "no-restricted-imports": "off",
+    "no-restricted-modules": "off",
+    "no-sync": "off",
+
+    // Stylistic Issues
+    "array-bracket-spacing": ["error", "never"],
+    "block-spacing": ["error", "always"],
+    "brace-style": ["error", "1tbs", { "allowSingleLine": false }],
+    "camelcase": ["error", { "properties": "always" }],
+    "comma-spacing": ["error", { "before": false, "after": true }],
+    "comma-style": ["error", "last"],
+    "computed-property-spacing": ["error", "never"],
+    "consistent-this": "off",
+    "eol-last": "error",
+    "func-names": "off",
+    "func-style": ["error", "declaration"],
+    "id-blacklist": "off",
+    "id-length": "off",
+    "id-match": "off",
+    "indent": ["error", 2, { "SwitchCase": 1 }],
+    "jsx-quotes": "off",
+    "key-spacing": ["error", { "beforeColon": false, "afterColon": true, "mode": "strict" }],
+    "keyword-spacing": ["error", { "before": true, "after": true }],
+    "linebreak-style": ["error", "unix"],
+    "lines-around-comment": "off",
+    "max-depth": "off",
+    "max-len": ["error", 120, { "ignoreUrls": true }],
+    "max-nested-callbacks": "off",
+    "max-params": "off",
+    "max-statements": "off",
+    "max-statements-per-line": ["error", { "max": 1 }],
+    "new-cap": ["error", { "capIsNewExceptions": ["USVString"] }],
+    "new-parens": "error",
+    "newline-after-var": "off",
+    "newline-before-return": "off",
+    "newline-per-chained-call": "off",
+    "no-array-constructor": "error",
+    "no-bitwise": "off",
+    "no-continue": "off",
+    "no-inline-comments": "off",
+    "no-lonely-if": "error",
+    "no-mixed-spaces-and-tabs": "error",
+    "no-multiple-empty-lines": "error",
+    "no-negated-condition": "off",
+    "no-nested-ternary": "error",
+    "no-new-object": "error",
+    "no-plusplus": "off",
+    "no-restricted-syntax": "off",
+    "no-spaced-func": "error",
+    "no-ternary": "off",
+    "no-trailing-spaces": "error",
+    "no-underscore-dangle": "off",
+    "no-unneeded-ternary": "error",
+    "no-whitespace-before-property": "error",
+    "object-curly-spacing": ["error", "always"],
+    "object-property-newline": "off",
+    "one-var": ["error", "never"],
+    "one-var-declaration-per-line": ["error", "initializations"],
+    "operator-assignment": ["error", "always"],
+    "operator-linebreak": ["error", "after"],
+    "padded-blocks": ["error", "never"],
+    "quote-props": ["error", "as-needed"],
+    "quotes": ["error", "double", { "avoidEscape": true, "allowTemplateLiterals": true }],
+    "require-jsdoc": "off",
+    "semi": ["error", "always"],
+    "semi-spacing": "error",
+    "sort-imports": "off",
+    "sort-vars": "off",
+    "space-before-blocks": ["error", "always"],
+    "space-before-function-paren": ["error", { "anonymous": "always", "named": "never" }],
+    "space-in-parens": ["error", "never"],
+    "space-infix-ops": "error",
+    "space-unary-ops": ["error", { "words": true, "nonwords": false }],
+    "spaced-comment": ["error", "always", { "markers": ["///"] }],
+    "wrap-regex": "off",
+
+    // ECMAScript 6
+    "arrow-body-style": "off", // meh
+    "arrow-parens": ["error", "as-needed"],
+    "arrow-spacing": "error",
+    "constructor-super": "error",
+    "generator-star-spacing": ["error", "after"],
+    "no-class-assign": "error",
+    "no-confusing-arrow": "off",
+    "no-const-assign": "error",
+    "no-dupe-class-members": "error",
+    "no-duplicate-imports": "error",
+    "no-new-symbol": "error",
+    "no-this-before-super": "error",
+    "no-useless-computed-key": "error",
+    "no-useless-constructor": "error",
+    "no-var": "error",
+    "object-shorthand": "error",
+    "prefer-arrow-callback": "error",
+    "prefer-const": ["error", { "ignoreReadBeforeAssign": true }],
+    "prefer-reflect": "off",
+    "prefer-rest-params": "off",
+    "prefer-spread": "off", // TODO with new Node versions
+    "prefer-template": "off",
+    "require-yield": "error",
+    "template-curly-spacing": ["error", "never"],
+    "yield-star-spacing": ["error", "after"]
+  }
+}

.gitignore

@@ -0,0 +1,4 @@
+/node_modules/
+/npm-debug.log
+
+/lib/*.json

.travis.yml

@@ -0,0 +1,5 @@
+language: node_js
+node_js:
+  - stable
+script:
+  npm run lint && npm test

LICENSE.txt

@@ -0,0 +1,19 @@
+Copyright © 2016 Domenic Denicola <[email protected]>
+
+This work is free. You can redistribute it and/or modify it under the
+terms of the Do What The Fuck You Want To Public License, Version 2,
+as published by Sam Hocevar. See below for more details.
+
+        DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
+                    Version 2, December 2004
+
+ Copyright (C) 2004 Sam Hocevar <[email protected]>
+
+ Everyone is permitted to copy and distribute verbatim or modified
+ copies of this license document, and changing it is allowed as long
+ as the name is changed.
+
+            DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
+   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+  0. You just DO WHAT THE FUCK YOU WANT TO.

README.md

@@ -0,0 +1,50 @@
+# Decode According to the WHATWG Encoding Standard
+
+This package provides a thin layer on top of [iconv-lite](https://github.com/ashtuchkin/iconv-lite) which makes it expose some of the same primitives as the [Encoding Standard](https://encoding.spec.whatwg.org/).
+
+```js
+const whatwgEncoding = require("whatwg-encoding");
+
+console.assert(whatwgEncoding.labelToName("latin1") === "windows-1252");
+console.assert(whatwgEncoding.labelToName("  CYRILLic ") === "ISO-8859-5");
+
+console.assert(whatwgEncoding.isSupported("IBM866") === true);
+
+// Not supported by the Encoding Standard
+console.assert(whatwgEncoding.isSupported("UTF-32") === false);
+
+// In the Encoding Standard, but this package can't decode it
+console.assert(whatwgEncoding.isSupported("x-mac-cyrillic") === false);
+
+console.assert(whatwgEncoding.getBOMEncoding(new Buffer([0xFE, 0xFF])) === "UTF-16BE");
+console.assert(whatwgEncoding.getBOMEncoding(new Buffer([0x48, 0x69])) === null);
+
+console.assert(whatwgEncoding.decode(new Buffer([0x48, 0x69]), "UTF-8") === "Hi");
+```
+
+## API
+
+- `decode(buffer, fallbackEncodingName)`: performs the [decode](https://encoding.spec.whatwg.org/#decode) algorithm (in which any BOM will override the passed fallback encoding), and returns the resulting string
+- `labelToName(label)`: performs the [get an encoding](https://encoding.spec.whatwg.org/#concept-encoding-get) algorithm and returns the resulting encoding's name, or `null` for failure
+- `isSupported(name)`: returns whether the encoding is one of [the encodings](https://encoding.spec.whatwg.org/#names-and-labels) of the Encoding Standard, _and_ is an encoding that this package can decode (via iconv-lite)
+- `getBOMEncoding(buffer)`: sniffs the first 2–3 bytes of the supplied `Buffer`, returning one of the encoding names `"UTF-8"`, `"UTF-16LE"`, or `"UTF-16BE"` if the appropriate BOM is present, or `null` if no BOM is present
+
+## Unsupported encodings
+
+Since we rely on iconv-lite, we are limited to support only the encodings that they support. Currently we are missing support for:
+
+- ISO-2022-JP
+- ISO-8859-8-I
+- replacement
+- x-mac-cyrillic
+- x-user-defined
+
+Passing these encoding names will return `false` when calling `isSupported`, and passing any of the possible labels for these encodings to `labelToName` will return `null`.
+
+## Credits
+
+This package was originally based on the excellent work of [@nicolashenry](https://github.com/nicolashenry), [in jsdom](https://github.com/tmpvar/jsdom/blob/7ce11776ce161e8d5921a7a183585327400f786b/lib/jsdom/living/helpers/encoding.js). It has since been pulled out into this separate package.
+
+## Alternatives
+
+If you are looking for a JavaScript implementation of the Encoding Standard's `TextEncoder` and `TextDecoder` APIs, you'll want [@inexorabletash](https://github.com/inexorabletash)'s [text-encoding](https://github.com/inexorabletash/text-encoding) package.

lib/whatwg-encoding.js

@@ -0,0 +1,47 @@
+"use strict";
+const iconvLite = require("iconv-lite");
+const supportedNames = require("./supported-names.json");
+const labelsToNames = require("./labels-to-names.json");
+
+const supportedNamesSet = new Set(supportedNames);
+
+// https://encoding.spec.whatwg.org/#concept-encoding-get
+exports.labelToName = label => {
+  label = label.trim().toLowerCase();
+
+  return labelsToNames[label] || null;
+};
+
+// https://encoding.spec.whatwg.org/#decode
+exports.decode = (buffer, fallbackEncodingName) => {
+  let encoding = fallbackEncodingName;
+  if (!exports.isSupported(encoding)) {
+    throw new RangeError(`"${encoding}" is not a supported encoding name`);
+  }
+
+  const bomEncoding = exports.getBOMEncoding(buffer);
+  if (bomEncoding !== null) {
+    encoding = bomEncoding;
+  }
+
+  // iconv-lite will strip BOMs for us, so no need to do the stuff the spec does
+
+  return iconvLite.decode(buffer, encoding);
+};
+
+// https://github.com/whatwg/html/issues/1910#issuecomment-254017369
+exports.getBOMEncoding = buffer => {
+  if (buffer[0] === 0xFE && buffer[1] === 0xFF) {
+    return "UTF-16BE";
+  } else if (buffer[0] === 0xFF && buffer[1] === 0xFE) {
+    return "UTF-16LE";
+  } else if (buffer[0] === 0xEF && buffer[1] === 0xBB && buffer[2] === 0xBF) {
+    return "UTF-8";
+  }
+
+  return null;
+};
+
+exports.isSupported = name => {
+  return supportedNamesSet.has(name);
+};