Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
42 changes: 42 additions & 0 deletions src/blocks/blockConsoleFailTest.test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
import { testBlock } from "bingo-stratum-testers";
import { describe, expect, test } from "vitest";

import { blockConsoleFailTest } from "./blockConsoleFailTest.js";
import { optionsBase } from "./options.fakes.js";

describe("blockConsoleFailTest", () => {
test("production", () => {
const creation = testBlock(blockConsoleFailTest, {
options: optionsBase,
});

expect(creation).toMatchInlineSnapshot(`
{
"addons": [
{
"addons": {
"properties": {
"devDependencies": {
"console-fail-test": "0.6.1",
},
},
},
"block": [Function],
},
{
"addons": {
"additionalDocs": "
Note that [console-fail-test](https://github.com/JoshuaKGoldberg/console-fail-test) is enabled for all test runs.
Calls to \`console.log\`, \`console.warn\`, and other console methods will cause a test to fail.
",
"setupFiles": [
"console-fail-test/setup",
],
},
"block": [Function],
},
],
}
`);
});
});
25 changes: 25 additions & 0 deletions src/blocks/blockConsoleFailTest.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
import { base } from "../base.js";
import { getPackageDependencies } from "../data/packageData.js";
import { blockPackageJson } from "./blockPackageJson.js";
import { blockVitest } from "./blockVitest.js";

export const blockConsoleFailTest = base.createBlock({
produce() {
return {
addons: [
blockPackageJson({
properties: {
devDependencies: getPackageDependencies("console-fail-test"),
},
}),
blockVitest({
additionalDocs: `
Note that [console-fail-test](https://github.com/JoshuaKGoldberg/console-fail-test) is enabled for all test runs.
Calls to \`console.log\`, \`console.warn\`, and other console methods will cause a test to fail.
`,
setupFiles: ["console-fail-test/setup"],
}),
],
};
},
});
24 changes: 0 additions & 24 deletions src/blocks/blockVitest.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -43,10 +43,6 @@ describe("blockVitest", () => {
pnpm run test --coverage
\`\`\`

Note that [console-fail-test](https://github.com/JoshuaKGoldberg/console-fail-test) is enabled for all test runs.
Calls to \`console.log\`, \`console.warn\`, and other console methods will cause a test to fail.


",
},
},
Expand Down Expand Up @@ -179,7 +175,6 @@ describe("blockVitest", () => {
"devDependencies": {
"@vitest/coverage-v8": "4.0.15",
"@vitest/eslint-plugin": "1.5.1",
"console-fail-test": "0.6.1",
"vitest": "4.0.15",
},
"scripts": {
Expand Down Expand Up @@ -244,7 +239,6 @@ describe("blockVitest", () => {
reporter: ["html", "lcov"],
},
exclude: ["node_modules"],
setupFiles: ["console-fail-test/setup"],
},
});
",
Expand Down Expand Up @@ -288,10 +282,6 @@ describe("blockVitest", () => {
pnpm run test --coverage
\`\`\`

Note that [console-fail-test](https://github.com/JoshuaKGoldberg/console-fail-test) is enabled for all test runs.
Calls to \`console.log\`, \`console.warn\`, and other console methods will cause a test to fail.


",
},
},
Expand Down Expand Up @@ -424,7 +414,6 @@ describe("blockVitest", () => {
"devDependencies": {
"@vitest/coverage-v8": "4.0.15",
"@vitest/eslint-plugin": "1.5.1",
"console-fail-test": "0.6.1",
"vitest": "4.0.15",
},
"scripts": {
Expand Down Expand Up @@ -519,7 +508,6 @@ describe("blockVitest", () => {
reporter: ["html", "lcov"],
},
exclude: ["node_modules"],
setupFiles: ["console-fail-test/setup"],
},
});
",
Expand Down Expand Up @@ -571,10 +559,6 @@ describe("blockVitest", () => {
pnpm run test --coverage
\`\`\`

Note that [console-fail-test](https://github.com/JoshuaKGoldberg/console-fail-test) is enabled for all test runs.
Calls to \`console.log\`, \`console.warn\`, and other console methods will cause a test to fail.


",
},
},
Expand Down Expand Up @@ -707,7 +691,6 @@ describe("blockVitest", () => {
"devDependencies": {
"@vitest/coverage-v8": "4.0.15",
"@vitest/eslint-plugin": "1.5.1",
"console-fail-test": "0.6.1",
"vitest": "4.0.15",
},
"scripts": {
Expand Down Expand Up @@ -774,7 +757,6 @@ describe("blockVitest", () => {
},
environment: "happy-dom",
exclude: ["lib/","node_modules"],
setupFiles: ["console-fail-test/setup"],
},
});
",
Expand Down Expand Up @@ -825,10 +807,6 @@ describe("blockVitest", () => {
pnpm run test --coverage
\`\`\`

Note that [console-fail-test](https://github.com/JoshuaKGoldberg/console-fail-test) is enabled for all test runs.
Calls to \`console.log\`, \`console.warn\`, and other console methods will cause a test to fail.


",
},
},
Expand Down Expand Up @@ -961,7 +939,6 @@ describe("blockVitest", () => {
"devDependencies": {
"@vitest/coverage-v8": "4.0.15",
"@vitest/eslint-plugin": "1.5.1",
"console-fail-test": "0.6.1",
"vitest": "4.0.15",
},
"scripts": {
Expand Down Expand Up @@ -1027,7 +1004,6 @@ describe("blockVitest", () => {
reporter: ["html", "lcov"],
},
exclude: ["lib/","node_modules"],
setupFiles: ["console-fail-test/setup"],
},
});
",
Expand Down
30 changes: 23 additions & 7 deletions src/blocks/blockVitest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -61,10 +61,12 @@ export const blockVitest = base.createBlock({
},
addons: {
actionSteps: z.array(zActionStep).default([]),
additionalDocs: z.string().default(""),
coverage: zCoverage.default({}),
environment: zEnvironment.optional(),
exclude: zExclude.default([]),
flags: z.array(z.string()).default([]),
setupFiles: z.array(z.string()).default([]),
},
intake({ files, options }) {
return {
Expand All @@ -75,7 +77,14 @@ export const blockVitest = base.createBlock({
};
},
produce({ addons }) {
const { actionSteps, coverage, environment, exclude = [] } = addons;
const {
actionSteps,
additionalDocs,
coverage,
environment,
exclude = [],
setupFiles,
} = addons;
const excludeText = JSON.stringify(
Array.from(new Set(["node_modules", ...exclude])).sort(),
);
Expand All @@ -101,11 +110,15 @@ Add the \`--coverage\` flag to compute test coverage and place reports in the \`
\`\`\`shell
pnpm run test --coverage
\`\`\`
${
additionalDocs
? `

Note that [console-fail-test](https://github.com/JoshuaKGoldberg/console-fail-test) is enabled for all test runs.
Calls to \`console.log\`, \`console.warn\`, and other console methods will cause a test to fail.

${additionalDocs}

`
: ""
}
`,
},
},
Expand Down Expand Up @@ -198,7 +211,6 @@ describe(greet, () => {
devDependencies: getPackageDependencies(
"@vitest/coverage-v8",
"@vitest/eslint-plugin",
"console-fail-test",
"vitest",
),
scripts: {
Expand Down Expand Up @@ -249,8 +261,12 @@ export default defineConfig({
environment: "${environment}",`
: ""
}
exclude: [${excludeText.slice(1, excludeText.length - 1)}],
setupFiles: ["console-fail-test/setup"],
exclude: [${excludeText.slice(1, excludeText.length - 1)}],${
setupFiles.length
? `
setupFiles: ${JSON.stringify(setupFiles)},`
: ""
}
},
});
`,
Expand Down
3 changes: 3 additions & 0 deletions src/blocks/index.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import { blockAllContributors } from "./blockAllContributors.js";
import { blockAreTheTypesWrong } from "./blockAreTheTypesWrong.js";
import { blockCodecov } from "./blockCodecov.js";
import { blockConsoleFailTest } from "./blockConsoleFailTest.js";
import { blockContributingDocs } from "./blockContributingDocs.js";
import { blockContributorCovenant } from "./blockContributorCovenant.js";
import { blockCSpell } from "./blockCSpell.js";
Expand Down Expand Up @@ -51,6 +52,7 @@ export const blocks = {
blockAllContributors,
blockAreTheTypesWrong,
blockCodecov,
blockConsoleFailTest,
blockContributingDocs,
blockContributorCovenant,
blockCSpell,
Expand Down Expand Up @@ -101,6 +103,7 @@ export const blocks = {
export { blockAllContributors } from "./blockAllContributors.js";
export { blockAreTheTypesWrong } from "./blockAreTheTypesWrong.js";
export { blockCodecov } from "./blockCodecov.js";
export { blockConsoleFailTest } from "./blockConsoleFailTest.js";
export { blockContributingDocs } from "./blockContributingDocs.js";
export { blockContributorCovenant } from "./blockContributorCovenant.js";
export { blockCSpell } from "./blockCSpell.js";
Expand Down
2 changes: 2 additions & 0 deletions src/presets/everything.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import { base } from "../base.js";
import { blockConsoleFailTest } from "../blocks/blockConsoleFailTest.js";
import { blockCSpell } from "../blocks/blockCSpell.js";
import { blockESLintComments } from "../blocks/blockESLintComments.js";
import { blockESLintJSDoc } from "../blocks/blockESLintJSDoc.js";
Expand Down Expand Up @@ -30,6 +31,7 @@ export const presetEverything = base.createPreset({
},
blocks: [
...presetCommon.blocks,
blockConsoleFailTest,
blockCSpell,
blockESLintComments,
blockESLintJSDoc,
Expand Down
Loading