From 1fe22d1614f77040d355c9bdf6eee59fa4b0c985 Mon Sep 17 00:00:00 2001 From: =?utf8?q?J=C3=A9r=C3=B4me=20Benoit?= Date: Mon, 10 May 2021 11:55:15 +0200 Subject: [PATCH] Consolidate benchmarks documentation (#350) --- benchmarks/README.md | 7 +------ .../versus-external-pools/BENCH-100000.md | 2 +- benchmarks/versus-external-pools/README.md | 6 ++++-- package-lock.json | 20 +++++++++---------- package.json | 4 ++-- 5 files changed, 18 insertions(+), 21 deletions(-) diff --git a/benchmarks/README.md b/benchmarks/README.md index 66b7abb2..92357060 100644 --- a/benchmarks/README.md +++ b/benchmarks/README.md @@ -35,9 +35,4 @@ To run the internal benchmark you just need to navigate to the root of poolifier ## Versus other pools -To run the benchmark versus other pools you will need to: - -- [Install hyperfine](https://github.com/sharkdp/hyperfine#installation) -- Run the `./bench.sh` into the `versus-external-pools` folder - -> :warning: **Please be sure to use a quite PC when you run the benchmarks** +Read [README.md](./versus-external-pools/README.md) diff --git a/benchmarks/versus-external-pools/BENCH-100000.md b/benchmarks/versus-external-pools/BENCH-100000.md index 5fed6586..0bb2f472 100644 --- a/benchmarks/versus-external-pools/BENCH-100000.md +++ b/benchmarks/versus-external-pools/BENCH-100000.md @@ -1,5 +1,5 @@ | Command | Mean [s] | Min [s] | Max [s] | Relative | -|:-----------------------------------------------------|---------------:|--------:|--------:|------------:| +| :--------------------------------------------------- | -------------: | ------: | ------: | ----------: | | `node dynamic-piscina.js` | 18.364 ± 0.203 | 18.050 | 18.737 | 1.07 ± 0.02 | | `node fixed-piscina.js` | 18.222 ± 0.519 | 17.529 | 19.164 | 1.06 ± 0.03 | | `node dynamic-poolifier.js` | 17.135 ± 0.256 | 16.926 | 17.755 | 1.00 | diff --git a/benchmarks/versus-external-pools/README.md b/benchmarks/versus-external-pools/README.md index 02ba1a67..faecde87 100644 --- a/benchmarks/versus-external-pools/README.md +++ b/benchmarks/versus-external-pools/README.md @@ -1,7 +1,9 @@ -# Poolifier Benchmarks +# Poolifier benchmarks versus other pools To run the benchmark versus other pools you will need to: - [Install hyperfine](https://github.com/sharkdp/hyperfine#installation) -- Run `npm install` +- Run `npm install` into the `versus-external-pools` folder - Run the `./bench.sh` into the `versus-external-pools` folder + +> :warning: **Please be sure to use a quite PC when you run the benchmarks** diff --git a/package-lock.json b/package-lock.json index 7b24e472..eb3f87c9 100644 --- a/package-lock.json +++ b/package-lock.json @@ -352,9 +352,9 @@ } }, "@es-joy/jsdoccomment": { - "version": "0.4.3", - "resolved": "https://registry.npmjs.org/@es-joy/jsdoccomment/-/jsdoccomment-0.4.3.tgz", - "integrity": "sha512-t0JWZfQiG+Qkr6+tl05dlGcgE/MMPqs7QfNlFkTsbpcCu2Zfukcan/fIiHKTc0iOs4Yh3cnfklMayJnlmKaOwQ==", + "version": "0.4.4", + "resolved": "https://registry.npmjs.org/@es-joy/jsdoccomment/-/jsdoccomment-0.4.4.tgz", + "integrity": "sha512-ua4qDt9dQb4qt5OI38eCZcQZYE5Bq3P0GzgvDARdT8Lt0mAUpxKTPy8JGGqEvF77tG1irKDZ3WreeezEa3P43w==", "dev": true, "requires": { "comment-parser": "^1.1.5", @@ -1703,12 +1703,12 @@ } }, "eslint-plugin-jsdoc": { - "version": "33.1.0", - "resolved": "https://registry.npmjs.org/eslint-plugin-jsdoc/-/eslint-plugin-jsdoc-33.1.0.tgz", - "integrity": "sha512-nyH1qAj5f4uDnDpg4aiAS65wJSfxfBDf0lIgNfxtew31z3VRaM8WsVmpe4UhI2u27oOD/ChRuye6KAzzuHn6Jw==", + "version": "33.1.1", + "resolved": "https://registry.npmjs.org/eslint-plugin-jsdoc/-/eslint-plugin-jsdoc-33.1.1.tgz", + "integrity": "sha512-6Avc2czg/mh0zmuU3H4v2xTXOALl9OiMGpn55nBDydhU684cVgvn2VtXm1JgH+2TW5SxEDnX3o/FUgda7LgVYA==", "dev": true, "requires": { - "@es-joy/jsdoccomment": "^0.4.3", + "@es-joy/jsdoccomment": "^0.4.4", "comment-parser": "1.1.5", "debug": "^4.3.1", "esquery": "^1.4.0", @@ -4044,9 +4044,9 @@ "dev": true }, "prettier": { - "version": "2.2.1", - "resolved": "https://registry.npmjs.org/prettier/-/prettier-2.2.1.tgz", - "integrity": "sha512-PqyhM2yCjg/oKkFPtTGUojv7gnZAoG80ttl45O6x2Ug/rMJw4wcc9k6aaf2hibP7BGVCCM33gZoGjyvt9mm16Q==", + "version": "2.3.0", + "resolved": "https://registry.npmjs.org/prettier/-/prettier-2.3.0.tgz", + "integrity": "sha512-kXtO4s0Lz/DW/IJ9QdWhAf7/NmPWQXkFr/r/WkR3vyI+0v8amTDxiaQSLzs8NBlytfLWX/7uQUMIW677yLKl4w==", "dev": true }, "prettier-linter-helpers": { diff --git a/package.json b/package.json index b2d6f9ff..35e30ecd 100644 --- a/package.json +++ b/package.json @@ -71,7 +71,7 @@ "eslint-config-standard": "^16.0.2", "eslint-define-config": "^1.0.8", "eslint-plugin-import": "^2.22.1", - "eslint-plugin-jsdoc": "^33.1.0", + "eslint-plugin-jsdoc": "^33.1.1", "eslint-plugin-node": "^11.1.0", "eslint-plugin-prettierx": "^0.17.1", "eslint-plugin-promise": "^5.1.0", @@ -80,7 +80,7 @@ "microtime": "^3.0.0", "mocha": "^8.4.0", "nyc": "^15.1.0", - "prettier": "^2.2.1", + "prettier": "^2.3.0", "prettier-plugin-organize-imports": "^2.0.0", "prettierx": "^0.18.0", "rollup": "^2.47.0", -- 2.34.1