refactor(benchmark): use eslint over tslint

.circleci/config.yml

@@ -16,7 +16,6 @@ aliases:
   # https://github.com/cypress-io/cypress-docker-images/tree/master/included
   - &use_docker_cypress_included
     docker:
-      # 3.8.0 fails with `Error: write EPIPE` when running `benchmark`!?
       - image: cypress/included:3.8.2
 
   - &workspace ~/talus

.eslintrc

@@ -18,7 +18,10 @@
     "@typescript-eslint/explicit-member-accessibility": "off",
     "@typescript-eslint/no-inferrable-types": "off",
     "@typescript-eslint/no-parameter-properties": "off",
-    "@typescript-eslint/no-unused-vars": ["error", { "argsIgnorePattern": "^_" }],
+    "@typescript-eslint/no-unused-vars": [
+      "error",
+      { "argsIgnorePattern": "^_", "varsIgnorePattern": "^_" }
+    ],
     "@typescript-eslint/no-use-before-define": "off",
     "@nrwl/nx/enforce-module-boundaries": [
       "error",

README.md

@@ -45,7 +45,9 @@ This project was generated using [Nx](https://nx.dev) with the following command
 
 8. `ng generate @nrwl/angular:component sidenav-shell --project=ui --module=sidenav-shell --export`
 
-9. `ng generate @nrwl/workspace:library model --linter=eslint`
+9. `nx g @nrwl/node:application benchmark --linter=eslint`
+
+10. `ng generate @nrwl/workspace:library model --linter=eslint`
 
 ## Installations
 

angular.json

@@ -209,8 +209,10 @@
           }
         },
         "lint": {
-          "builder": "@angular-devkit/build-angular:tslint",
+          "builder": "@nrwl/linter:lint",
           "options": {
+            "linter": "eslint",
+            "config": "apps/benchmark/.eslintrc",
             "tsConfig": ["apps/benchmark/tsconfig.app.json"],
             "exclude": ["**/node_modules/**", "!apps/benchmark/**"]
           }

apps/benchmark/.eslintrc

@@ -0,0 +1 @@
+{ "extends": "../../.eslintrc", "rules": {} }

apps/benchmark/benchmark.config.ts

@@ -1,5 +1,5 @@
-module.exports = {
+export default {
   suiteName: 'Benchmark.js tests',
   outputDirectory: './test-results/benchmark',
-  outputName: 'all.junit.xml',
+  outputName: 'apps-benchmark.junit.xml',
 };

apps/benchmark/src/app/vdb/coord.benchmark.ts

@@ -25,32 +25,32 @@ suite('[Coord] write', () => {
 suite('[Coord] read', () => {
   const coord: Coord = [0, 0, 0];
   benchmark('coord[0]', () => {
-    const x = coord[0];
-    const y = coord[1];
-    const z = coord[2];
+    const _x = coord[0];
+    const _y = coord[1];
+    const _z = coord[2];
   });
 
   benchmark('coord[X]', () => {
-    const x = coord[X];
-    const y = coord[Y];
-    const z = coord[Z];
+    const _x = coord[X];
+    const _y = coord[Y];
+    const _z = coord[Z];
   });
 
   const coordObj = { x: 0, y: 0, z: 0 };
   benchmark('coordObj.x', () => {
-    const x = coordObj.x;
-    const y = coordObj.y;
-    const z = coordObj.z;
+    const _x = coordObj.x;
+    const _y = coordObj.y;
+    const _z = coordObj.z;
   });
 });
 
 suite('[Coord] function parameter', () => {
   const coord: Coord = [0, 1, 2];
 
   function oneParameter(xyz: Coord): void {
-    const x = xyz[0];
-    const y = xyz[1];
-    const z = xyz[2];
+    const _x = xyz[0];
+    const _y = xyz[1];
+    const _z = xyz[2];
   }
 
   function deconstruct([x, y, z]: Coord): void {

apps/benchmark/src/main.ts

@@ -2,7 +2,7 @@ import * as Benchmark from 'benchmark';
 import * as fs from 'fs';
 import { getJunitXml, TestSuite, TestSuiteReport } from 'junit-xml';
 
-const config = require('../benchmark.config');
+import config from '../benchmark.config';
 
 const suites: Benchmark.Suite[] = [];
 const report: TestSuiteReport = {
@@ -36,7 +36,7 @@ export function benchmark(name: string, fn: () => void): void {
   suites[suites.length - 1].add(name, fn);
 }
 
-function logSummary(suiteToLog: any): void {
+function logSummary(suiteToLog: Benchmark.Suite): void {
   logFastestBenchmarkNames(suiteToLog);
 
   const benchmarks = Array.from({ length: suiteToLog.length }, (x, i) => suiteToLog[i]);
@@ -48,11 +48,11 @@ function logSummary(suiteToLog: any): void {
   });
 }
 
-function logFastestBenchmarkNames(suiteToLog: any): void {
+function logFastestBenchmarkNames(suiteToLog: Benchmark.Suite): void {
   const fastestBenchmarkNames = suiteToLog.filter('fastest').map(bm => bm.name);
   const conjugatedVerbBe = fastestBenchmarkNames.length > 1 ? 'are' : 'is';
 
-  console.log(`\n${suiteToLog.name}`);
+  console.log(`\n${suiteToLog['name']}`);
   console.log(`  Fastest ${conjugatedVerbBe} "${fastestBenchmarkNames.join(', ')}"`);
 }
 
@@ -63,7 +63,7 @@ function logBenchmarkBar(highestHz: number, bm: Benchmark): void {
   const filledBarLength = barPercentage / charsPerOnePercentage;
   const emptyBarLength = (100 - barPercentage) / charsPerOnePercentage;
 
-  const createBar = (length, char) => Array.from({ length }, () => char).join('');
+  const createBar = (length, char): string => Array.from({ length }, () => char).join('');
   const filledBar = `${createBar(Math.floor(filledBarLength), '-')}`;
   const emptyBar = createBar(Math.ceil(emptyBarLength), ' ');
 
@@ -97,17 +97,21 @@ function everySuiteFinished(): boolean {
 
 function writeReportToFile(): void {
   const folderPath = `${process.cwd()}/${config.outputDirectory}`;
+  const filePath = `${config.outputDirectory}/${config.outputName}`;
+
   fs.promises
     .mkdir(folderPath, { recursive: true })
-    .then(() => fs.promises.writeFile(`${folderPath}/${config.outputName}`, getJunitXml(report)))
-    .then(() => console.log('\nJUnit report saved!'))
+    .then(() => fs.promises.writeFile(filePath, getJunitXml(report)))
+    .then(() => console.log(`\nJUnit report saved:\n ${filePath}`))
     .catch((err: NodeJS.ErrnoException) => {
       console.log(err);
       process.exit(err.errno);
     });
 }
 
+// eslint-disable-next-line  @typescript-eslint/no-explicit-any
 declare const require: any;
+
 (function runAllBenchmarks(): void {
   // find all benchmark files
   const context = require.context('./', true, /\.benchmark\.ts$/);