Use Async Pool and Node 14's ESM Support (#81)

* Add merged type defintions for index.d.ts
* Use Async Helper, doesn't work cause of Node ESM problems
* Uses new depdency
* Use ESM
* Move to Node 14
* Upgrade to latest async helper, ensure Node >= 12 is used
* Introduce formatting via github action, remove post commit and pre push hooks
* Forgot to add content to format.yml
* Upgrade to typescript-esm 0.0.6
* Add missing format script
* Pushed Changes from Github Actions Bot
* Run unit tests on Node 14 only

Author: kristoferbaxter

.github/workflows/format.yml

@@ -0,0 +1,23 @@
+name: Format
+on: pull_request
+jobs:
+  format:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: [12.x]
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v2
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v1
+      with:
+        node-version: ${{ matrix.node-version }}
+    - name: Format
+      run: yarn install; yarn format
+    - name: Push changes
+      uses: kristoferbaxter/github-push-action@master
+      with:
+        force: true
+        github_token: ${{ secrets.GITHUB_TOKEN }}
+        branch: ${{ github.head_ref }}

.github/workflows/unit-test.yml

@@ -7,12 +7,11 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node-version: [12.x]
+        node-version: [14.x]
     steps:
     - uses: actions/checkout@v1
     - name: Use Node.js ${{ matrix.node-version }}
       uses: actions/setup-node@v1
       with:
         node-version: ${{ matrix.node-version }}
-    - run: yarn install
-    - run: yarn test
+    - run: yarn install; yarn test

package.json

@@ -9,6 +9,9 @@
   "files": [
     "dist"
   ],
+  "engines": {
+    "node": ">=12"
+  },
   "bin": {
     "filesize": "./dist/filesize"
   },
@@ -17,16 +20,19 @@
     "url": "https://github.com/ampproject/filesize.git"
   },
   "scripts": {
+    "clean": "rimraf dist output test/output",
+    "format": "prettier --write '**/*.ts'",
     "build-tests": "tsc -p test/tsconfig.json",
+    "postbuild-tests": "tsc-esm -p test/output",
     "pretest": "yarn npm-run-all build build-tests",
     "test": "ava -v --timeout=2m",
-    "clean": "rimraf dist output test/output",
-    "build": "rollup -c; shx chmod a+x dist/filesize",
+    "build": "rollup -c; chmod a+x dist/filesize",
     "try": "./dist/filesize",
     "release": "np --no-2fa",
     "prepublishOnly": "yarn npm-run-all clean build"
   },
   "dependencies": {
+    "@kristoferbaxter/async": "0.0.7",
     "bytes": "3.1.0",
     "fast-glob": "3.2.2",
     "kleur": "3.0.3",
@@ -41,19 +47,17 @@
     "@types/mri": "1.1.0",
     "@types/node": "12.12.36",
     "ava": "3.7.1",
-    "husky": "4.2.5",
-    "lint-staged": "10.1.6",
     "np": "https://github.com/pixelastic/np/tarball/c3ab2e3b053c7da0ce40a572ca1616273ac080f8",
     "npm-run-all": "4.1.5",
     "prettier": "2.0.4",
     "rimraf": "3.0.2",
     "rollup": "2.6.1",
-    "shx": "0.3.2",
     "tslib": "1.11.1",
-    "typescript": "3.8.3"
+    "typescript": "3.8.3",
+    "typescript-esm": "0.0.6"
   },
   "volta": {
-    "node": "12.16.2",
+    "node": "14.0.0",
     "yarn": "1.22.4"
   },
   "filesize": {
@@ -76,20 +80,9 @@
   },
   "ava": {
     "files": [
-      "test/output/**/*.test.js"
+      "test/output/**/*.test.mjs"
     ]
   },
-  "lint-staged": {
-    "*.ts": [
-      "prettier --write"
-    ]
-  },
-  "husky": {
-    "hooks": {
-      "pre-push": "yarn npm-run-all clean test",
-      "pre-commit": "lint-staged"
-    }
-  },
   "publishConfig": {
     "access": "public"
   },

src/compress.ts

@@ -14,13 +14,11 @@
  * limitations under the License.
  */
 
-import { cpus } from 'os';
 import { Context, Compression, OrderedCompressionValues, maxSize } from './validation/Condition';
 import { readFile } from './helpers/fs';
 import { Report } from './log/report';
 import { compressor } from './compressor';
-
-const COMPRESSION_CONCURRENCY = cpus().length;
+import { pool } from '@kristoferbaxter/async';
 
 export interface CompressionItem {
   path: string;
@@ -84,31 +82,8 @@ export default async function compress(
     return true;
   }
 
-  const returnable: Array<Promise<boolean>> = [];
-  const executing: Array<Promise<boolean>> = [];
   const reportInstance: Report | null = report ? new report(context) : null;
-  let success = true;
-  for (const item of toCompress) {
-    const promise: Promise<boolean> = Promise.resolve(item).then((item) => compressor(context, reportInstance, item));
-    returnable.push(promise);
-
-    if (COMPRESSION_CONCURRENCY <= toCompress.length) {
-      const execute: any = promise.then((successful) => {
-        if (!successful) {
-          success = successful;
-        }
-        executing.splice(executing.indexOf(execute), 1);
-      });
-      executing.push(execute);
-      if (executing.length >= COMPRESSION_CONCURRENCY) {
-        await Promise.race(executing);
-      }
-    }
-  }
-  if ((await Promise.all(returnable)).includes(false)) {
-    success = false;
-  }
-
+  const successful = await pool(toCompress, (item: CompressionItem) => compressor(context, reportInstance, item));
   reportInstance?.end();
-  return success;
+  return successful.every((success) => success);
 }

src/log/helpers/error.ts

@@ -15,7 +15,7 @@
  */
 
 import { write } from './output';
-const kleur = require('kleur');
+import kleur from 'kleur';
 
 // Disable output colors for test runs.
 kleur.enabled = !('AVA_PATH' in process.env);

src/log/helpers/format.ts

@@ -17,7 +17,7 @@
 import { OrderedCompressionValues, Context } from '../../validation/Condition';
 import { prettyBytes } from './bytes';
 
-const COMPRESSED_NAMES_LENGTH = OrderedCompressionValues.map(compression => compression.length);
+const COMPRESSED_NAMES_LENGTH = OrderedCompressionValues.map((compression) => compression.length);
 const SPACE_AFTER_COMPRESSION = 2;
 
 /**
@@ -47,5 +47,5 @@ export function maxFormatDisplay(context: Context): number {
  * @param maxFormatDisplay
  */
 export function formats(maxFormatDisplay: number): string {
-  return OrderedCompressionValues.map(compression => compression.padEnd(maxFormatDisplay)).join('');
+  return OrderedCompressionValues.map((compression) => compression.padEnd(maxFormatDisplay)).join('');
 }

src/validation/File.ts

@@ -17,7 +17,7 @@
 import { Compression, Context, SizeMapValue, SizeMapValueIndex } from './Condition';
 import { resolve, isAbsolute } from 'path';
 import { isFile } from '../helpers/fs';
-const bytes = require('bytes');
+import bytes from 'bytes';
 
 /**
  * Format input string to a known Compression Enum Value.

src/validation/Project.ts

@@ -24,7 +24,7 @@ import { MakeError } from '../log/helpers/error';
  * @param context
  */
 const Project: ConditionFunction = (context: Context) => {
-  return async function() {
+  return async function () {
     const projectPath: string = resolve(context.projectPath);
     if (!(await isDirectory(projectPath))) {
       return MakeError(`project specified '${context.projectPath}' doesn't exist, is this a valid project?`);

test/config-validation/config-validation.test.ts

@@ -18,7 +18,7 @@ import test from 'ava';
 import Config from '../../src/validation/Config';
 import { Context } from '../../src/validation/Condition';
 
-test('missing package.json should fail', async t => {
+test('missing package.json should fail', async (t) => {
   const context: Context = {
     packagePath: 'test/config-validation/fixtures/missing-package-json/package.json',
     projectPath: 'test/config-validation/fixtures/missing-package-json',
@@ -35,7 +35,7 @@ test('missing package.json should fail', async t => {
   t.is(message, `Could not read the configuration in '${context.packagePath}'`);
 });
 
-test('unparseable package.json should fail', async t => {
+test('unparseable package.json should fail', async (t) => {
   const context: Context = {
     packagePath: 'test/config-validation/fixtures/unparseable-package-json/package.json',
     projectPath: 'test/config-validation/fixtures/unparseable-package-json',
@@ -52,7 +52,7 @@ test('unparseable package.json should fail', async t => {
   t.is(message, `Could not parse '${context.packagePath}'`);
 });
 
-test("missing 'filesize' key from package.json should fail", async t => {
+test("missing 'filesize' key from package.json should fail", async (t) => {
   const context: Context = {
     packagePath: 'test/config-validation/fixtures/missing-configuration/package.json',
     projectPath: 'test/config-validation/fixtures/missing-configuration',
@@ -69,7 +69,7 @@ test("missing 'filesize' key from package.json should fail", async t => {
   t.is(message, `There is no 'filesize' configuration in '${context.packagePath}'`);
 });
 
-test("missing path from item in 'filesize' should fail", async t => {
+test("missing path from item in 'filesize' should fail", async (t) => {
   const context: Context = {
     packagePath: 'test/config-validation/fixtures/item-path-missing/package.json',
     projectPath: 'test/config-validation/fixtures/item-path-missing',
@@ -86,7 +86,7 @@ test("missing path from item in 'filesize' should fail", async t => {
   t.is(message, `There is no data inside the 'filesize' configuration in '${context.packagePath}'`);
 });
 
-test("missing maxSize from item in 'filesize' should fail", async t => {
+test("missing maxSize from item in 'filesize' should fail", async (t) => {
   const context: Context = {
     packagePath: 'test/config-validation/fixtures/max-size-missing/package.json',
     projectPath: 'test/config-validation/fixtures/max-size-missing',
@@ -103,7 +103,7 @@ test("missing maxSize from item in 'filesize' should fail", async t => {
   t.is(message, `Configuration for 'index.js' is invalid. (size unspecified)`);
 });
 
-test("missing compression from item in 'filesize' should fail", async t => {
+test("missing compression from item in 'filesize' should fail", async (t) => {
   const context: Context = {
     packagePath: 'test/config-validation/fixtures/compression-missing/package.json',
     projectPath: 'test/config-validation/fixtures/compression-missing',

test/project-validation/project-validation.test.ts

@@ -19,7 +19,7 @@ import Project from '../../src/validation/Project';
 import { resolve } from 'path';
 import { Context } from '../../src/validation/Condition';
 
-test('valid directory should pass', async t => {
+test('valid directory should pass', async (t) => {
   const context: Context = {
     packagePath: '',
     projectPath: 'test/project-validation/fixtures/contains-package-json',
@@ -36,7 +36,7 @@ test('valid directory should pass', async t => {
   t.is(message, null);
 });
 
-test('invalid directory should fail', async t => {
+test('invalid directory should fail', async (t) => {
   const context = {
     packagePath: '',
     projectPath: 'test/project-validation/fixtures-invalid',
@@ -53,7 +53,7 @@ test('invalid directory should fail', async t => {
   t.is(message, `error project specified '${context.projectPath}' doesn't exist, is this a valid project?`);
 });
 
-test('directory missing package.json should fail', async t => {
+test('directory missing package.json should fail', async (t) => {
   const context = {
     packagePath: '',
     projectPath: 'test/project-validation/fixtures/missing-package-json',