Skip to content

Commit b7a96df

Browse files
nazarhussainnazarhussain
committed
Fix the lint rules
1 parent 27de0a6 commit b7a96df

40 files changed

+177
-171
lines changed

‎biome.jsonc

+12
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,18 @@
2525
}
2626
},
2727
"overrides": [
28+
// TODO: Due to enum change disabling this for now
29+
// Will bring it back as we update the base config
30+
{
31+
"include": ["*"],
32+
"linter": {
33+
"rules": {
34+
"style": {
35+
"useNamingConvention": "off"
36+
}
37+
}
38+
}
39+
},
2840
{
2941
"include": ["src/utils/gaContext.ts", "src/github/octokit.ts"],
3042
"linter": {

‎src/benchmark/benchmarkFn.ts

+2-3
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@ import fs from "node:fs";
22
import path from "node:path";
33
import {getCurrentSuite, setFn} from "@vitest/runner";
44
import {createChainable} from "@vitest/runner/utils";
5-
import {store} from "./globalState.js";
65
import {BenchApi, BenchmarkOpts, BenchmarkRunOptsWithFn, PartialBy} from "../types.js";
7-
import {runBenchFn} from "./runBenchmarkFn.js";
6+
import {store} from "./globalState.js";
87
import {getBenchmarkOptionsWithDefaults} from "./options.js";
8+
import {runBenchFn} from "./runBenchmarkFn.js";
99

1010
export const bench: BenchApi = createBenchmarkFunction(function <T, T2>(
1111
this: Record<"skip" | "only", boolean | undefined>,
@@ -64,7 +64,6 @@ export const bench: BenchApi = createBenchmarkFunction(function <T, T2>(
6464
const cleanup = (): void => {
6565
store.removeOptions(task);
6666
// Clear up the assigned handler to clean the memory
67-
// eslint-disable-next-line @typescript-eslint/ban-ts-comment
6867
// @ts-expect-error
6968
setFn(task, null);
7069
};

‎src/benchmark/convergence/coefficientOfVariance.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
import Debug from "debug";
22
import {BenchmarkOpts, ConvergenceCheckFn} from "../../types.js";
33
import {
4+
OutlierSensitivityEnum,
45
calcMean,
56
calcMedian,
67
calcVariance,
78
filterOutliers,
8-
OutlierSensitivityEnum,
99
sortData,
1010
} from "../../utils/math.js";
1111

@@ -20,7 +20,7 @@ export function createCVConvergenceCriteria(
2020
const minSamples = Math.max(5, minRuns);
2121
const maxSamplesForCV = 1000;
2222

23-
return function canTerminate(runIdx: number, totalNs: bigint, runsNs: bigint[]): boolean {
23+
return function canTerminate(runIdx: number, _totalNs: bigint, runsNs: bigint[]): boolean {
2424
const currentMs = Date.now();
2525
const elapsedMs = currentMs - startMs;
2626
const timeSinceLastCheck = currentMs - lastConvergenceSample;

‎src/benchmark/convergence/linearAverage.ts

-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,6 @@ export function createLinearConvergenceCriteria(
1212
let lastConvergenceSample = startMs;
1313
const sampleEveryMs = 100;
1414

15-
// eslint-disable-next-line @typescript-eslint/no-unused-vars
1615
return function canTerminate(runIdx: number, totalNs: bigint, _runNs: bigint[]): boolean {
1716
const currentMs = Date.now();
1817
const elapsedMs = currentMs - startMs;

‎src/benchmark/format.ts

+4-3
Original file line numberDiff line numberDiff line change
@@ -44,11 +44,12 @@ function getRatioRow(result: BenchmarkResult, prevResult: BenchmarkResult | null
4444

4545
if (ratio > threshold) {
4646
return `\u001b[91m${str}\u001b[0m`; // red
47-
} else if (ratio < 1 / threshold) {
47+
}
48+
49+
if (ratio < 1 / threshold) {
4850
return `\u001b[92m${str}\u001b[0m`; // green
49-
} else {
50-
return str;
5151
}
52+
return str;
5253
}
5354

5455
function prettyTime(nanoSec: number): [number, string] {

‎src/benchmark/globalState.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
import Debug from "debug";
21
import type {Suite, SuiteCollector, Task} from "@vitest/runner";
3-
import {BenchmarkResult, BenchmarkOpts, BenchmarkResults} from "../types.js";
2+
import Debug from "debug";
3+
import {BenchmarkOpts, BenchmarkResult, BenchmarkResults} from "../types.js";
44

55
const debug = Debug("@chainsafe/benchmark/state");
66

‎src/benchmark/options.ts

+3-3
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@ import {AverageCalculationEnum, BenchmarkOpts, ConvergenceEnum} from "../types.j
22

33
export const defaultBenchmarkOptions: Required<BenchmarkOpts> = {
44
minRuns: 1,
5-
maxRuns: Infinity,
5+
maxRuns: Number.POSITIVE_INFINITY,
66
minMs: 100,
7-
maxMs: Infinity,
7+
maxMs: Number.POSITIVE_INFINITY,
88
maxWarmUpRuns: 1000,
99
maxWarmUpMs: 500,
1010
convergeFactor: 0.5 / 100, // 0.5%
@@ -25,7 +25,7 @@ export function getBenchmarkOptionsWithDefaults(opts: BenchmarkOpts): Required<B
2525
const options = Object.assign({}, defaultBenchmarkOptions, opts);
2626

2727
if (options.noThreshold) {
28-
options.threshold = Infinity;
28+
options.threshold = Number.POSITIVE_INFINITY;
2929
}
3030

3131
if (options.maxMs && options.maxMs > options.timeoutBench) {

‎src/benchmark/reporter.ts

+3-5
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
import {Task, Suite, File} from "@vitest/runner";
2-
import {color, consoleLog, symbols} from "../utils/output.js";
3-
import {store} from "./globalState.js";
1+
import {File, Suite, Task} from "@vitest/runner";
42
import {Benchmark, BenchmarkOpts, BenchmarkResult} from "../types.js";
3+
import {color, consoleLog, symbols} from "../utils/output.js";
54
import {formatResultRow} from "./format.js";
5+
import {store} from "./globalState.js";
66
import {defaultBenchmarkOptions} from "./options.js";
77

88
export class BenchmarkReporter {
@@ -129,7 +129,6 @@ export class BenchmarkReporter {
129129
}
130130
}
131131

132-
// eslint-disable-next-line @typescript-eslint/no-unused-vars
133132
onSuiteFinished(_suite: Suite): void {
134133
--this.indents;
135134

@@ -138,7 +137,6 @@ export class BenchmarkReporter {
138137
}
139138
}
140139

141-
// eslint-disable-next-line @typescript-eslint/no-unused-vars
142140
onComplete(_files: File[]): void {
143141
consoleLog();
144142
this.indents += 2;

‎src/benchmark/runBenchmarkFn.ts

+9-9
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
import Debug from "debug";
2-
import {BenchmarkResult, BenchmarkOpts, Convergence, ConvergenceCheckFn, ConvergenceEnum} from "../types.js";
3-
import {calcSum, filterOutliers, OutlierSensitivityEnum} from "../utils/math.js";
4-
import {getBenchmarkOptionsWithDefaults} from "./options.js";
5-
import {createLinearConvergenceCriteria} from "./convergence/linearAverage.js";
2+
import {BenchmarkOpts, BenchmarkResult, Convergence, ConvergenceCheckFn, ConvergenceEnum} from "../types.js";
3+
import {OutlierSensitivityEnum, calcSum, filterOutliers} from "../utils/math.js";
64
import {createCVConvergenceCriteria} from "./convergence/coefficientOfVariance.js";
5+
import {createLinearConvergenceCriteria} from "./convergence/linearAverage.js";
6+
import {getBenchmarkOptionsWithDefaults} from "./options.js";
77

88
const debug = Debug("@chainsafe/benchmark/run");
99

@@ -121,14 +121,14 @@ Consider adjusting 'maxWarmUpMs' or 'maxWarmUpRuns' options orextend 'maxMs'
121121
if your function is very slow.
122122
`.trim()
123123
);
124-
} else {
125-
throw Error(
126-
`
124+
}
125+
126+
throw Error(
127+
`
127128
No run was completed before 'maxMs' ${maxMs}. Consider extending the 'maxMs' time if
128129
either the before(), beforeEach() or fn() functions are too slow.
129130
`.trim()
130-
);
131-
}
131+
);
132132
}
133133

134134
let averageNs!: number;

‎src/benchmark/runner.ts

+7-8
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
1+
import path from "node:path";
12
import {
23
File,
3-
startTests,
44
Suite,
55
Task,
66
VitestRunner,
77
VitestRunnerConfig,
88
VitestRunnerImportSource,
9+
startTests,
910
} from "@vitest/runner";
10-
import path from "node:path";
1111
import Debug from "debug";
1212
import {Benchmark, BenchmarkOpts, BenchmarkResults} from "../types.js";
13-
import {BenchmarkReporter} from "./reporter.js";
1413
import {store} from "./globalState.js";
14+
import {BenchmarkReporter} from "./reporter.js";
1515

1616
const debug = Debug("@chainsafe/benchmark/runner");
1717

@@ -63,8 +63,7 @@ export class BenchmarkRunner implements VitestRunner {
6363
}
6464
}
6565

66-
// eslint-disable-next-line @typescript-eslint/no-unused-vars
67-
async onAfterRunTask(task: Task): Promise<void> {
66+
async onAfterRunTask(_task: Task): Promise<void> {
6867
// To help maintain consistent memory usage patterns
6968
// we trigger garbage collection manually
7069
if (this.triggerGC && global.gc) {
@@ -93,9 +92,9 @@ export class BenchmarkRunner implements VitestRunner {
9392
debug("starting tests %O", files);
9493
const res = await startTests(files, this);
9594

96-
const passed = res.filter((r) => r.result?.state == "pass");
97-
const skipped = res.filter((r) => r.result?.state == "skip");
98-
const failed = res.filter((r) => r.result?.state == "fail");
95+
const passed = res.filter((r) => r.result?.state === "pass");
96+
const skipped = res.filter((r) => r.result?.state === "skip");
97+
const failed = res.filter((r) => r.result?.state === "fail");
9998

10099
debug("finished tests. passed: %i, skipped: %i, failed: %i", passed.length, skipped.length, failed.length);
101100

‎src/cli/cli.ts

+14-18
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,25 @@
1-
// Must not use `* as yargs`, see https://github.com/yargs/yargs/issues/1131
2-
import yargs from "yargs";
31
import fs from "node:fs";
42
import path from "node:path";
53
import Debug from "debug";
64
import {parse as parseYaml} from "yaml";
5+
// Must not use `* as yargs`, see https://github.com/yargs/yargs/issues/1131
6+
import yargs from "yargs";
77
import {hideBin} from "yargs/helpers";
88

99
const debug = Debug("@chainsafe/benchmark/cli");
1010

11-
import {benchmarkOptions, CLIOptions, fileCollectionOptions, storageOptions} from "./options.js";
12-
import {run} from "./run.js";
11+
import {consoleLog} from "../utils/output.js";
1312
import {compare} from "./compare.js";
13+
import {CLIOptions, benchmarkOptions, fileCollectionOptions, storageOptions} from "./options.js";
14+
import {run} from "./run.js";
1415

1516
void yargs(hideBin(process.argv))
1617
.env("BENCHMARK")
1718
.scriptName("benchmark")
1819
.command({
1920
command: ["$0 [spec..]", "inspect"],
2021
describe: "Run benchmarks",
21-
builder: function (yar) {
22-
return yar.options({...fileCollectionOptions, ...storageOptions, ...benchmarkOptions});
23-
},
22+
builder: (yar) => yar.options({...fileCollectionOptions, ...storageOptions, ...benchmarkOptions}),
2423
handler: async (argv) => {
2524
const cliOpts = {...argv} as unknown as CLIOptions & {spec: string[]};
2625
debug("Executing command run with %O", cliOpts);
@@ -32,9 +31,8 @@ void yargs(hideBin(process.argv))
3231
command: "compare <dirs...>",
3332
aliases: ["cmp"],
3433
describe: "Compare multiple benchmark outputs",
35-
builder: function (yar) {
36-
return yar.option("dir", {type: "string", array: true, normalize: true, desc: "List of directories to compare"});
37-
},
34+
builder: (yar) =>
35+
yar.option("dir", {type: "string", array: true, normalize: true, desc: "List of directories to compare"}),
3836
handler: async (argv) => {
3937
const cliOpts = {...argv} as unknown as {dirs: string[]};
4038
debug("Executing command compare with %O", cliOpts);
@@ -46,7 +44,9 @@ void yargs(hideBin(process.argv))
4644
const ext = path.extname(configPath);
4745
if (ext === ".json") {
4846
return JSON.parse(fs.readFileSync(configPath, "utf-8")) as CLIOptions;
49-
} else if (ext === ".yaml" || ext === ".yml") {
47+
}
48+
49+
if (ext === ".yaml" || ext === ".yml") {
5050
return parseYaml(fs.readFileSync(configPath, "utf8")) as CLIOptions;
5151
}
5252

@@ -73,17 +73,13 @@ void yargs(hideBin(process.argv))
7373
.recommendCommands()
7474
.showHelpOnFail(true)
7575
.fail((msg, err) => {
76-
if (msg) {
77-
// Show command help message when no command is provided
78-
if (msg.includes("Not enough non-option arguments")) {
79-
// eslint-disable-next-line no-console
80-
console.log("\n");
81-
}
76+
// Show command help message when no command is provided
77+
if (msg?.includes("Not enough non-option arguments")) {
78+
consoleLog("\n");
8279
}
8380

8481
const errorMessage = err ? err.stack || err.message : msg || "Unknown error";
8582

86-
// eslint-disable-next-line no-console
8783
console.error(` ✖ ${errorMessage}\n`);
8884
process.exit(1);
8985
})

‎src/cli/compare.ts

+6-6
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
1-
import path from "node:path";
21
import fs from "node:fs";
3-
import {LocalHistoryProvider} from "../history/local.js";
4-
import {consoleLog} from "../utils/output.js";
2+
import path from "node:path";
53
import {computeComparisonReport} from "../compare/compute.js";
6-
import {renderBenchmarkComparisonTable} from "../utils/render.js";
7-
import {isGaRun} from "../github/context.js";
8-
import {postGaComment} from "../github/comments/index.js";
94
import {benchmarkComparisonComment} from "../github/comments/comparisonReportComment.js";
5+
import {postGaComment} from "../github/comments/index.js";
6+
import {isGaRun} from "../github/context.js";
107
import {GithubCommentTagEnum} from "../github/octokit.js";
8+
import {LocalHistoryProvider} from "../history/local.js";
9+
import {consoleLog} from "../utils/output.js";
10+
import {renderBenchmarkComparisonTable} from "../utils/render.js";
1111

1212
export async function compare({dirs}: {dirs: string[]}): Promise<void> {
1313
consoleLog("Comparing benchmarks:");

‎src/cli/options.ts

+5-5
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
import {Options} from "yargs";
2+
import {defaultBenchmarkOptions} from "../benchmark/options.js";
23
import {
3-
StorageOptions,
4-
BenchmarkOpts,
5-
FileCollectionOptions,
64
AverageCalculationEnum,
5+
BenchmarkOpts,
76
ConvergenceEnum,
7+
FileCollectionOptions,
8+
StorageOptions,
89
} from "../types.js";
9-
import {defaultBenchmarkOptions} from "../benchmark/options.js";
1010

1111
export const optionsDefault = {
1212
historyLocalPath: "./benchmark_data",
@@ -16,7 +16,7 @@ export const optionsDefault = {
1616
type CLIFileCollectionOptions = Omit<FileCollectionOptions, "spec">;
1717
type CLIStorageOptions = StorageOptions;
1818
type CLIBenchmarkOptions = Omit<BenchmarkOpts, "only" | "skip" | "noThreshold">;
19-
type ICliCommandOptions<OwnArgs> = Required<{[key in keyof OwnArgs]: Options}>;
19+
type ICliCommandOptions<OwnArgs> = Required<{[K in keyof OwnArgs]: Options}>;
2020

2121
export type CLIOptions = CLIFileCollectionOptions & CLIStorageOptions & CLIBenchmarkOptions;
2222

‎src/cli/run.ts

+14-14
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,28 @@
11
import * as github from "@actions/github";
22
import Debug from "debug";
3+
import {defaultBenchmarkOptions} from "../benchmark/options.js";
4+
import {BenchmarkRunner} from "../benchmark/runner.js";
5+
import {computePerformanceReport} from "../compare/compute.js";
6+
import {renderCompareWith, resolveCompareWith, resolvePrevBenchmark} from "../compare/index.js";
7+
import {postGaComment} from "../github/comments/index.js";
8+
import {performanceReportComment} from "../github/comments/performanceReportComment.js";
9+
import {isGaRun} from "../github/context.js";
10+
import {GithubCommentTagEnum} from "../github/octokit.js";
311
import {getHistoryProvider} from "../history/index.js";
4-
import {resolveShouldPersist} from "../history/shouldPersist.js";
12+
import {HistoryProviderEnum} from "../history/provider.js";
513
import {validateBenchmark} from "../history/schema.js";
14+
import {resolveShouldPersist} from "../history/shouldPersist.js";
615
import {Benchmark, BenchmarkOpts, FileCollectionOptions, StorageOptions} from "../types.js";
7-
import {renderCompareWith, resolveCompareWith, resolvePrevBenchmark} from "../compare/index.js";
816
import {
9-
parseBranchFromRef,
17+
collectFiles,
18+
getCurrentBranch,
1019
getCurrentCommitInfo,
20+
parseBranchFromRef,
1121
shell,
12-
getCurrentBranch,
13-
collectFiles,
1422
sortFiles,
1523
} from "../utils/index.js";
16-
import {computePerformanceReport} from "../compare/compute.js";
17-
import {postGaComment} from "../github/comments/index.js";
18-
import {isGaRun} from "../github/context.js";
19-
import {BenchmarkRunner} from "../benchmark/runner.js";
20-
import {optionsDefault} from "./options.js";
2124
import {consoleLog} from "../utils/output.js";
22-
import {HistoryProviderEnum} from "../history/provider.js";
23-
import {performanceReportComment} from "../github/comments/performanceReportComment.js";
24-
import {GithubCommentTagEnum} from "../github/octokit.js";
25-
import {defaultBenchmarkOptions} from "../benchmark/options.js";
25+
import {optionsDefault} from "./options.js";
2626

2727
const debug = Debug("@chainsafe/benchmark/cli");
2828

0 commit comments

Comments
 (0)