Merge pull request #4 from sxwei123/develop

Release v0.1.0

Author: sxwei123

.github/workflows/coverage.yml

@@ -0,0 +1,30 @@
+name: "Coverage"
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - master
+
+jobs:
+  release:
+    name: Run test coverage
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+      - name: Setup node.js
+        uses: actions/setup-node@v1
+        with:
+          node-version: "14.x"
+          registry-url: "https://registry.npmjs.org"
+      - run: yarn install
+      - run: yarn coverage
+        env:
+          NODE_ENV: test
+      - name: Add coverage to comment
+        uses: romeovs/[email protected]
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/test.yml

@@ -1,13 +1,10 @@
-name: "Test"
+name: "Lint and Test"
 
-on:
-  pull_request:
-    branches:
-      - master
+on: pull_request
 
 jobs:
   release:
-    name: Build and run test
+    name: Run lint and test
     runs-on: ubuntu-latest
     strategy:
       matrix:
@@ -21,6 +18,7 @@ jobs:
           node-version: ${{ matrix.node-version }}
           registry-url: "https://registry.npmjs.org"
       - run: yarn install
+      - run: yarn lint
       - run: yarn test
         env:
           NODE_ENV: test

LICENSE

@@ -1,5 +1,6 @@
 This software is released under the MIT license:
 
+Copyright (c) 2021 Leon Song
 Copyright (c) 2017 Evgeny Poberezkin
 Copyright (c) 2013 James Halliday
 

README.md

@@ -1,7 +1,15 @@
 # quick-stable-stringify
 
+![Test status](https://github.com/sxwei123/quick-stable-stringify/workflows/Coverage/badge.svg?branch=master)
+
 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.
 
+## Features
+
+- Support both browser and nodejs
+- Support custom comparator function
+- No dependencies
+
 ## Install
 
 With npm do:

jestconfig.json

@@ -1,7 +1,8 @@
 {
   "transform": {
-    "^.+\\.(t|j)sx?$": "ts-jest"
+    "^.+\\.ts$": "ts-jest"
   },
   "testRegex": "(/test/.*|(\\.|/)(test|spec))\\.(jsx?|tsx?)$",
-  "moduleFileExtensions": ["ts", "tsx", "js", "jsx", "json", "node"]
+  "moduleFileExtensions": ["ts", "tsx", "js", "jsx", "json", "node"],
+  "coverageReporters": ["text-summary", "lcov", "json-summary"]
 }

package.json

@@ -1,6 +1,6 @@
 {
   "name": "quick-stable-stringify",
-  "version": "0.0.3",
+  "version": "0.1.0",
   "description": "Deterministic `JSON.stringify()` - a faster version of Evgeny's fast-json-stable-strigify. Built with Typescript and modern Javascript.",
   "main": "./dist/index.js",
   "exports": "./dist/index.js",
@@ -33,7 +33,8 @@
     "build": "tsc",
     "prepublish": "tsc",
     "lint": "eslint . --ext .ts",
-    "test": "jest --config jestconfig.json"
+    "test": "jest --config jestconfig.json",
+    "coverage": "jest --config jestconfig.json --coverage"
   },
   "repository": {
     "type": "git",