bingo-stratum-testers 0.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE.md +20 -0
- package/README.md +13 -0
- package/lib/index.d.ts +3 -0
- package/lib/index.d.ts.map +1 -0
- package/lib/index.js +3 -0
- package/lib/index.js.map +1 -0
- package/lib/testBase.d.ts +8 -0
- package/lib/testBase.d.ts.map +1 -0
- package/lib/testBase.js +13 -0
- package/lib/testBase.js.map +1 -0
- package/lib/testBase.test.d.ts +2 -0
- package/lib/testBase.test.d.ts.map +1 -0
- package/lib/testBase.test.js +91 -0
- package/lib/testBase.test.js.map +1 -0
- package/lib/testBlock.d.ts +13 -0
- package/lib/testBlock.d.ts.map +1 -0
- package/lib/testBlock.js +10 -0
- package/lib/testBlock.js.map +1 -0
- package/lib/testBlock.test.d.ts +2 -0
- package/lib/testBlock.test.d.ts.map +1 -0
- package/lib/testBlock.test.js +79 -0
- package/lib/testBlock.test.js.map +1 -0
- package/lib/utils.d.ts +3 -0
- package/lib/utils.d.ts.map +1 -0
- package/lib/utils.js +12 -0
- package/lib/utils.js.map +1 -0
- package/package.json +39 -0
package/LICENSE.md
ADDED
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# MIT License
|
|
2
|
+
|
|
3
|
+
Permission is hereby granted, free of charge, to any person obtaining
|
|
4
|
+
a copy of this software and associated documentation files (the
|
|
5
|
+
'Software'), to deal in the Software without restriction, including
|
|
6
|
+
without limitation the rights to use, copy, modify, merge, publish,
|
|
7
|
+
distribute, sublicense, and/or sell copies of the Software, and to
|
|
8
|
+
permit persons to whom the Software is furnished to do so, subject to
|
|
9
|
+
the following conditions:
|
|
10
|
+
|
|
11
|
+
The above copyright notice and this permission notice shall be
|
|
12
|
+
included in all copies or substantial portions of the Software.
|
|
13
|
+
|
|
14
|
+
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
|
|
15
|
+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
|
16
|
+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
|
|
17
|
+
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
|
|
18
|
+
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
|
|
19
|
+
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
|
|
20
|
+
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
<h1 align="center">bingo-stratum-testers</h1>
|
|
2
|
+
|
|
3
|
+
<p align="center">Test utilities for Stratum Blocks and Presets. ๐งโ๐ง</p>
|
|
4
|
+
|
|
5
|
+
<p align="center">
|
|
6
|
+
<a href="https://github.com/JoshuaKGoldberg/bingo/blob/main/.github/CODE_OF_CONDUCT.md" target="_blank"><img alt="๐ค Code of Conduct: Kept" src="https://img.shields.io/badge/%F0%9F%A4%9D_code_of_conduct-kept-21bb42" /></a>
|
|
7
|
+
<a href="https://codecov.io/gh/JoshuaKGoldberg/bingo" target="_blank"><img alt="๐งช Coverage" src="https://img.shields.io/codecov/c/github/JoshuaKGoldberg/bingo?label=%F0%9F%A7%AA%20coverage" /></a>
|
|
8
|
+
<a href="https://github.com/JoshuaKGoldberg/bingo/blob/main/LICENSE.md" target="_blank"><img alt="๐ License: MIT" src="https://img.shields.io/badge/%F0%9F%93%9D_license-MIT-21bb42.svg"></a>
|
|
9
|
+
<a href="http://npmjs.com/package/bingo-stratum-testers"><img alt="๐ฆ npm version" src="https://img.shields.io/npm/v/bingo-stratum-testers?color=21bb42&label=%F0%9F%93%A6%20npm" /></a>
|
|
10
|
+
<img alt="๐ช TypeScript: Strict" src="https://img.shields.io/badge/%F0%9F%92%AA_typescript-strict-21bb42.svg" />
|
|
11
|
+
</p>
|
|
12
|
+
|
|
13
|
+
See **[create.bingo > Templating Engines > Stratum Packages > bingo-stratum-testers](https://create.bingo/build/packages/bingo-stratum-testers)** for documentation.
|
package/lib/index.d.ts
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AACzC,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC"}
|
package/lib/index.js
ADDED
package/lib/index.js.map
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AACzC,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC"}
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
import { AnyShape, InferredObject, TakeInput } from "bingo";
|
|
2
|
+
import { Base } from "bingo-stratum";
|
|
3
|
+
export interface BaseContextSettings<OptionsShape extends AnyShape> {
|
|
4
|
+
options?: InferredObject<OptionsShape>;
|
|
5
|
+
take?: TakeInput;
|
|
6
|
+
}
|
|
7
|
+
export declare function testBase<OptionsShape extends AnyShape>(base: Base<OptionsShape>, settings?: Partial<BaseContextSettings<OptionsShape>>): Promise<InferredObject<OptionsShape> | import("bingo").AwaitedLazyProperties<import("bingo").LazyOptionalOptions<Partial<InferredObject<OptionsShape>>>> | undefined>;
|
|
8
|
+
//# sourceMappingURL=testBase.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"testBase.d.ts","sourceRoot":"","sources":["../src/testBase.ts"],"names":[],"mappings":"AAAA,OAAO,EACN,QAAQ,EAER,cAAc,EACd,SAAS,EACT,MAAM,OAAO,CAAC;AACf,OAAO,EAAE,IAAI,EAAE,MAAM,eAAe,CAAC;AAIrC,MAAM,WAAW,mBAAmB,CAAC,YAAY,SAAS,QAAQ;IACjE,OAAO,CAAC,EAAE,cAAc,CAAC,YAAY,CAAC,CAAC;IACvC,IAAI,CAAC,EAAE,SAAS,CAAC;CACjB;AAED,wBAAsB,QAAQ,CAAC,YAAY,SAAS,QAAQ,EAC3D,IAAI,EAAE,IAAI,CAAC,YAAY,CAAC,EACxB,QAAQ,GAAE,OAAO,CAAC,mBAAmB,CAAC,YAAY,CAAC,CAAM,yKAgBzD"}
|
package/lib/testBase.js
ADDED
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
import { awaitLazyProperties, } from "bingo";
|
|
2
|
+
import { createFailingFunction, createFailingObject } from "./utils.js";
|
|
3
|
+
export async function testBase(base, settings = {}) {
|
|
4
|
+
if (!base.prepare) {
|
|
5
|
+
return settings.options;
|
|
6
|
+
}
|
|
7
|
+
return await awaitLazyProperties(base.prepare({
|
|
8
|
+
options: createFailingObject("options", "the Base"),
|
|
9
|
+
take: createFailingFunction("take", "the Base"),
|
|
10
|
+
...settings,
|
|
11
|
+
}));
|
|
12
|
+
}
|
|
13
|
+
//# sourceMappingURL=testBase.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"testBase.js","sourceRoot":"","sources":["../src/testBase.ts"],"names":[],"mappings":"AAAA,OAAO,EAEN,mBAAmB,GAGnB,MAAM,OAAO,CAAC;AAGf,OAAO,EAAE,qBAAqB,EAAE,mBAAmB,EAAE,MAAM,YAAY,CAAC;AAOxE,MAAM,CAAC,KAAK,UAAU,QAAQ,CAC7B,IAAwB,EACxB,WAAuD,EAAE;IAEzD,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;QACnB,OAAO,QAAQ,CAAC,OAAO,CAAC;IACzB,CAAC;IAED,OAAO,MAAM,mBAAmB,CAC/B,IAAI,CAAC,OAAO,CAAC;QACZ,OAAO,EAAE,mBAAmB,CAC3B,SAAS,EACT,UAAU,CACsB;QACjC,IAAI,EAAE,qBAAqB,CAAC,MAAM,EAAE,UAAU,CAAC;QAC/C,GAAG,QAAQ;KACX,CAAC,CACF,CAAC;AACH,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"testBase.test.d.ts","sourceRoot":"","sources":["../src/testBase.test.ts"],"names":[],"mappings":""}
|
|
@@ -0,0 +1,91 @@
|
|
|
1
|
+
import { createInput } from "bingo";
|
|
2
|
+
import { createBase } from "bingo-stratum";
|
|
3
|
+
import { describe, expect, it, vi } from "vitest";
|
|
4
|
+
import { z } from "zod";
|
|
5
|
+
import { testBase } from "./testBase.js";
|
|
6
|
+
const baseWithNoProduce = createBase({
|
|
7
|
+
options: {
|
|
8
|
+
value: z.string(),
|
|
9
|
+
},
|
|
10
|
+
});
|
|
11
|
+
const baseWithValueHardcoded = createBase({
|
|
12
|
+
options: {
|
|
13
|
+
value: z.string(),
|
|
14
|
+
},
|
|
15
|
+
prepare() {
|
|
16
|
+
return {
|
|
17
|
+
value: "hardcoded",
|
|
18
|
+
};
|
|
19
|
+
},
|
|
20
|
+
});
|
|
21
|
+
describe("testBase", () => {
|
|
22
|
+
it("doesn't throw an error when the Base has no produce and settings isn't provided", async () => {
|
|
23
|
+
const actual = await testBase(baseWithNoProduce);
|
|
24
|
+
expect(actual).toEqual(undefined);
|
|
25
|
+
});
|
|
26
|
+
it("doesn't throw an error when the Base has no produce and settings is {}", async () => {
|
|
27
|
+
const actual = await testBase(baseWithNoProduce, {});
|
|
28
|
+
expect(actual).toEqual(undefined);
|
|
29
|
+
});
|
|
30
|
+
it("doesn't throw an error when the Base has a produce that does not use settings and settings isn't provided", async () => {
|
|
31
|
+
const actual = await testBase(baseWithValueHardcoded);
|
|
32
|
+
expect(actual).toEqual({ value: "hardcoded" });
|
|
33
|
+
});
|
|
34
|
+
it("doesn't throw an error when the Base has a produce that does not use settings and settings is {}", async () => {
|
|
35
|
+
const actual = await testBase(baseWithValueHardcoded, {});
|
|
36
|
+
expect(actual).toEqual({ value: "hardcoded" });
|
|
37
|
+
});
|
|
38
|
+
describe("options", () => {
|
|
39
|
+
const baseWithValueFromOptions = createBase({
|
|
40
|
+
options: {
|
|
41
|
+
value: z.string(),
|
|
42
|
+
},
|
|
43
|
+
prepare({ options }) {
|
|
44
|
+
return {
|
|
45
|
+
value: options.value ?? "default",
|
|
46
|
+
};
|
|
47
|
+
},
|
|
48
|
+
});
|
|
49
|
+
it("returns the options directly when the Base has no produce", async () => {
|
|
50
|
+
const actual = await testBase(baseWithNoProduce, {
|
|
51
|
+
options: { value: "direct" },
|
|
52
|
+
});
|
|
53
|
+
expect(actual).toEqual({ value: "direct" });
|
|
54
|
+
});
|
|
55
|
+
it("throws an error when the Base produce uses options and settings does not contain options", async () => {
|
|
56
|
+
await expect(async () => await testBase(baseWithValueFromOptions, {})).rejects.toMatchInlineSnapshot(`[Error: Context property 'options' was used by the Base but not provided.]`);
|
|
57
|
+
});
|
|
58
|
+
it("uses options when the Base produce uses options and settings contains options", async () => {
|
|
59
|
+
const actual = await testBase(baseWithValueFromOptions, {
|
|
60
|
+
options: { value: "override" },
|
|
61
|
+
});
|
|
62
|
+
expect(actual).toEqual({ value: "override" });
|
|
63
|
+
});
|
|
64
|
+
});
|
|
65
|
+
describe("take", () => {
|
|
66
|
+
const constant = "abc123";
|
|
67
|
+
const inputConstant = createInput({
|
|
68
|
+
produce: () => constant,
|
|
69
|
+
});
|
|
70
|
+
const baseWithValueFromInput = createBase({
|
|
71
|
+
options: {
|
|
72
|
+
value: z.string(),
|
|
73
|
+
},
|
|
74
|
+
prepare({ take }) {
|
|
75
|
+
return {
|
|
76
|
+
value: () => take(inputConstant),
|
|
77
|
+
};
|
|
78
|
+
},
|
|
79
|
+
});
|
|
80
|
+
it("throws an error when the Base produce uses take and settings does not include take", async () => {
|
|
81
|
+
await expect(async () => testBase(baseWithValueFromInput, { options: { value: "unused" } })).rejects.toMatchInlineSnapshot(`[Error: Context property 'take' was used by the Base but not provided.]`);
|
|
82
|
+
});
|
|
83
|
+
it("uses the provide take when the Base produce uses take and settings includes take", async () => {
|
|
84
|
+
const take = vi.fn().mockReturnValueOnce("taken");
|
|
85
|
+
const actual = await testBase(baseWithValueFromInput, { take });
|
|
86
|
+
expect(actual).toEqual({ value: "taken" });
|
|
87
|
+
expect(take).toHaveBeenCalledWith(inputConstant);
|
|
88
|
+
});
|
|
89
|
+
});
|
|
90
|
+
});
|
|
91
|
+
//# sourceMappingURL=testBase.test.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"testBase.test.js","sourceRoot":"","sources":["../src/testBase.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,OAAO,CAAC;AACpC,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAC3C,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAC;AAClD,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAEzC,MAAM,iBAAiB,GAAG,UAAU,CAAC;IACpC,OAAO,EAAE;QACR,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;KACjB;CACD,CAAC,CAAC;AAEH,MAAM,sBAAsB,GAAG,UAAU,CAAC;IACzC,OAAO,EAAE;QACR,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;KACjB;IACD,OAAO;QACN,OAAO;YACN,KAAK,EAAE,WAAW;SAClB,CAAC;IACH,CAAC;CACD,CAAC,CAAC;AAEH,QAAQ,CAAC,UAAU,EAAE,GAAG,EAAE;IACzB,EAAE,CAAC,iFAAiF,EAAE,KAAK,IAAI,EAAE;QAChG,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,iBAAiB,CAAC,CAAC;QAEjD,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IACnC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,wEAAwE,EAAE,KAAK,IAAI,EAAE;QACvF,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,iBAAiB,EAAE,EAAE,CAAC,CAAC;QAErD,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IACnC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,2GAA2G,EAAE,KAAK,IAAI,EAAE;QAC1H,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,sBAAsB,CAAC,CAAC;QAEtD,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,EAAE,KAAK,EAAE,WAAW,EAAE,CAAC,CAAC;IAChD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,kGAAkG,EAAE,KAAK,IAAI,EAAE;QACjH,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,sBAAsB,EAAE,EAAE,CAAC,CAAC;QAE1D,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,EAAE,KAAK,EAAE,WAAW,EAAE,CAAC,CAAC;IAChD,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,SAAS,EAAE,GAAG,EAAE;QACxB,MAAM,wBAAwB,GAAG,UAAU,CAAC;YAC3C,OAAO,EAAE;gBACR,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;aACjB;YACD,OAAO,CAAC,EAAE,OAAO,EAAE;gBAClB,OAAO;oBACN,KAAK,EAAE,OAAO,CAAC,KAAK,IAAI,SAAS;iBACjC,CAAC;YACH,CAAC;SACD,CAAC,CAAC;QAEH,EAAE,CAAC,2DAA2D,EAAE,KAAK,IAAI,EAAE;YAC1E,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,iBAAiB,EAAE;gBAChD,OAAO,EAAE,EAAE,KAAK,EAAE,QAAQ,EAAE;aAC5B,CAAC,CAAC;YAEH,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAC,CAAC;QAC7C,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,0FAA0F,EAAE,KAAK,IAAI,EAAE;YACzG,MAAM,MAAM,CACX,KAAK,IAAI,EAAE,CAAC,MAAM,QAAQ,CAAC,wBAAwB,EAAE,EAAE,CAAC,CACxD,CAAC,OAAO,CAAC,qBAAqB,CAC9B,4EAA4E,CAC5E,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,+EAA+E,EAAE,KAAK,IAAI,EAAE;YAC9F,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,wBAAwB,EAAE;gBACvD,OAAO,EAAE,EAAE,KAAK,EAAE,UAAU,EAAE;aAC9B,CAAC,CAAC;YAEH,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,EAAE,KAAK,EAAE,UAAU,EAAE,CAAC,CAAC;QAC/C,CAAC,CAAC,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,MAAM,EAAE,GAAG,EAAE;QACrB,MAAM,QAAQ,GAAG,QAAQ,CAAC;QAC1B,MAAM,aAAa,GAAG,WAAW,CAAC;YACjC,OAAO,EAAE,GAAG,EAAE,CAAC,QAAQ;SACvB,CAAC,CAAC;QAEH,MAAM,sBAAsB,GAAG,UAAU,CAAC;YACzC,OAAO,EAAE;gBACR,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;aACjB;YACD,OAAO,CAAC,EAAE,IAAI,EAAE;gBACf,OAAO;oBACN,KAAK,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,aAAa,CAAC;iBAChC,CAAC;YACH,CAAC;SACD,CAAC,CAAC;QAEH,EAAE,CAAC,oFAAoF,EAAE,KAAK,IAAI,EAAE;YACnG,MAAM,MAAM,CAAC,KAAK,IAAI,EAAE,CACvB,QAAQ,CAAC,sBAAsB,EAAE,EAAE,OAAO,EAAE,EAAE,KAAK,EAAE,QAAQ,EAAE,EAAE,CAAC,CAClE,CAAC,OAAO,CAAC,qBAAqB,CAC9B,yEAAyE,CACzE,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,kFAAkF,EAAE,KAAK,IAAI,EAAE;YACjG,MAAM,IAAI,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAC;YAElD,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,sBAAsB,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC;YAEhE,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC,CAAC;YAC3C,MAAM,CAAC,IAAI,CAAC,CAAC,oBAAoB,CAAC,aAAa,CAAC,CAAC;QAClD,CAAC,CAAC,CAAC;IACJ,CAAC,CAAC,CAAC;AACJ,CAAC,CAAC,CAAC"}
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
import { ProductionMode } from "bingo";
|
|
2
|
+
import { BlockWithAddons, BlockWithoutAddons } from "bingo-stratum";
|
|
3
|
+
import { BlockCreation } from "bingo-stratum/lib/types/creations.js";
|
|
4
|
+
export interface BlockContextSettingsWithOptionalAddons<Addons extends object, Options extends object> extends BlockContextSettingsWithoutAddons<Options> {
|
|
5
|
+
addons?: Partial<Addons>;
|
|
6
|
+
}
|
|
7
|
+
export interface BlockContextSettingsWithoutAddons<Options extends object> {
|
|
8
|
+
mode?: ProductionMode;
|
|
9
|
+
options?: Options;
|
|
10
|
+
}
|
|
11
|
+
export declare function testBlock<Addons extends object, Options extends object>(block: BlockWithAddons<Addons, Options>, settings: BlockContextSettingsWithOptionalAddons<Addons, Options>): Partial<BlockCreation<Options>>;
|
|
12
|
+
export declare function testBlock<Options extends object>(block: BlockWithoutAddons<Options>, settings?: BlockContextSettingsWithoutAddons<Options>): Partial<BlockCreation<Options>>;
|
|
13
|
+
//# sourceMappingURL=testBlock.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"testBlock.d.ts","sourceRoot":"","sources":["../src/testBlock.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,OAAO,CAAC;AACvC,OAAO,EACN,eAAe,EACf,kBAAkB,EAGlB,MAAM,eAAe,CAAC;AACvB,OAAO,EAAE,aAAa,EAAE,MAAM,sCAAsC,CAAC;AAIrE,MAAM,WAAW,sCAAsC,CACtD,MAAM,SAAS,MAAM,EACrB,OAAO,SAAS,MAAM,CACrB,SAAQ,iCAAiC,CAAC,OAAO,CAAC;IACnD,MAAM,CAAC,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC;CACzB;AAED,MAAM,WAAW,iCAAiC,CAAC,OAAO,SAAS,MAAM;IACxE,IAAI,CAAC,EAAE,cAAc,CAAC;IACtB,OAAO,CAAC,EAAE,OAAO,CAAC;CAClB;AAED,wBAAgB,SAAS,CAAC,MAAM,SAAS,MAAM,EAAE,OAAO,SAAS,MAAM,EACtE,KAAK,EAAE,eAAe,CAAC,MAAM,EAAE,OAAO,CAAC,EACvC,QAAQ,EAAE,sCAAsC,CAAC,MAAM,EAAE,OAAO,CAAC,GAC/D,OAAO,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,CAAC;AACnC,wBAAgB,SAAS,CAAC,OAAO,SAAS,MAAM,EAC/C,KAAK,EAAE,kBAAkB,CAAC,OAAO,CAAC,EAClC,QAAQ,CAAC,EAAE,iCAAiC,CAAC,OAAO,CAAC,GACnD,OAAO,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,CAAC"}
|
package/lib/testBlock.js
ADDED
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
import { produceBlock, } from "bingo-stratum";
|
|
2
|
+
import { createFailingObject } from "./utils.js";
|
|
3
|
+
export function testBlock(block, settings = {}) {
|
|
4
|
+
return produceBlock(block, {
|
|
5
|
+
addons: {},
|
|
6
|
+
options: createFailingObject("options", "the Block"),
|
|
7
|
+
...settings,
|
|
8
|
+
});
|
|
9
|
+
}
|
|
10
|
+
//# sourceMappingURL=testBlock.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"testBlock.js","sourceRoot":"","sources":["../src/testBlock.ts"],"names":[],"mappings":"AACA,OAAO,EAGN,YAAY,GAEZ,MAAM,eAAe,CAAC;AAGvB,OAAO,EAAE,mBAAmB,EAAE,MAAM,YAAY,CAAC;AAsBjD,MAAM,UAAU,SAAS,CACxB,KAAqE,EACrE,WAAoE,EAAE;IAEtE,OAAO,YAAY,CAClB,KAAyC,EACzC;QACC,MAAM,EAAE,EAAE;QACV,OAAO,EAAE,mBAAmB,CAAC,SAAS,EAAE,WAAW,CAAY;QAC/D,GAAG,QAAQ;KACwC,CACpD,CAAC;AACH,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"testBlock.test.d.ts","sourceRoot":"","sources":["../src/testBlock.test.ts"],"names":[],"mappings":""}
|
|
@@ -0,0 +1,79 @@
|
|
|
1
|
+
import { createBase } from "bingo-stratum";
|
|
2
|
+
import { describe, expect, it } from "vitest";
|
|
3
|
+
import { z } from "zod";
|
|
4
|
+
import { testBlock } from "./testBlock.js";
|
|
5
|
+
const base = createBase({
|
|
6
|
+
options: {
|
|
7
|
+
value: z.string(),
|
|
8
|
+
},
|
|
9
|
+
});
|
|
10
|
+
const blockStandalone = base.createBlock({
|
|
11
|
+
produce() {
|
|
12
|
+
return {
|
|
13
|
+
files: {
|
|
14
|
+
"value.txt": "abc",
|
|
15
|
+
},
|
|
16
|
+
};
|
|
17
|
+
},
|
|
18
|
+
});
|
|
19
|
+
describe("testBlock", () => {
|
|
20
|
+
it("doesn't throw an error when settings isn't provided and the block uses no settings", () => {
|
|
21
|
+
const actual = testBlock(blockStandalone);
|
|
22
|
+
expect(actual).toEqual({ files: { "value.txt": "abc" } });
|
|
23
|
+
});
|
|
24
|
+
it("doesn't throw an error when settings is {} and the block uses no settings", () => {
|
|
25
|
+
const actual = testBlock(blockStandalone, {});
|
|
26
|
+
expect(actual).toEqual({ files: { "value.txt": "abc" } });
|
|
27
|
+
});
|
|
28
|
+
describe("addons", () => {
|
|
29
|
+
const blockUsingAddons = base.createBlock({
|
|
30
|
+
addons: {
|
|
31
|
+
value: z.string().optional(),
|
|
32
|
+
},
|
|
33
|
+
produce({ addons }) {
|
|
34
|
+
return {
|
|
35
|
+
files: {
|
|
36
|
+
"value.txt": addons.value ?? "default",
|
|
37
|
+
},
|
|
38
|
+
};
|
|
39
|
+
},
|
|
40
|
+
});
|
|
41
|
+
it("does not throws an error when addons isn't provided and a block uses addons", () => {
|
|
42
|
+
const actual = testBlock(blockUsingAddons, {});
|
|
43
|
+
expect(actual).toMatchInlineSnapshot(`
|
|
44
|
+
{
|
|
45
|
+
"files": {
|
|
46
|
+
"value.txt": "default",
|
|
47
|
+
},
|
|
48
|
+
}
|
|
49
|
+
`);
|
|
50
|
+
});
|
|
51
|
+
it("passes addons to the block when provided", () => {
|
|
52
|
+
const actual = testBlock(blockUsingAddons, {
|
|
53
|
+
addons: { value: "abc" },
|
|
54
|
+
});
|
|
55
|
+
expect(actual).toEqual({ files: { "value.txt": "abc" } });
|
|
56
|
+
});
|
|
57
|
+
});
|
|
58
|
+
describe("options", () => {
|
|
59
|
+
const blockUsingOptions = base.createBlock({
|
|
60
|
+
produce({ options }) {
|
|
61
|
+
return {
|
|
62
|
+
files: {
|
|
63
|
+
"value.txt": options.value,
|
|
64
|
+
},
|
|
65
|
+
};
|
|
66
|
+
},
|
|
67
|
+
});
|
|
68
|
+
it("throws an error when options isn't provided and a block uses options", () => {
|
|
69
|
+
expect(() => testBlock(blockUsingOptions)).toThrowErrorMatchingInlineSnapshot(`[Error: Context property 'options' was used by the Block but not provided.]`);
|
|
70
|
+
});
|
|
71
|
+
it("passes options to the block when provided", () => {
|
|
72
|
+
const actual = testBlock(blockUsingOptions, {
|
|
73
|
+
options: { value: "abc" },
|
|
74
|
+
});
|
|
75
|
+
expect(actual).toEqual({ files: { "value.txt": "abc" } });
|
|
76
|
+
});
|
|
77
|
+
});
|
|
78
|
+
});
|
|
79
|
+
//# sourceMappingURL=testBlock.test.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"testBlock.test.js","sourceRoot":"","sources":["../src/testBlock.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAC3C,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAC;AAC9C,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAE3C,MAAM,IAAI,GAAG,UAAU,CAAC;IACvB,OAAO,EAAE;QACR,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;KACjB;CACD,CAAC,CAAC;AAEH,MAAM,eAAe,GAAG,IAAI,CAAC,WAAW,CAAC;IACxC,OAAO;QACN,OAAO;YACN,KAAK,EAAE;gBACN,WAAW,EAAE,KAAK;aAClB;SACD,CAAC;IACH,CAAC;CACD,CAAC,CAAC;AAEH,QAAQ,CAAC,WAAW,EAAE,GAAG,EAAE;IAC1B,EAAE,CAAC,oFAAoF,EAAE,GAAG,EAAE;QAC7F,MAAM,MAAM,GAAG,SAAS,CAAC,eAAe,CAAC,CAAC;QAE1C,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,EAAE,KAAK,EAAE,EAAE,WAAW,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC;IAC3D,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,2EAA2E,EAAE,GAAG,EAAE;QACpF,MAAM,MAAM,GAAG,SAAS,CAAC,eAAe,EAAE,EAAE,CAAC,CAAC;QAE9C,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,EAAE,KAAK,EAAE,EAAE,WAAW,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC;IAC3D,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,QAAQ,EAAE,GAAG,EAAE;QACvB,MAAM,gBAAgB,GAAG,IAAI,CAAC,WAAW,CAAC;YACzC,MAAM,EAAE;gBACP,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;aAC5B;YACD,OAAO,CAAC,EAAE,MAAM,EAAE;gBACjB,OAAO;oBACN,KAAK,EAAE;wBACN,WAAW,EAAE,MAAM,CAAC,KAAK,IAAI,SAAS;qBACtC;iBACD,CAAC;YACH,CAAC;SACD,CAAC,CAAC;QAEH,EAAE,CAAC,6EAA6E,EAAE,GAAG,EAAE;YACtF,MAAM,MAAM,GAAG,SAAS,CAAC,gBAAgB,EAAE,EAAE,CAAC,CAAC;YAE/C,MAAM,CAAC,MAAM,CAAC,CAAC,qBAAqB,CAAC;;;;;;IAMpC,CAAC,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,0CAA0C,EAAE,GAAG,EAAE;YACnD,MAAM,MAAM,GAAG,SAAS,CAAC,gBAAgB,EAAE;gBAC1C,MAAM,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE;aACxB,CAAC,CAAC;YAEH,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,EAAE,KAAK,EAAE,EAAE,WAAW,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC;QAC3D,CAAC,CAAC,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,SAAS,EAAE,GAAG,EAAE;QACxB,MAAM,iBAAiB,GAAG,IAAI,CAAC,WAAW,CAAC;YAC1C,OAAO,CAAC,EAAE,OAAO,EAAE;gBAClB,OAAO;oBACN,KAAK,EAAE;wBACN,WAAW,EAAE,OAAO,CAAC,KAAK;qBAC1B;iBACD,CAAC;YACH,CAAC;SACD,CAAC,CAAC;QAEH,EAAE,CAAC,sEAAsE,EAAE,GAAG,EAAE;YAC/E,MAAM,CAAC,GAAG,EAAE,CACX,SAAS,CAAC,iBAAiB,CAAC,CAC5B,CAAC,kCAAkC,CACnC,6EAA6E,CAC7E,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,2CAA2C,EAAE,GAAG,EAAE;YACpD,MAAM,MAAM,GAAG,SAAS,CAAC,iBAAiB,EAAE;gBAC3C,OAAO,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE;aACzB,CAAC,CAAC;YAEH,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,EAAE,KAAK,EAAE,EAAE,WAAW,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC;QAC3D,CAAC,CAAC,CAAC;IACJ,CAAC,CAAC,CAAC;AACJ,CAAC,CAAC,CAAC"}
|
package/lib/utils.d.ts
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAAA,wBAAgB,qBAAqB,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,eAEhE;AAED,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,MAO9D"}
|
package/lib/utils.js
ADDED
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
export function createFailingFunction(label, user) {
|
|
2
|
+
return () => failingFunction(label, user);
|
|
3
|
+
}
|
|
4
|
+
export function createFailingObject(label, user) {
|
|
5
|
+
return new Proxy({}, {
|
|
6
|
+
get: createFailingFunction(label, user),
|
|
7
|
+
});
|
|
8
|
+
}
|
|
9
|
+
function failingFunction(label, user) {
|
|
10
|
+
throw new Error(`Context property '${label}' was used by ${user} but not provided.`);
|
|
11
|
+
}
|
|
12
|
+
//# sourceMappingURL=utils.js.map
|
package/lib/utils.js.map
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"utils.js","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAAA,MAAM,UAAU,qBAAqB,CAAC,KAAa,EAAE,IAAY;IAChE,OAAO,GAAG,EAAE,CAAC,eAAe,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;AAC3C,CAAC;AAED,MAAM,UAAU,mBAAmB,CAAC,KAAa,EAAE,IAAY;IAC9D,OAAO,IAAI,KAAK,CACf,EAAE,EACF;QACC,GAAG,EAAE,qBAAqB,CAAC,KAAK,EAAE,IAAI,CAAC;KACvC,CACD,CAAC;AACH,CAAC;AAED,SAAS,eAAe,CAAC,KAAa,EAAE,IAAY;IACnD,MAAM,IAAI,KAAK,CACd,qBAAqB,KAAK,iBAAiB,IAAI,oBAAoB,CACnE,CAAC;AACH,CAAC"}
|
package/package.json
ADDED
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "bingo-stratum-testers",
|
|
3
|
+
"version": "0.3.0",
|
|
4
|
+
"description": "Test utilities for Stratum Blocks and Presets. ๐งโ๐ง",
|
|
5
|
+
"repository": {
|
|
6
|
+
"type": "git",
|
|
7
|
+
"url": "https://github.com/JoshuaKGoldberg/bingo",
|
|
8
|
+
"directory": "packages/bingo-stratum-testers"
|
|
9
|
+
},
|
|
10
|
+
"license": "MIT",
|
|
11
|
+
"author": {
|
|
12
|
+
"name": "Josh Goldberg โจ",
|
|
13
|
+
"email": "npm@joshuakgoldberg.com"
|
|
14
|
+
},
|
|
15
|
+
"type": "module",
|
|
16
|
+
"main": "./lib/index.js",
|
|
17
|
+
"files": [
|
|
18
|
+
"lib/",
|
|
19
|
+
"package.json",
|
|
20
|
+
"LICENSE.md",
|
|
21
|
+
"README.md"
|
|
22
|
+
],
|
|
23
|
+
"devDependencies": {
|
|
24
|
+
"zod": "3.24.2"
|
|
25
|
+
},
|
|
26
|
+
"peerDependencies": {
|
|
27
|
+
"bingo": "^0.3.0",
|
|
28
|
+
"bingo-stratum": "^0.2.0",
|
|
29
|
+
"bingo-fs": "^0.2.0",
|
|
30
|
+
"bingo-systems": "^0.2.0",
|
|
31
|
+
"bingo-testers": "^0.3.0"
|
|
32
|
+
},
|
|
33
|
+
"engines": {
|
|
34
|
+
"node": ">=18"
|
|
35
|
+
},
|
|
36
|
+
"scripts": {
|
|
37
|
+
"build": "tsc"
|
|
38
|
+
}
|
|
39
|
+
}
|