Skip to content

Throw an error if no _quarto.tests in metadata but there is a _quarto.test (without s) #11031

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 11, 2024
Merged

Throw an error if no _quarto.tests in metadata but there is a _quarto.test (without s) #11031

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fb70c28
Throw an error if no `_quarto.tests` in metadata but there is a `_qua…
cderv Oct 11, 2024
8e2a032
Fix test spec
cderv Oct 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion tests/docs/smoke-all/revealjs/jump-to-slide.qmd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ format:
revealjs:
jump-to-slide: false
_quarto:
test:
tests:
revealjs:
ensureFileRegexMatches:
- ["jumpToSlide.*false,"]
Expand Down
10 changes: 7 additions & 3 deletions tests/smoke/smoke-all.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,8 +78,12 @@ async function guessFormat(fileName: string): Promise<string[]> {
}

//deno-lint-ignore no-explicit-any
function hasTestSpecs(metadata: any): boolean {
return metadata?.["_quarto"]?.["tests"] != undefined;
function hasTestSpecs(metadata: any, input: string): boolean {
const hasTestSpecs = metadata?.["_quarto"]?.["tests"] != undefined
if (!hasTestSpecs && metadata?.["_quarto"]?.["test"] != undefined) {
throw new Error(`Test is ${input} is using 'test' in metadata instead of 'tests'. This is probably a typo.`);
}
return hasTestSpecs
}

interface QuartoInlineTestSpec {
Expand Down Expand Up @@ -231,7 +235,7 @@ for (const { path: fileName } of files) {

const testSpecs: QuartoInlineTestSpec[] = [];

if (hasTestSpecs(metadata)) {
if (hasTestSpecs(metadata, input)) {
testSpecs.push(...resolveTestSpecs(input, metadata));
} else {
const formats = await guessFormat(input);
Expand Down
Loading