@tobi-or-not/docpress 0.2.2 → 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.
Files changed (16) hide show
  1. package/README.md +20 -204
  2. package/dist/cli.js +390 -268
  3. package/dist/cli.js.map +1 -1
  4. package/package.json +17 -14
  5. package/types/commands/fetch.d.ts +2 -2
  6. package/types/lib/fetch.d.ts +2 -1
  7. package/types/lib/git.d.ts +299 -3
  8. package/types/lib/prepare.d.ts +8 -1
  9. package/types/schemas/build.d.ts +19 -2
  10. package/types/schemas/fetch.d.ts +43 -12
  11. package/types/schemas/global.d.ts +128 -42
  12. package/types/schemas/prepare.d.ts +51 -8
  13. package/types/templates/theme/index.d.ts +8 -0
  14. package/types/utils/commands.d.ts +166 -42
  15. package/types/utils/const.d.ts +4 -0
  16. package/types/utils/functions.d.ts +3 -0
package/types/schemas/prepare.d.ts CHANGED
@@ -1,18 +1,61 @@
1
- import { z } from 'zod';
2
- export declare const prepareOptsSchema: z.ZodObject<{
3
- extraHeaderPages: z.ZodOptional<z.ZodEffects<z.ZodString, string[], string>>;
4
- extraPublicContent: z.ZodOptional<z.ZodEffects<z.ZodString, string[], string>>;
5
- extraTheme: z.ZodOptional<z.ZodEffects<z.ZodString, string[], string>>;
6
- vitepressConfig: z.ZodOptional<z.ZodEffects<z.ZodString, import("vitepress").UserConfig<import("vitepress").DefaultTheme.Config>, string>>;
7
- }, "strip", z.ZodTypeAny, {
1
+ export declare const prepareOptsSchema: import("zod").ZodEffects<import("zod").ZodObject<Pick<import("zod").objectUtil.extendShape<{
2
+ username: import("zod").ZodOptional<import("zod").ZodString>;
3
+ branch: import("zod").ZodOptional<import("zod").ZodDefault<import("zod").ZodString>>;
4
+ gitProvider: import("zod").ZodOptional<import("zod").ZodDefault<import("zod").ZodEnum<["github"]>>>;
5
+ reposFilter: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodString, "many">>;
6
+ extraHeaderPages: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodString, "many">>;
7
+ extraPublicContent: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodString, "many">>;
8
+ extraTheme: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodString, "many">>;
9
+ forks: import("zod").ZodOptional<import("zod").ZodDefault<import("zod").ZodBoolean>>;
10
+ vitepressConfig: import("zod").ZodOptional<import("zod").ZodAny>;
11
+ }, {
12
+ config: import("zod").ZodOptional<import("zod").ZodString>;
13
+ token: import("zod").ZodOptional<import("zod").ZodString>;
14
+ reposFilter: import("zod").ZodOptional<import("zod").ZodEffects<import("zod").ZodString, string[], string>>;
15
+ extraHeaderPages: import("zod").ZodOptional<import("zod").ZodEffects<import("zod").ZodString, string[], string>>;
16
+ extraPublicContent: import("zod").ZodOptional<import("zod").ZodEffects<import("zod").ZodString, string[], string>>;
17
+ extraTheme: import("zod").ZodOptional<import("zod").ZodEffects<import("zod").ZodString, string[], string>>;
18
+ vitepressConfig: import("zod").ZodOptional<import("zod").ZodString>;
19
+ }>, "username" | "gitProvider" | "reposFilter" | "extraHeaderPages" | "extraPublicContent" | "extraTheme" | "vitepressConfig" | "config" | "token">, "strip", import("zod").ZodTypeAny, {
20
+ username?: string | undefined;
21
+ gitProvider?: "github" | undefined;
22
+ reposFilter?: string[] | undefined;
23
+ extraHeaderPages?: string[] | undefined;
24
+ extraPublicContent?: string[] | undefined;
25
+ extraTheme?: string[] | undefined;
26
+ vitepressConfig?: string | undefined;
27
+ config?: string | undefined;
28
+ token?: string | undefined;
29
+ }, {
30
+ username?: string | undefined;
31
+ gitProvider?: "github" | undefined;
32
+ reposFilter?: string | undefined;
33
+ extraHeaderPages?: string | undefined;
34
+ extraPublicContent?: string | undefined;
35
+ extraTheme?: string | undefined;
36
+ vitepressConfig?: string | undefined;
37
+ config?: string | undefined;
38
+ token?: string | undefined;
39
+ }>, {
40
+ token: string | undefined;
41
+ username: string;
42
+ branch?: string | undefined;
43
+ gitProvider?: "github" | undefined;
44
+ reposFilter?: string[] | undefined;
8
45
  extraHeaderPages?: string[] | undefined;
9
46
  extraPublicContent?: string[] | undefined;
10
47
  extraTheme?: string[] | undefined;
11
- vitepressConfig?: import("vitepress").UserConfig<import("vitepress").DefaultTheme.Config> | undefined;
48
+ forks?: boolean | undefined;
49
+ vitepressConfig?: any;
12
50
  }, {
51
+ username?: string | undefined;
52
+ gitProvider?: "github" | undefined;
53
+ reposFilter?: string | undefined;
13
54
  extraHeaderPages?: string | undefined;
14
55
  extraPublicContent?: string | undefined;
15
56
  extraTheme?: string | undefined;
16
57
  vitepressConfig?: string | undefined;
58
+ config?: string | undefined;
59
+ token?: string | undefined;
17
60
  }>;
18
61
  export type PrepareOpts = Zod.infer<typeof prepareOptsSchema>;
package/types/templates/theme/index.d.ts ADDED
@@ -0,0 +1,8 @@
1
+ declare const _default: {
2
+ enhanceApp({ app }: import("vitepress").EnhanceAppContext): void;
3
+ extends: {
4
+ Layout: import("@vue/runtime-core").DefineComponent;
5
+ enhanceApp: (ctx: import("vitepress").EnhanceAppContext) => void;
6
+ };
7
+ };
8
+ export default _default;
package/types/utils/commands.d.ts CHANGED
@@ -11,73 +11,197 @@ interface Options {
11
11
  global: GlobalOpts;
12
12
  }
13
13
  export declare const options: {
14
- build: import("zod").ZodObject<{}, "strip", import("zod").ZodTypeAny, {}, {}>;
15
- fetch: import("zod").ZodObject<{
16
- branch: import("zod").ZodDefault<import("zod").ZodOptional<import("zod").ZodString>>;
17
- gitProvider: import("zod").ZodDefault<import("zod").ZodOptional<import("zod").ZodEnum<["github"]>>>;
18
- reposFilter: import("zod").ZodOptional<import("zod").ZodUnion<[import("zod").ZodEffects<import("zod").ZodString, string[], string>, import("zod").ZodArray<import("zod").ZodString, "many">]>>;
14
+ build: import("zod").ZodObject<Pick<import("zod").objectUtil.extendShape<{
15
+ username: import("zod").ZodOptional<import("zod").ZodString>;
16
+ branch: import("zod").ZodOptional<import("zod").ZodDefault<import("zod").ZodString>>;
17
+ gitProvider: import("zod").ZodOptional<import("zod").ZodDefault<import("zod").ZodEnum<["github"]>>>;
18
+ reposFilter: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodString, "many">>;
19
+ extraHeaderPages: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodString, "many">>;
20
+ extraPublicContent: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodString, "many">>;
21
+ extraTheme: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodString, "many">>;
22
+ forks: import("zod").ZodOptional<import("zod").ZodDefault<import("zod").ZodBoolean>>;
23
+ vitepressConfig: import("zod").ZodOptional<import("zod").ZodAny>;
24
+ }, {
25
+ config: import("zod").ZodOptional<import("zod").ZodString>;
19
26
  token: import("zod").ZodOptional<import("zod").ZodString>;
20
- username: import("zod").ZodString;
21
- }, "strip", import("zod").ZodTypeAny, {
22
- branch: string;
23
- gitProvider: "github";
24
- username: string;
27
+ reposFilter: import("zod").ZodOptional<import("zod").ZodEffects<import("zod").ZodString, string[], string>>;
28
+ extraHeaderPages: import("zod").ZodOptional<import("zod").ZodEffects<import("zod").ZodString, string[], string>>;
29
+ extraPublicContent: import("zod").ZodOptional<import("zod").ZodEffects<import("zod").ZodString, string[], string>>;
30
+ extraTheme: import("zod").ZodOptional<import("zod").ZodEffects<import("zod").ZodString, string[], string>>;
31
+ vitepressConfig: import("zod").ZodOptional<import("zod").ZodString>;
32
+ }>, never>, "strip", import("zod").ZodTypeAny, {}, {}>;
33
+ fetch: import("zod").ZodEffects<import("zod").ZodObject<Pick<import("zod").objectUtil.extendShape<{
34
+ username: import("zod").ZodOptional<import("zod").ZodString>;
35
+ branch: import("zod").ZodOptional<import("zod").ZodDefault<import("zod").ZodString>>;
36
+ gitProvider: import("zod").ZodOptional<import("zod").ZodDefault<import("zod").ZodEnum<["github"]>>>;
37
+ reposFilter: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodString, "many">>;
38
+ extraHeaderPages: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodString, "many">>;
39
+ extraPublicContent: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodString, "many">>;
40
+ extraTheme: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodString, "many">>;
41
+ forks: import("zod").ZodOptional<import("zod").ZodDefault<import("zod").ZodBoolean>>;
42
+ vitepressConfig: import("zod").ZodOptional<import("zod").ZodAny>;
43
+ }, {
44
+ config: import("zod").ZodOptional<import("zod").ZodString>;
45
+ token: import("zod").ZodOptional<import("zod").ZodString>;
46
+ reposFilter: import("zod").ZodOptional<import("zod").ZodEffects<import("zod").ZodString, string[], string>>;
47
+ extraHeaderPages: import("zod").ZodOptional<import("zod").ZodEffects<import("zod").ZodString, string[], string>>;
48
+ extraPublicContent: import("zod").ZodOptional<import("zod").ZodEffects<import("zod").ZodString, string[], string>>;
49
+ extraTheme: import("zod").ZodOptional<import("zod").ZodEffects<import("zod").ZodString, string[], string>>;
50
+ vitepressConfig: import("zod").ZodOptional<import("zod").ZodString>;
51
+ }>, "username" | "branch" | "gitProvider" | "reposFilter" | "config" | "token">, "strip", import("zod").ZodTypeAny, {
52
+ username?: string | undefined;
53
+ branch?: string | undefined;
54
+ gitProvider?: "github" | undefined;
25
55
  reposFilter?: string[] | undefined;
56
+ config?: string | undefined;
26
57
  token?: string | undefined;
27
58
  }, {
59
+ username?: string | undefined;
60
+ branch?: string | undefined;
61
+ gitProvider?: "github" | undefined;
62
+ reposFilter?: string | undefined;
63
+ config?: string | undefined;
64
+ token?: string | undefined;
65
+ }>, {
66
+ token: string | undefined;
28
67
  username: string;
29
68
  branch?: string | undefined;
30
69
  gitProvider?: "github" | undefined;
31
- reposFilter?: string | string[] | undefined;
70
+ reposFilter?: string[] | undefined;
71
+ extraHeaderPages?: string[] | undefined;
72
+ extraPublicContent?: string[] | undefined;
73
+ extraTheme?: string[] | undefined;
74
+ forks?: boolean | undefined;
75
+ vitepressConfig?: any;
76
+ }, {
77
+ username?: string | undefined;
78
+ branch?: string | undefined;
79
+ gitProvider?: "github" | undefined;
80
+ reposFilter?: string | undefined;
81
+ config?: string | undefined;
32
82
  token?: string | undefined;
33
83
  }>;
34
- prepare: import("zod").ZodObject<{
84
+ prepare: import("zod").ZodEffects<import("zod").ZodObject<Pick<import("zod").objectUtil.extendShape<{
85
+ username: import("zod").ZodOptional<import("zod").ZodString>;
86
+ branch: import("zod").ZodOptional<import("zod").ZodDefault<import("zod").ZodString>>;
87
+ gitProvider: import("zod").ZodOptional<import("zod").ZodDefault<import("zod").ZodEnum<["github"]>>>;
88
+ reposFilter: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodString, "many">>;
89
+ extraHeaderPages: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodString, "many">>;
90
+ extraPublicContent: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodString, "many">>;
91
+ extraTheme: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodString, "many">>;
92
+ forks: import("zod").ZodOptional<import("zod").ZodDefault<import("zod").ZodBoolean>>;
93
+ vitepressConfig: import("zod").ZodOptional<import("zod").ZodAny>;
94
+ }, {
95
+ config: import("zod").ZodOptional<import("zod").ZodString>;
96
+ token: import("zod").ZodOptional<import("zod").ZodString>;
97
+ reposFilter: import("zod").ZodOptional<import("zod").ZodEffects<import("zod").ZodString, string[], string>>;
35
98
  extraHeaderPages: import("zod").ZodOptional<import("zod").ZodEffects<import("zod").ZodString, string[], string>>;
36
99
  extraPublicContent: import("zod").ZodOptional<import("zod").ZodEffects<import("zod").ZodString, string[], string>>;
37
100
  extraTheme: import("zod").ZodOptional<import("zod").ZodEffects<import("zod").ZodString, string[], string>>;
38
- vitepressConfig: import("zod").ZodOptional<import("zod").ZodEffects<import("zod").ZodString, import("vitepress").UserConfig<import("vitepress").DefaultTheme.Config>, string>>;
39
- }, "strip", import("zod").ZodTypeAny, {
101
+ vitepressConfig: import("zod").ZodOptional<import("zod").ZodString>;
102
+ }>, "username" | "gitProvider" | "reposFilter" | "extraHeaderPages" | "extraPublicContent" | "extraTheme" | "vitepressConfig" | "config" | "token">, "strip", import("zod").ZodTypeAny, {
103
+ username?: string | undefined;
104
+ gitProvider?: "github" | undefined;
105
+ reposFilter?: string[] | undefined;
106
+ extraHeaderPages?: string[] | undefined;
107
+ extraPublicContent?: string[] | undefined;
108
+ extraTheme?: string[] | undefined;
109
+ vitepressConfig?: string | undefined;
110
+ config?: string | undefined;
111
+ token?: string | undefined;
112
+ }, {
113
+ username?: string | undefined;
114
+ gitProvider?: "github" | undefined;
115
+ reposFilter?: string | undefined;
116
+ extraHeaderPages?: string | undefined;
117
+ extraPublicContent?: string | undefined;
118
+ extraTheme?: string | undefined;
119
+ vitepressConfig?: string | undefined;
120
+ config?: string | undefined;
121
+ token?: string | undefined;
122
+ }>, {
123
+ token: string | undefined;
124
+ username: string;
125
+ branch?: string | undefined;
126
+ gitProvider?: "github" | undefined;
127
+ reposFilter?: string[] | undefined;
40
128
  extraHeaderPages?: string[] | undefined;
41
129
  extraPublicContent?: string[] | undefined;
42
130
  extraTheme?: string[] | undefined;
43
- vitepressConfig?: import("vitepress").UserConfig<import("vitepress").DefaultTheme.Config> | undefined;
131
+ forks?: boolean | undefined;
132
+ vitepressConfig?: any;
44
133
  }, {
134
+ username?: string | undefined;
135
+ gitProvider?: "github" | undefined;
136
+ reposFilter?: string | undefined;
45
137
  extraHeaderPages?: string | undefined;
46
138
  extraPublicContent?: string | undefined;
47
139
  extraTheme?: string | undefined;
48
140
  vitepressConfig?: string | undefined;
141
+ config?: string | undefined;
142
+ token?: string | undefined;
49
143
  }>;
50
- global: import("zod").ZodObject<{
51
- config: import("zod").ZodOptional<import("zod").ZodEffects<import("zod").ZodString, {
52
- branch: string;
53
- gitProvider: "github";
54
- username: string;
55
- reposFilter?: string[] | undefined;
56
- token?: string | undefined;
57
- } & {
58
- extraHeaderPages?: string[] | undefined;
59
- extraPublicContent?: string[] | undefined;
60
- extraTheme?: string[] | undefined;
61
- vitepressConfig?: import("vitepress").UserConfig<import("vitepress").DefaultTheme.Config> | undefined;
62
- }, string>>;
144
+ global: import("zod").ZodEffects<import("zod").ZodObject<{
145
+ username: import("zod").ZodOptional<import("zod").ZodOptional<import("zod").ZodString>>;
146
+ branch: import("zod").ZodOptional<import("zod").ZodOptional<import("zod").ZodDefault<import("zod").ZodString>>>;
147
+ gitProvider: import("zod").ZodOptional<import("zod").ZodOptional<import("zod").ZodDefault<import("zod").ZodEnum<["github"]>>>>;
148
+ forks: import("zod").ZodOptional<import("zod").ZodOptional<import("zod").ZodDefault<import("zod").ZodBoolean>>>;
149
+ config: import("zod").ZodOptional<import("zod").ZodOptional<import("zod").ZodString>>;
150
+ token: import("zod").ZodOptional<import("zod").ZodOptional<import("zod").ZodString>>;
151
+ reposFilter: import("zod").ZodOptional<import("zod").ZodOptional<import("zod").ZodEffects<import("zod").ZodString, string[], string>>>;
152
+ extraHeaderPages: import("zod").ZodOptional<import("zod").ZodOptional<import("zod").ZodEffects<import("zod").ZodString, string[], string>>>;
153
+ extraPublicContent: import("zod").ZodOptional<import("zod").ZodOptional<import("zod").ZodEffects<import("zod").ZodString, string[], string>>>;
154
+ extraTheme: import("zod").ZodOptional<import("zod").ZodOptional<import("zod").ZodEffects<import("zod").ZodString, string[], string>>>;
155
+ vitepressConfig: import("zod").ZodOptional<import("zod").ZodOptional<import("zod").ZodString>>;
63
156
  }, "strip", import("zod").ZodTypeAny, {
64
- config?: ({
65
- branch: string;
66
- gitProvider: "github";
67
- username: string;
68
- reposFilter?: string[] | undefined;
69
- token?: string | undefined;
70
- } & {
71
- extraHeaderPages?: string[] | undefined;
72
- extraPublicContent?: string[] | undefined;
73
- extraTheme?: string[] | undefined;
74
- vitepressConfig?: import("vitepress").UserConfig<import("vitepress").DefaultTheme.Config> | undefined;
75
- }) | undefined;
157
+ username?: string | undefined;
158
+ branch?: string | undefined;
159
+ gitProvider?: "github" | undefined;
160
+ reposFilter?: string[] | undefined;
161
+ extraHeaderPages?: string[] | undefined;
162
+ extraPublicContent?: string[] | undefined;
163
+ extraTheme?: string[] | undefined;
164
+ forks?: boolean | undefined;
165
+ vitepressConfig?: string | undefined;
166
+ config?: string | undefined;
167
+ token?: string | undefined;
168
+ }, {
169
+ username?: string | undefined;
170
+ branch?: string | undefined;
171
+ gitProvider?: "github" | undefined;
172
+ reposFilter?: string | undefined;
173
+ extraHeaderPages?: string | undefined;
174
+ extraPublicContent?: string | undefined;
175
+ extraTheme?: string | undefined;
176
+ forks?: boolean | undefined;
177
+ vitepressConfig?: string | undefined;
178
+ config?: string | undefined;
179
+ token?: string | undefined;
180
+ }>, {
181
+ token: string | undefined;
182
+ username: string;
183
+ branch?: string | undefined;
184
+ gitProvider?: "github" | undefined;
185
+ reposFilter?: string[] | undefined;
186
+ extraHeaderPages?: string[] | undefined;
187
+ extraPublicContent?: string[] | undefined;
188
+ extraTheme?: string[] | undefined;
189
+ forks?: boolean | undefined;
190
+ vitepressConfig?: any;
76
191
  }, {
192
+ username?: string | undefined;
193
+ branch?: string | undefined;
194
+ gitProvider?: "github" | undefined;
195
+ reposFilter?: string | undefined;
196
+ extraHeaderPages?: string | undefined;
197
+ extraPublicContent?: string | undefined;
198
+ extraTheme?: string | undefined;
199
+ forks?: boolean | undefined;
200
+ vitepressConfig?: string | undefined;
77
201
  config?: string | undefined;
202
+ token?: string | undefined;
78
203
  }>;
79
204
  };
80
- type MergeOptions<T extends Cmd[]> = (T extends [infer First, ...infer Rest] ? First extends Cmd ? Rest extends Cmd[] ? Options[First] & MergeOptions<Rest> : Options[First] : never : unknown);
81
- export declare function parseOptions<T extends Cmd[]>(cmds: [...T], opts: MergeOptions<T>): MergeOptions<T>;
205
+ export declare function parseOptions<T extends Cmd>(cmd: T, opts: Options[T]): Options[T];
82
206
  export declare function addOptions(cmd: Command, opts: Option[]): Command;
83
207
  export {};
package/types/utils/const.d.ts CHANGED
@@ -3,4 +3,8 @@ export declare const USER_REPOS_INFOS: string;
3
3
  export declare const USER_INFOS: string;
4
4
  export declare const DOCS_DIR: string;
5
5
  export declare const INDEX_FILE: string;
6
+ export declare const FORKS_FILE: string;
6
7
  export declare const VITEPRESS_CONFIG: string;
8
+ export declare const VITEPRESS_THEME: string;
9
+ export declare const VITEPRESS_USER_THEME: string;
10
+ export declare const TEMPLATE_THEME: string;
package/types/utils/functions.d.ts CHANGED
@@ -18,4 +18,7 @@ export declare function prettifyEnum(arr: readonly string[]): string;
18
18
  export declare function getUserInfos(): Awaited<ReturnType<typeof getInfos>>["user"];
19
19
  export declare function getUserRepos(): EnhancedRepository[];
20
20
  export declare function deepMerge<T extends Record<string, any> | null>(...objects: T[]): T;
21
+ export declare function isObject(val: any): val is object;
22
+ export declare function loadConfigFile(configPath?: string): any;
23
+ export declare function splitByComma(s: string): string[];
21
24
  export {};