Merge remote-tracking branch 'origin/main' into webpack5

Author: gfx

.eslintrc.js

@@ -41,7 +41,6 @@ module.exports = {
       { "selector": "typeLike", "format": ["PascalCase"], "leadingUnderscore": "allow" },
     ],
     "@typescript-eslint/restrict-plus-operands": ["warn", { "checkCompoundAssignments": true }],
-    "@typescript-eslint/no-non-null-assertion": "warn", // NOTE: pay attention to it because it may cause unexpected behavior
     "@typescript-eslint/no-throw-literal": "warn",
     "@typescript-eslint/no-extra-semi": "warn",
     "@typescript-eslint/no-extra-non-null-assertion": "warn",
@@ -53,6 +52,8 @@ module.exports = {
     "@typescript-eslint/no-non-null-asserted-optional-chain": "warn",
     "@typescript-eslint/no-invalid-void-type": "warn",
     "@typescript-eslint/no-loss-of-precision": "warn",
+    "@typescript-eslint/no-confusing-void-expression": "warn",
+    "@typescript-eslint/no-unnecessary-type-constraint": "warn",
     "@typescript-eslint/prefer-for-of": "warn",
     "@typescript-eslint/prefer-includes": "warn",
     "@typescript-eslint/prefer-string-starts-ends-with": "warn",
@@ -68,6 +69,7 @@ module.exports = {
     "@typescript-eslint/no-empty-interface": "off",
     "@typescript-eslint/no-empty-function": "off",
     "@typescript-eslint/no-var-requires": "off",
+    "@typescript-eslint/no-non-null-assertion": "off",
     "@typescript-eslint/ban-ts-comment": "off",
   },
 };

.github/workflows/ci.yml

@@ -0,0 +1,47 @@
+name: CI
+
+on:
+  push:
+    branches:
+    - main
+  pull_request:
+
+jobs:
+  nodejs:
+    runs-on: ubuntu-20.04
+
+    strategy:
+      matrix:
+        node-version: ['12', '14']
+
+    steps:
+    - uses: actions/checkout@v2
+
+    - name: Setup Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v1
+      with:
+        node-version: ${{ matrix.node-version }}
+
+    - run: npm install -g npm
+    - run: npm install -g nyc codecov
+    - run: npm ci
+    - run: npm run test:cover
+    - run: codecov -f coverage/*.json
+
+  browser:
+    runs-on: ubuntu-20.04
+    strategy:
+      matrix:
+        browser: [ChromeHeadless, FirefoxHeadless]
+    steps:
+    - uses: actions/checkout@v2
+
+    - name: Setup Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v1
+      with:
+        node-version: '14'
+
+    - run: npm install -g npm
+    - run: npm ci
+    - run: npm run test:browser -- --browsers ${{ matrix.browser }}
+

.travis.yml

@@ -41,6 +41,7 @@ matrix:
     - env: BROWSER=slAndroid
 cache: npm
 install: |
+  npm install -g npm
   if [ "${BROWSER}" = "" ]
     then npm install -g nyc codecov
   fi

CHANGELOG.md

@@ -1,5 +1,12 @@
 This is the revision history of @msgpack/msgpack
 
+## v2.3.0 2020/10/17
+
+https://github.com/msgpack/msgpack-javascript/compare/v2.2.1...v2.3.0
+
+* Change the extension of ESM files from `.js` to `.mjs` [#144](https://github.com/msgpack/msgpack-javascript/pull/144)
+* Make the package work with `strictNullChecks: false` [#139](https://github.com/msgpack/msgpack-javascript/pull/139) by @bananaumai
+
 ## v2.2.1 2020/10/11
 
 https://github.com/msgpack/msgpack-javascript/compare/v2.2.0...v2.2.1

README.md

@@ -1,8 +1,9 @@
 # MessagePack for JavaScript/ECMA-262
 
-[![npm version](https://img.shields.io/npm/v/@msgpack/msgpack.svg)](https://www.npmjs.com/package/@msgpack/msgpack) [![Build Status](https://travis-ci.org/msgpack/msgpack-javascript.svg?branch=master)](https://travis-ci.org/msgpack/msgpack-javascript) [![codecov](https://codecov.io/gh/msgpack/msgpack-javascript/branch/master/graphs/badge.svg)](https://codecov.io/gh/msgpack/msgpack-javascript) [![bundlephobia](https://badgen.net/bundlephobia/minzip/@msgpack/msgpack)](https://bundlephobia.com/result?p=@msgpack/msgpack)
+[![npm version](https://img.shields.io/npm/v/@msgpack/msgpack.svg)](https://www.npmjs.com/package/@msgpack/msgpack) ![CI](https://github.com/msgpack/msgpack-javascript/workflows/CI/badge.svg) [![codecov](https://codecov.io/gh/msgpack/msgpack-javascript/branch/master/graphs/badge.svg)](https://codecov.io/gh/msgpack/msgpack-javascript) [![bundlephobia](https://badgen.net/bundlephobia/minzip/@msgpack/msgpack)](https://bundlephobia.com/result?p=@msgpack/msgpack)
 
-[![Browser Matrix powered by Sauce Labs](https://saucelabs.com/browser-matrix/gfx2019.svg)](https://saucelabs.com)
+<!--
+[![Browser Matrix powered by Sauce Labs](https://app.saucelabs.com/browser-matrix/gfx2019.svg)](https://app.saucelabs.com/u/gfx2019) -->
 
 This is a JavaScript/ECMA-262 implementation of **MessagePack**, an efficient binary serilization format:
 
@@ -57,7 +58,7 @@ deepStrictEqual(decode(encoded), object);
 - [Decoding a Blob](#decoding-a-blob)
 - [MessagePack Specification](#messagepack-specification)
   - [MessagePack Mapping Table](#messagepack-mapping-table)
-- [Prerequsites](#prerequsites)
+- [Prerequisites](#prerequisites)
   - [ECMA-262](#ecma-262)
   - [NodeJS](#nodejs)
   - [TypeScript](#typescript)
@@ -70,7 +71,6 @@ deepStrictEqual(decode(encoded), object);
   - [Continuous Integration](#continuous-integration)
   - [Release Engineering](#release-engineering)
   - [Updating Dependencies](#updating-dependencies)
-- [Big Thanks](#big-thanks)
 - [License](#license)
 
 <!-- /TOC -->
@@ -125,9 +125,9 @@ context | user-defined | -
 
 ### `decode(buffer: ArrayLike<number> | ArrayBuffer, options?: DecodeOptions): unknown`
 
-It decodes `buffer` encoded in MessagePack, and returns a decoded object as `uknown`.
+It decodes `buffer` encoded in MessagePack, and returns a decoded object as `unknown`.
 
-`buffer` must be an array of bytes, which is typically `Uint8Array`, or `ArrayBuffer`.
+`buffer` must be an array of bytes, which is typically `Uint8Array` or `ArrayBuffer`, but `Array<number>` is okay.
 
 for example:
 
@@ -215,6 +215,22 @@ for await (const item of decodeStream(stream)) {
 }
 ```
 
+If you have a multi-values MessagePack binary, you can use `decodeStream()`, but you need to convert it to a stream or an async generator like this:
+
+```typescript
+// A function that generates an AsyncGenerator
+const createStream = async function* (): AsyncGenerator<Uint8Array> {
+  yield encoded;
+};
+
+const result: Array<unknown> = [];
+
+// Decodes it with for-await
+for await (const item of decodeStream(createStream())) {
+  result.push(item);
+}
+```
+
 ### Reusing Encoder and Decoder instances
 
 `Encoder` and `Decoder` classes is provided for better performance:
@@ -461,7 +477,7 @@ Date|timestamp ext family|Date (*4)
 * *3 In handling `Object`, it is regarded as `Record<string, unknown>` in terms of TypeScript
 * *4 MessagePack timestamps may have nanoseconds, which will lost when it is decoded into JavaScript `Date`. This behavior can be overridden by registering `-1` for the extension codec.
 
-## Prerequsites
+## Prerequisites
 
 This is a universal JavaScript library that supports major browsers and NodeJS.
 
@@ -519,17 +535,17 @@ Note that `Buffer.from()` for `JSON.stringify()` is necessary to emulate I/O whe
 
 The NPM package distributed in npmjs.com includes both ES2015+ and ES5 files:
 
-* `dist/` is compiled into ES2015+, provided for NodeJS v10 or later
-* `dist.es5+umd/` is compiled into ES5 with UMD-style single file
-  * `dist.es5+umd/msgpack.min.js` - the default, minified file (UMD)
-  * `dist.es5+umd/msgpack.js` - an optional, non-minified file (UMD)
-* `dist.es5+esm/` is compiled into ES5 and placed as ES modules, provided for webpack-like bundlers, not NodeJS
+* `dist/` is compiled into ES2019 with CommomJS, provided for NodeJS v10
+* `dist.es5+umd/` is compiled into ES5 with UMD
+  * `dist.es5+umd/msgpack.min.js` - the minified file
+  * `dist.es5+umd/msgpack.js` - the non-minified file
+* `dist.es5+esm/` is compiled into ES5 with ES modules, provided for webpack-like bundlers and NodeJS's ESM-mode
 
 If you use NodeJS and/or webpack, their module resolvers use the suitable one automatically.
 
 ### CDN / unpkg.com
 
-This library is availble via CDN:
+This library is available via CDN:
 
 ```html
 <script crossorigin src="https://unpkg.com/@msgpack/msgpack"></script>
@@ -556,7 +572,7 @@ test matrix:
 * TypeScript targets
   * `target=es2019` / `target=es5`
 * JavaScript engines
-  * NodeJS, borwsers (Chrome, Firefox, Safari, IE11, and so on)
+  * NodeJS, browsers (Chrome, Firefox, Safari, IE11, and so on)
 
 See [test:* in package.json](./package.json) and [.travis.yml](./.travis.yml) for details.
 
@@ -582,11 +598,11 @@ make publish
 npm run update-dependencies
 ```
 
-## Big Thanks
+<!-- ## Big Thanks
 
 Cross-browser Testing Platform and Open Source <3 Provided by Sauce Labs.
 
-<a href="https://saucelabs.com"><img src="./assets/SauceLabs.svg" alt="Sauce Labs" width="280"></a>
+<a href="https://saucelabs.com"><img src="./assets/SauceLabs.svg" alt="Sauce Labs" width="280"></a> -->
 
 ## License
 

karma.conf.ts

@@ -39,13 +39,6 @@ export default function configure(config: any) {
     webpack: {
       mode: "production",
 
-      // Handles NodeJS polyfills
-      // https://webpack.js.org/configuration/node
-      // Note that the dependencies in https://github.com/webpack/node-libs-browser are sometimes too old.
-      node: {
-        assert: false,
-        util: false,
-      },
       resolve: {
         extensions: [".ts", ".tsx", ".mjs", ".js", ".json", ".wasm"],
         alias: {