update readme

Author: peakchen90

README.ZH-CN.md

@@ -11,8 +11,8 @@
 
 
 ## 特性
-- :v: 使用 [big.js](https://github.com/MikeMcl/big.js) 自动处理 JavaScript 小数精度，并支持大整数
-- :rocket: 执行快、体积小，压缩后只有 17.2 KB, GZIP 后仅 5.9 KB
+- :v: 使用 [bignumber.js](https://github.com/MikeMcl/bignumber.js) 自动处理 JavaScript 小数精度，并支持大整数
+- :rocket: 执行快、体积小，压缩后只有 17.2 KB, GZIP 后仅 5.9 KB (无 bignumber.js 依赖版本压缩后只有 10.5 KB, GZIP 后仅 3.3 KB)
 - :writing_hand: 非常容易扩展自己的自定义运算符
 - :vulcan_salute: 支持表达式变量占位符
 
@@ -29,7 +29,7 @@ yarn add decimal-eval
 ```
 
 ### 使用
-支持基本的四则运算 (`+`, `-`, `*`, `/`), 并默认使用 [big.js](https://github.com/MikeMcl/big.js) 自动处理 JavaScript 小数精度，并支持大整数
+支持基本的四则运算 (`+`, `-`, `*`, `/`), 并默认使用 [bignumber.js](https://github.com/MikeMcl/bignumber.js) 自动处理 JavaScript 小数精度，并支持大整数
 
 ```js
 import {evaluate} from 'decimal-eval';
@@ -105,7 +105,7 @@ evaluate({ def: 1 }); // 抛出错误，字段名 `abc` 未初始化
 安装一个运算符，运算符通过 `Parser.createBinaryOperator()` 或 `Parser.createUnaryOperator()` 方法创建
 
 #### Parser.useAdapter(adapter)
-为四则运算 (`+`, `-`, `*`, `/`) 设置计算方法适配器，默认使用 [big.js](https://github.com/MikeMcl/big.js) 计算
+为四则运算 (`+`, `-`, `*`, `/`) 设置计算方法适配器，默认使用 [bignumber.js](https://github.com/MikeMcl/bignumber.js) 计算
 
 ```js
 Parser.useAdapter({
@@ -120,7 +120,7 @@ Parser.useAdapter({
 ## 进阶
 
 ### 使用 Pure 包 (无依赖)
-当需要使用自定义方法去处理小数精度问题时，你可以使用 Pure 包，可以减少 60% 的体积，这个包不包含 `big.js`
+当需要使用自定义方法去处理小数精度问题时，你可以使用 Pure 包，可以减少 60% 的体积，这个包不包含 `bignumber.js`
 
 ```js
 import {evaluate, Parser} from 'decimal-eval/dist/pure';
@@ -135,12 +135,12 @@ evaluate('0.1 + 0.2'); // '0.30000000000000004'
 evaluate('9007199254740992 + 1'); // '9007199254740992'
 ```
 
-### 导出 `big.js`
-[Big.js](https://github.com/MikeMcl/big.js) 对处理 JavaScript 小数精度问题很有用，而不用重复安装
+### 导出 `bignumber.js`
+[bignumber.js](https://github.com/MikeMcl/bignumber.js) 对处理 JavaScript 小数精度问题很有用，而不用重复安装
 
 ```js
-import {Big} from 'decimal-eval';
-const val = new Big(0.1).plus(0.2);
+import {BigNumber} from 'decimal-eval';
+const val = new BigNumber(0.1).plus(0.2);
 console.log(String(val)); // '0.3'
 ```
 

README.md

@@ -10,8 +10,8 @@ A tiny, safe, fast JavaScript library for decimal arithmetic expressions.
 English | [简体中文](./README.ZH-CN.md)
 
 ## Features
-- :v: Automatically deal with the JavaScript decimal precision problem by [big.js](https://github.com/MikeMcl/big.js), and supports big number
-- :rocket: Fast and tiny, only 17.2 KB minified and 5.9 KB gzipped
+- :v: Automatically deal with the JavaScript decimal precision problem by [bignumber.js](https://github.com/MikeMcl/bignumber.js), and supports big number
+- :rocket: Fast and tiny, only 28.7 KB minified and 11.2 KB gzipped (pure only 10.5 KB minified and 3.3 KB gzipped without bignumber.js)
 - :writing_hand: Easy to extend custom operator
 - :vulcan_salute: Supports expression scope variables
 
@@ -29,7 +29,7 @@ yarn add decimal-eval
 
 ### Usage
 Supports the four arithmetic operations (`+`, `-`, `*`, `/`),
-and automatically deal with JavaScript decimal precision by [big.js](https://github.com/MikeMcl/big.js), and supports big number.
+and automatically deal with JavaScript decimal precision by [bignumber.js](https://github.com/MikeMcl/bignumber.js), and supports big number.
 
 ```js
 import {evaluate} from 'decimal-eval';
@@ -113,7 +113,7 @@ Install an operator which created by the `Parser.createBinaryOperator()` or `Par
 
 #### Parser.useAdapter(adapter)
 Set custom calculation adapter methods for four arithmetic (`+`, `-`, `*`, `/`).
-[Big.js](https://github.com/MikeMcl/big.js) is used by default.
+[bignumber.js](https://github.com/MikeMcl/bignumber.js) is used by default.
 
 ```js
 Parser.useAdapter({
@@ -129,7 +129,7 @@ Parser.useAdapter({
 
 ### Use pure package (no dependencies)
 When using a custom method to deal with the decimal precision problem, you can use a pure package, which can reduce the size by about 60%.
-It doesn't include `big.js`.
+It doesn't include `bignumber.js`.
 
 ```js
 import {evaluate, Parser} from 'decimal-eval/dist/pure';
@@ -144,12 +144,12 @@ evaluate('0.1 + 0.2'); // '0.30000000000000004'
 evaluate('9007199254740992 + 1'); // '9007199254740992'
 ```
 
-### Re-export `big.js`
-Useful for deal JavaScript decimal precision problem without having to install [big.js](https://github.com/MikeMcl/big.js) again.
+### Re-export `bignumber.js`
+Useful for deal JavaScript decimal precision problem without having to install [bignumber.js](https://github.com/MikeMcl/bignumber.js) again.
 
 ```js
-import {Big} from 'decimal-eval';
-const val = new Big(0.1).plus(0.2);
+import {BigNumber} from 'decimal-eval';
+const val = new BigNumber(0.1).plus(0.2);
 console.log(String(val)); // '0.3'
 ```
 

package.json

@@ -11,6 +11,7 @@
     "build": "rollup -c",
     "test": "jest",
     "dts": "node scripts/dts.js",
+    "size": "node scripts/size.js",
     "lint": "eslint {src,test}/**/*.ts --fix"
   },
   "keywords": [
@@ -103,6 +104,7 @@
     "del": "^6.0.0",
     "eslint": "^7.26.0",
     "eslint-config-alloy": "^4.1.0",
+    "gzip-size": "^6.0.0",
     "husky": "^4.3.8",
     "jest": "^26.6.3",
     "lint-staged": "^10.5.4",

scripts/size.js

@@ -0,0 +1,42 @@
+const fs = require('fs');
+const path = require('path');
+const {execSync} = require('child_process');
+const gzipSize = require('gzip-size');
+
+const distRoot = path.join(__dirname, '../dist');
+
+const files = {
+  'index.min.js': {
+    size: null,
+    gzipSize: null,
+  },
+  'pure.min.js': {
+    size: null,
+    gzipSize: null,
+  }
+};
+
+execSync('npm run build', {
+  cwd: path.join(__dirname, '..'),
+  stdio: 'inherit'
+});
+
+Object.keys(files).forEach(name => {
+  const filename = path.join(distRoot, name);
+  files[name] = {
+    size: fs.statSync(filename).size,
+    gzipSize: gzipSize.fileSync(filename)
+  };
+});
+
+function getBundleSize(name, isGZIP = false) {
+  const target = files[name];
+  let size = isGZIP ? target.gzipSize : target.size;
+  return (size / 1024).toFixed(1);
+}
+
+console.log(`
+===================== BUNDLE SIZE =====================
+index       min: ${getBundleSize('index.min.js')} KB        gzip: ${getBundleSize('index.min.js', true)} KB
+pure        min: ${getBundleSize('pure.min.js')} KB        gzip: ${getBundleSize('pure.min.js', true)} KB
+`);

yarn.lock

@@ -2363,6 +2363,11 @@ domexception@^2.0.1:
   dependencies:
     webidl-conversions "^5.0.0"
 
+duplexer@^0.1.2:
+  version "0.1.2"
+  resolved "https://registry.nlark.com/duplexer/download/duplexer-0.1.2.tgz#3abe43aef3835f8ae077d136ddce0f276b0400e6"
+  integrity sha1-Or5DrvODX4rgd9E23c4PJ2sEAOY=
+
 ecc-jsbn@~0.1.1:
   version "0.1.2"
   resolved "https://registry.npm.taobao.org/ecc-jsbn/download/ecc-jsbn-0.1.2.tgz#3a83a904e54353287874c564b7549386849a98c9"
@@ -2945,6 +2950,13 @@ growly@^1.3.0:
   resolved "https://registry.npm.taobao.org/growly/download/growly-1.3.0.tgz#f10748cbe76af964b7c96c93c6bcc28af120c081"
   integrity sha1-8QdIy+dq+WS3yWyTxrzCivEgwIE=
 
+gzip-size@^6.0.0:
+  version "6.0.0"
+  resolved "https://registry.npm.taobao.org/gzip-size/download/gzip-size-6.0.0.tgz#065367fd50c239c0671cbcbad5be3e2eeb10e462"
+  integrity sha1-BlNn/VDCOcBnHLy61b4+LusQ5GI=
+  dependencies:
+    duplexer "^0.1.2"
+
 har-schema@^2.0.0:
   version "2.0.0"
   resolved "https://registry.nlark.com/har-schema/download/har-schema-2.0.0.tgz#a94c2224ebcac04782a0d9035521f24735b7ec92"