Skip to content

Commit

Permalink
refactor(cli/js): align error messages
Browse files Browse the repository at this point in the history 
Aligns the error messages in the cli/js folder to be in-line with the
Deno style guide.

denoland#25269
  • Loading branch information
@irbull
irbull committed Sep 3, 2024
1 parent 81e941b commit 2739b7e
Show file tree
Hide file tree
Showing 8 changed files with 34 additions and 34 deletions.
16 changes: 8 additions & 8 deletions cli/js/40_bench.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -104,12 +104,12 @@ function bench(
}
if (optionsOrFn.fn != undefined) {
throw new TypeError(
"Unexpected 'fn' field in options, bench function is already provided as the third argument.",
"Unexpected 'fn' field in options, bench function is already provided as the third argument",
);
}
if (optionsOrFn.name != undefined) {
throw new TypeError(
"Unexpected 'name' field in options, bench name is already provided as the first argument.",
"Unexpected 'name' field in options, bench name is already provided as the first argument",
);
}
benchDesc = {
Expand Down Expand Up @@ -141,7 +141,7 @@ function bench(
fn = optionsOrFn;
if (nameOrFnOrOptions.fn != undefined) {
throw new TypeError(
"Unexpected 'fn' field in options, bench function is already provided as the second argument.",
"Unexpected 'fn' field in options, bench function is already provided as the second argument",
);
}
name = nameOrFnOrOptions.name ?? fn.name;
Expand All @@ -150,7 +150,7 @@ function bench(
!nameOrFnOrOptions.fn || typeof nameOrFnOrOptions.fn !== "function"
) {
throw new TypeError(
"Expected 'fn' field in the first argument to be a bench function.",
"Expected 'fn' field in the first argument to be a bench function",
);
}
fn = nameOrFnOrOptions.fn;
Expand Down Expand Up @@ -385,12 +385,12 @@ function createBenchContext(desc) {
start() {
if (currentBenchId !== desc.id) {
throw new TypeError(
"The benchmark which this context belongs to is not being executed.",
"The benchmark which this context belongs to is not being executed",
);
}
if (currentBenchUserExplicitStart != null) {
throw new TypeError(
"BenchContext::start() has already been invoked.",
"BenchContext::start() has already been invoked",
);
}
currentBenchUserExplicitStart = benchNow();
Expand All @@ -399,11 +399,11 @@ function createBenchContext(desc) {
const end = benchNow();
if (currentBenchId !== desc.id) {
throw new TypeError(
"The benchmark which this context belongs to is not being executed.",
"The benchmark which this context belongs to is not being executed",
);
}
if (currentBenchUserExplicitEnd != null) {
throw new TypeError("BenchContext::end() has already been invoked.");
throw new TypeError("BenchContext::end() has already been invoked");
}
currentBenchUserExplicitEnd = end;
},
Expand Down
16 changes: 8 additions & 8 deletions cli/js/40_test.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ function assertExit(fn, isTest) {
throw new Error(
`${
isTest ? "Test case" : "Bench"
} finished with exit code set to ${exitCode}.`,
} finished with exit code set to ${exitCode}`,
);
}
if (innerResult) {
Expand Down Expand Up @@ -242,12 +242,12 @@ function testInner(
}
if (optionsOrFn.fn != undefined) {
throw new TypeError(
"Unexpected 'fn' field in options, test function is already provided as the third argument.",
"Unexpected 'fn' field in options, test function is already provided as the third argument",
);
}
if (optionsOrFn.name != undefined) {
throw new TypeError(
"Unexpected 'name' field in options, test name is already provided as the first argument.",
"Unexpected 'name' field in options, test name is already provided as the first argument",
);
}
testDesc = {
Expand Down Expand Up @@ -279,7 +279,7 @@ function testInner(
fn = optionsOrFn;
if (nameOrFnOrOptions.fn != undefined) {
throw new TypeError(
"Unexpected 'fn' field in options, test function is already provided as the second argument.",
"Unexpected 'fn' field in options, test function is already provided as the second argument",
);
}
name = nameOrFnOrOptions.name ?? fn.name;
Expand All @@ -288,7 +288,7 @@ function testInner(
!nameOrFnOrOptions.fn || typeof nameOrFnOrOptions.fn !== "function"
) {
throw new TypeError(
"Expected 'fn' field in the first argument to be a test function.",
"Expected 'fn' field in the first argument to be a test function",
);
}
fn = nameOrFnOrOptions.fn;
Expand Down Expand Up @@ -426,15 +426,15 @@ function createTestContext(desc) {
let stepDesc;
if (typeof nameOrFnOrOptions === "string") {
if (typeof maybeFn !== "function") {
throw new TypeError("Expected function for second argument.");
throw new TypeError("Expected function for second argument");
}
stepDesc = {
name: nameOrFnOrOptions,
fn: maybeFn,
};
} else if (typeof nameOrFnOrOptions === "function") {
if (!nameOrFnOrOptions.name) {
throw new TypeError("The step function must have a name.");
throw new TypeError("The step function must have a name");
}
if (maybeFn != undefined) {
throw new TypeError(
Expand All @@ -449,7 +449,7 @@ function createTestContext(desc) {
stepDesc = nameOrFnOrOptions;
} else {
throw new TypeError(
"Expected a test definition or name and function.",
"Expected a test definition or name and function",
);
}
stepDesc.ignore ??= false;
Expand Down
6 changes: 3 additions & 3 deletions tests/specs/bench/bench_explicit_start_end/explicit_start_and_end.out
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,17 +8,17 @@ benchmark time/iter (avg) iter/s (min … max) p75
start and end [WILDCARD] [WILDCARD] [WILDCARD] ([WILDCARD] … [WILDCARD]) [WILDCARD]
start only [WILDCARD] [WILDCARD] [WILDCARD] ([WILDCARD] … [WILDCARD]) [WILDCARD]
end only [WILDCARD] [WILDCARD] [WILDCARD] ([WILDCARD] … [WILDCARD]) [WILDCARD]
double start error: TypeError: BenchContext::start() has already been invoked.
double start error: TypeError: BenchContext::start() has already been invoked
t.start();
^
at BenchContext.start ([WILDCARD])
at [WILDCARD]/explicit_start_and_end.ts:[WILDCARD]
double end error: TypeError: BenchContext::end() has already been invoked.
double end error: TypeError: BenchContext::end() has already been invoked
t.end();
^
at BenchContext.end ([WILDCARD])
at [WILDCARD]/explicit_start_and_end.ts:[WILDCARD]
captured error: TypeError: The benchmark which this context belongs to is not being executed.
captured error: TypeError: The benchmark which this context belongs to is not being executed
captured!.start();
^
at BenchContext.start ([WILDCARD])
Expand Down
2 changes: 1 addition & 1 deletion tests/specs/test/exit_code/main.out
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Deno.exitCode ... FAILED ([WILDCARD])
ERRORS

Deno.exitCode => ./main.js:1:6
error: Error: Test case finished with exit code set to 42.
error: Error: Test case finished with exit code set to 42
at exitSanitizer (ext:cli/40_test.js:113:15)
at async outerWrapped (ext:cli/40_test.js:134:14)

Expand Down
2 changes: 1 addition & 1 deletion tests/specs/test/exit_code2/main.out
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ error: Error
at [WILDCARD]/exit_code2/main.js:3:9

success => ./main.js:6:6
error: Error: Test case finished with exit code set to 5.
error: Error: Test case finished with exit code set to 5
at exitSanitizer (ext:cli/40_test.js:113:15)
at async outerWrapped (ext:cli/40_test.js:134:14)

Expand Down
2 changes: 1 addition & 1 deletion tests/specs/test/exit_code3/main.out
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ success ... ok ([WILDCARD])
ERRORS

Deno.exitCode => ./main.js:1:6
error: Error: Test case finished with exit code set to 42.
error: Error: Test case finished with exit code set to 42
at exitSanitizer (ext:cli/40_test.js:113:15)
at async outerWrapped (ext:cli/40_test.js:134:14)

Expand Down
6 changes: 3 additions & 3 deletions tests/testdata/bench/explicit_start_and_end.out
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,17 +8,17 @@ benchmark time/iter (avg) iter/s (min … max) p75
start and end [WILDCARD] [WILDCARD] [WILDCARD] ([WILDCARD] … [WILDCARD]) [WILDCARD]
start only [WILDCARD] [WILDCARD] [WILDCARD] ([WILDCARD] … [WILDCARD]) [WILDCARD]
end only [WILDCARD] [WILDCARD] [WILDCARD] ([WILDCARD] … [WILDCARD]) [WILDCARD]
double start error: Type error: BenchContext::start() has already been invoked.
double start error: Type error: BenchContext::start() has already been invoked
t.start();
^
at BenchContext.start ([WILDCARD])
at [WILDCARD]/explicit_start_and_end.ts:[WILDCARD]
double end error: Type error: BenchContext::end() has already been invoked.
double end error: Type error: BenchContext::end() has already been invoked
t.end();
^
at BenchContext.end ([WILDCARD])
at [WILDCARD]/explicit_start_and_end.ts:[WILDCARD]
captured error: Type error: The benchmark which this context belongs to is not being executed.
captured error: Type error: The benchmark which this context belongs to is not being executed
captured!.start();
^
at BenchContext.start ([WILDCARD])
Expand Down
18 changes: 9 additions & 9 deletions tests/unit/testing_test.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,15 @@ Deno.test(function testWrongOverloads() {
Deno.test("some name", { fn: () => {} }, () => {});
},
TypeError,
"Unexpected 'fn' field in options, test function is already provided as the third argument.",
"Unexpected 'fn' field in options, test function is already provided as the third argument",
);
assertThrows(
() => {
// @ts-ignore Testing invalid overloads
Deno.test("some name", { name: "some name2" }, () => {});
},
TypeError,
"Unexpected 'name' field in options, test name is already provided as the first argument.",
"Unexpected 'name' field in options, test name is already provided as the first argument",
);
assertThrows(
() => {
Expand All @@ -40,23 +40,23 @@ Deno.test(function testWrongOverloads() {
Deno.test({ fn: () => {} }, function foo() {});
},
TypeError,
"Unexpected 'fn' field in options, test function is already provided as the second argument.",
"Unexpected 'fn' field in options, test function is already provided as the second argument",
);
assertThrows(
() => {
// @ts-ignore Testing invalid overloads
Deno.test({});
},
TypeError,
"Expected 'fn' field in the first argument to be a test function.",
"Expected 'fn' field in the first argument to be a test function",
);
assertThrows(
() => {
// @ts-ignore Testing invalid overloads
Deno.test({ fn: "boo!" });
},
TypeError,
"Expected 'fn' field in the first argument to be a test function.",
"Expected 'fn' field in the first argument to be a test function",
);
});

Expand Down Expand Up @@ -87,7 +87,7 @@ Deno.test(async function invalidStepArguments(t) {
await (t as any).step("test");
},
TypeError,
"Expected function for second argument.",
"Expected function for second argument",
);

await assertRejects(
Expand All @@ -96,7 +96,7 @@ Deno.test(async function invalidStepArguments(t) {
await (t as any).step("test", "not a function");
},
TypeError,
"Expected function for second argument.",
"Expected function for second argument",
);

await assertRejects(
Expand All @@ -105,7 +105,7 @@ Deno.test(async function invalidStepArguments(t) {
await (t as any).step();
},
TypeError,
"Expected a test definition or name and function.",
"Expected a test definition or name and function",
);

await assertRejects(
Expand All @@ -114,7 +114,7 @@ Deno.test(async function invalidStepArguments(t) {
await (t as any).step(() => {});
},
TypeError,
"The step function must have a name.",
"The step function must have a name",
);
});

Expand Down

0 comments on commit 2739b7e

Please sign in to comment.