Skip to content

Commit 4ee1ca1

Browse files
committed
add some descriptions
1 parent 37ea069 commit 4ee1ca1

File tree

1 file changed

+45
-23
lines changed

1 file changed

+45
-23
lines changed

src/config.ts

Lines changed: 45 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,52 @@
11
import zod from 'zod';
22

33
const BobConfigModel = zod.optional(
4-
zod.union([
5-
zod.literal(false),
6-
zod.object({
7-
commonjs: zod.optional(zod.literal(false), {
8-
description: 'Omit CommonJS output.',
9-
}),
10-
build: zod.union([
11-
zod.literal(false),
12-
zod.optional(
13-
zod.object({
14-
copy: zod.optional(zod.array(zod.string())),
15-
}),
4+
zod.union(
5+
[
6+
zod.literal(false),
7+
zod.object({
8+
commonjs: zod.optional(zod.literal(false), {
9+
description: 'Omit CommonJS output.',
10+
}),
11+
build: zod.union(
12+
[
13+
zod.literal(false),
14+
zod.optional(
15+
zod.object({
16+
copy: zod.optional(zod.array(zod.string()), {
17+
description:
18+
'Specify a list of files that should be copied the the output directory.',
19+
}),
20+
}),
21+
),
22+
],
23+
{
24+
description:
25+
'Build configuration. Set to false for skipping the build of this package.',
26+
},
27+
),
28+
check: zod.optional(
29+
zod.union([
30+
zod.literal(false),
31+
zod.object({
32+
skip: zod.optional(zod.array(zod.string()), {
33+
description:
34+
'Skip certain files from being checked. E.g. modules with side-effects.',
35+
}),
36+
}),
37+
]),
38+
{
39+
description:
40+
'Check whether the built packages comply with the standards. (ESM & CJS compatible and loadable and Node.js engines specified)',
41+
},
1642
),
17-
]),
18-
check: zod.optional(
19-
zod.union([
20-
zod.literal(false),
21-
zod.object({
22-
skip: zod.optional(zod.array(zod.string())),
23-
}),
24-
]),
25-
),
26-
}),
27-
]),
43+
}),
44+
],
45+
{
46+
description:
47+
'Bob configuration. Set this value to false in order to disable running bob on this package.',
48+
},
49+
),
2850
);
2951

3052
export type BobConfig = zod.TypeOf<typeof BobConfigModel>;

0 commit comments

Comments
 (0)