Merge pull request #1 from sxwei123/develop

Setup Github Actions for unit test

Author: sxwei123

.eslintignore

@@ -0,0 +1,2 @@
+node_modules
+dist

.eslintrc.yml

@@ -1,26 +1,36 @@
-extends: eslint:recommended
-env:
-  node: true
-  browser: true
+---
+parser: "@typescript-eslint/parser"
+plugins:
+  - "@typescript-eslint"
+extends:
+  - "plugin:@typescript-eslint/recommended"
+  - eslint-config-prettier
+  - plugin:import/errors
+  - plugin:import/warnings
+  - plugin:import/typescript
 rules:
-  block-scoped-var: 2
-  callback-return: 2
-  dot-notation: 2
-  indent: 2
-  linebreak-style: [2, unix]
-  new-cap: 2
-  no-console: [2, allow: [warn, error]]
-  no-else-return: 2
-  no-eq-null: 2
-  no-fallthrough: 2
-  no-invalid-this: 2
-  no-return-assign: 2
-  no-shadow: 1
-  no-trailing-spaces: 2
-  no-use-before-define: [2, nofunc]
-  quotes: [2, single, avoid-escape]
-  semi: [2, always]
-  strict: [2, global]
-  valid-jsdoc: [2, requireReturn: false]
-  no-control-regex: 0
-  no-useless-escape: 2
+  "@typescript-eslint/no-unused-vars":
+    - warn
+    - argsIgnorePattern: "^_"
+  no-use-before-define:
+    - warn
+  "@typescript-eslint/no-use-before-define":
+    - warn
+  no-unused-expressions:
+    - error
+  no-underscore-dangle:
+    - error
+    - # allow couchdb stuff
+      allow:
+        - _id
+        - _rev
+        - _deleted
+        - __typename
+      allowAfterThis: true
+      allowAfterSuper: true
+      enforceInMethodNames: true
+  one-var:
+    - error
+    - never
+  class-methods-use-this:
+    - error

.github/workflows/publish.yml

@@ -0,0 +1,23 @@
+name: "Publish"
+
+on:
+  push:
+    branches:
+      - master
+
+jobs:
+  release:
+    name: Build and publish
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+      - name: Setup node.js
+        uses: actions/setup-node@v1
+        with:
+          node-version: "10.x"
+          registry-url: "https://registry.npmjs.org"
+      - run: yarn install
+      - run: yarn publish
+        env:
+          NODE_AUTH_TOKEN: ${{secrets.NPM_AUTH_TOKEN}}

.github/workflows/test.yml

@@ -0,0 +1,26 @@
+name: "Test"
+
+on:
+  pull_request:
+    branches:
+      - master
+
+jobs:
+  release:
+    name: Build and run test
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: [10.x, 12.x, 14.x]
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+      - name: Setup node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v1
+        with:
+          node-version: ${{ matrix.node-version }}
+          registry-url: "https://registry.npmjs.org"
+      - run: yarn install
+      - run: yarn test
+        env:
+          NODE_ENV: test

.gitignore

@@ -1,4 +1,7 @@
 node_modules
-.nyc_output/
 coverage/
 .DS_Store
+
+.vscode
+
+lib

README.md

@@ -1,58 +1,55 @@
-# fast-json-stable-stringify
+# quick-stable-stringify
 
-Deterministic `JSON.stringify()` - a faster version of [@substack](https://github.com/substack)'s json-stable-strigify without [jsonify](https://github.com/substack/jsonify).
+Deterministic `JSON.stringify()` - a faster version of [@epoberezkin](https://github.com/epoberezkin)'s [fast-json-stable-strigify](https://github.com/epoberezkin/fast-json-stable-stringify). Built with Typescript and modern Javascript.
 
-You can also pass in a custom comparison function.
+## Install
 
-[![Build Status](https://travis-ci.org/epoberezkin/fast-json-stable-stringify.svg?branch=master)](https://travis-ci.org/epoberezkin/fast-json-stable-stringify)
-[![Coverage Status](https://coveralls.io/repos/github/epoberezkin/fast-json-stable-stringify/badge.svg?branch=master)](https://coveralls.io/github/epoberezkin/fast-json-stable-stringify?branch=master)
+With npm do:
 
-# example
-
-``` js
-var stringify = require('fast-json-stable-stringify');
-var obj = { c: 8, b: [{z:6,y:5,x:4},7], a: 3 };
-console.log(stringify(obj));
+```
+npm install quick-stable-stringify
 ```
 
-output:
+Or install with yarn:
 
 ```
-{"a":3,"b":[{"x":4,"y":5,"z":6},7],"c":8}
+yarn add quick-stable-stringify
 ```
 
+## Examples
 
-# methods
-
-``` js
-var stringify = require('fast-json-stable-stringify')
+```js
+var stringify = require("quick-stable-stringify");
+var obj = { c: 8, b: [{ z: 6, y: 5, x: 4 }, 7], a: 3 };
+console.log(stringify(obj));
 ```
 
-## var str = stringify(obj, opts)
-
-Return a deterministic stringified string `str` from the object `obj`.
+output:
 
+```
+{"a":3,"b":[{"x":4,"y":5,"z":6},7],"c":8}
+```
 
-## options
+## Options
 
 ### cmp
 
 If `opts` is given, you can supply an `opts.cmp` to have a custom comparison
 function for object keys. Your function `opts.cmp` is called with these
 parameters:
 
-``` js
-opts.cmp({ key: akey, value: avalue }, { key: bkey, value: bvalue })
+```js
+opts.cmp({ key: akey, value: avalue }, { key: bkey, value: bvalue });
 ```
 
 For example, to sort on the object key names in reverse order you could write:
 
-``` js
-var stringify = require('fast-json-stable-stringify');
+```js
+var stringify = require("quick-stable-stringify");
 
-var obj = { c: 8, b: [{z:6,y:5,x:4},7], a: 3 };
+var obj = { c: 8, b: [{ z: 6, y: 5, x: 4 }, 7], a: 3 };
 var s = stringify(obj, function (a, b) {
-    return a.key < b.key ? 1 : -1;
+  return a.key < b.key ? 1 : -1;
 });
 console.log(s);
 ```
@@ -87,45 +84,25 @@ Pass `true` in `opts.cycles` to stringify circular property as `__cycle__` - the
 
 TypeError will be thrown in case of circular object without this option.
 
-
-# install
-
-With [npm](https://npmjs.org) do:
-
-```
-npm install fast-json-stable-stringify
-```
-
-
 # benchmark
 
 To run benchmark (requires Node.js 6+):
+
 ```
 node benchmark
 ```
 
 Results:
+
 ```
-fast-json-stable-stringify x 17,189 ops/sec ±1.43% (83 runs sampled)
-json-stable-stringify x 13,634 ops/sec ±1.39% (85 runs sampled)
-fast-stable-stringify x 20,212 ops/sec ±1.20% (84 runs sampled)
-faster-stable-stringify x 15,549 ops/sec ±1.12% (84 runs sampled)
-The fastest is fast-stable-stringify
+quick-stable-stringify x 25,499 ops/sec ±1.79% (82 runs sampled)
+fast-json-stable-stringify x 18,566 ops/sec ±0.43% (89 runs sampled)
+json-stable-stringify x 14,453 ops/sec ±0.62% (88 runs sampled)
+fast-stable-stringify x 20,763 ops/sec ±0.58% (88 runs sampled)
+faster-stable-stringify x 18,320 ops/sec ±0.90% (88 runs sampled)
+The fastest is quick-stable-stringify
 ```
 
-
-## Enterprise support
-
-fast-json-stable-stringify package is a part of [Tidelift enterprise subscription](https://tidelift.com/subscription/pkg/npm-fast-json-stable-stringify?utm_source=npm-fast-json-stable-stringify&utm_medium=referral&utm_campaign=enterprise&utm_term=repo) - it provides a centralised commercial support to open-source software users, in addition to the support provided by software maintainers.
-
-
-## Security contact
-
-To report a security vulnerability, please use the
-[Tidelift security contact](https://tidelift.com/security).
-Tidelift will coordinate the fix and disclosure. Please do NOT report security vulnerability via GitHub issues.
-
-
 # license
 
 [MIT](https://github.com/epoberezkin/fast-json-stable-stringify/blob/master/LICENSE)

benchmark/index.js

@@ -1,31 +1,29 @@
-'use strict';
-
-const Benchmark = require('benchmark');
-const suite = new Benchmark.Suite;
-const testData = require('./test.json');
+"use strict";
 
+const Benchmark = require("benchmark");
+const suite = new Benchmark.Suite();
+const testData = require("./test.json");
 
 const stringifyPackages = {
-  // 'JSON.stringify': JSON.stringify,
-  'fast-json-stable-stringify': require('../index'),
-  'json-stable-stringify': true,
-  'fast-stable-stringify': true,
-  'faster-stable-stringify': true
+  "quick-stable-stringify": require("../dist/index"),
+  "fast-json-stable-stringify": true,
+  "json-stable-stringify": true,
+  "fast-stable-stringify": true,
+  "faster-stable-stringify": true,
 };
 
-
 for (const name in stringifyPackages) {
   let func = stringifyPackages[name];
   if (func === true) func = require(name);
 
-  suite.add(name, function() {
+  suite.add(name, function () {
     func(testData);
   });
 }
 
 suite
-  .on('cycle', (event) => console.log(String(event.target)))
-  .on('complete', function () {
-    console.log('The fastest is ' + this.filter('fastest').map('name'));
+  .on("cycle", (event) => console.log(String(event.target)))
+  .on("complete", function () {
+    console.log("The fastest is " + this.filter("fastest").map("name"));
   })
-  .run({async: true});
+  .run({ async: true });

dist/index.d.ts

@@ -0,0 +1,14 @@
+interface KeyValue {
+    key: string;
+    value: any;
+}
+declare type ComparatorFunction = (a: KeyValue, b: KeyValue) => number;
+interface Option {
+    cmp?: ComparatorFunction;
+    cycles?: boolean;
+}
+declare const jsonStringify: {
+    (data: any, opts?: Option | ComparatorFunction | undefined): string | undefined;
+    default: any;
+};
+export = jsonStringify;