forked from lumeland/lume
-
Notifications
You must be signed in to change notification settings - Fork 0
/
core.ts
295 lines (259 loc) Β· 5.67 KB
/
core.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
import type {
DeepPartial,
DenoConfig,
DenoConfigResult,
ImportMap,
} from "./core/utils.ts";
import type {
ComponentsOptions,
default as Site,
ServerOptions,
SiteEvent,
SiteEventType,
SiteOptions,
WatcherOptions,
} from "./core/site.ts";
import type {
default as Events,
Event,
EventListener,
EventOptions,
} from "./core/events.ts";
import type {
default as Scripts,
ScriptOptions,
ScriptOrFunction,
} from "./core/scripts.ts";
import type {
default as Reader,
DirEntry,
FileInfo,
Loader,
} from "./core/reader.ts";
import type Logger from "./core/logger.ts";
import type PagePreparer from "./core/page_preparer.ts";
import type Writer from "./core/writer.ts";
import type IncludesLoader from "./core/includes_loader.ts";
import type { default as PageLoader } from "./core/page_loader.ts";
import type DataLoader from "./core/data_loader.ts";
import type {
Component,
default as ComponentLoader,
} from "./core/component_loader.ts";
import type {
Components,
Content,
Data,
Dest,
Directory,
Page,
Src,
StaticFile,
} from "./core/filesystem.ts";
import type {
ComponentFunction,
default as Source,
ProxyComponents,
} from "./core/source.ts";
import type {
default as Renderer,
Engine,
Helper,
HelperOptions,
} from "./core/renderer.ts";
import type {
default as Processors,
Extensions,
MultiProcessor,
Processor,
} from "./core/processors.ts";
import type { default as Scopes, ScopeFilter } from "./core/scopes.ts";
import type { ErrorData, Exception } from "./core/errors.ts";
import type { default as Formats, Format } from "./core/formats.ts";
import type {
default as Server,
Middleware,
RequestHandler,
ServerEvent,
ServerEventType,
} from "./core/server.ts";
import type {
default as Watcher,
WatchEvent,
WatchEventType,
} from "./core/watcher.ts";
// Plugins types
import type { PaginationInfo, Paginator } from "./plugins/paginate.ts";
import type { Transformation } from "./plugins/imagick.ts";
import type { MetaData } from "./plugins/metas.ts";
import type { Search } from "./plugins/search.ts";
import type { Children } from "./plugins/jsx.ts";
import type { SourceMap } from "./plugins/source_maps.ts";
/** The method that installs a plugin */
type PluginSetup = (options: unknown) => Plugin;
/** A generic Lume plugin */
type Plugin = (site: Site) => void;
export type {
Component,
ComponentFunction,
ComponentLoader,
Components,
ComponentsOptions,
Content,
Data,
DataLoader,
DeepPartial,
DenoConfig,
DenoConfigResult,
Dest,
Directory,
DirEntry,
Engine,
ErrorData,
Event,
EventListener,
EventOptions,
Events,
Exception,
Extensions,
FileInfo,
Format,
Formats,
Helper,
HelperOptions,
ImportMap,
IncludesLoader,
Loader,
Logger,
Middleware,
MultiProcessor,
Page,
PageLoader,
PagePreparer,
Plugin,
PluginSetup,
Processor,
Processors,
ProxyComponents,
Reader,
Renderer,
RequestHandler,
ScopeFilter,
Scopes,
ScriptOptions,
ScriptOrFunction,
Scripts,
Server,
ServerEvent,
ServerEventType,
ServerOptions,
Site,
SiteEvent,
SiteEventType,
SiteOptions,
Source,
SourceMap,
Src,
StaticFile,
Watcher,
WatcherOptions,
WatchEvent,
WatchEventType,
Writer,
};
export interface PageData extends Data {
/** The language(s) of the page */
lang?: string | string[];
/** The title of the page */
title?: string;
/** The page url */
url: string | false;
/** The page reference */
page: Page;
/**
* The available components
* @see https://lume.land/docs/core/components/
*/
// deno-lint-ignore no-explicit-any
comp?: any;
/**
* The paginator helper
* @see https://lume.land/plugins/paginate/
*/
paginate: Paginator;
/**
* The pagination info
* @see https://lume.land/plugins/paginate/
*/
pagination?: PaginationInfo;
/**
* The pagination result
* @see https://lume.land/plugins/paginate/
*/
results?: Page[];
/**
* Image transformations
* @see https://lume.land/plugins/imagick/
*/
imagick?: Transformation | Transformation[];
/**
* Meta elements
* @see https://lume.land/plugins/metas/
*/
metas?: MetaData;
/**
* Netlify CMS configuration
* @see https://lume.land/plugins/netlify_cms/
*/
netlify_cms?: Record<string, unknown>;
/**
* The searcher helper
* @see https://lume.land/plugins/search/
*/
search: Search;
/**
* The source map data (if it's an asset)
*/
sourceMap?: SourceMap;
/**
* Alternate pages (for languages)
*/
alternates?: PageData[];
/**
* The JSX children elements
* @see https://lume.land/plugins/jsx/
*/
children?: Children;
}
export interface PageHelpers {
/** @see https://lume.land/plugins/attributes/ */
attr: Helper;
/** @see https://lume.land/plugins/attributes/ */
class: Helper;
/** @see https://lume.land/plugins/date/ */
date: Helper;
/** @see https://lume.land/plugins/liquid/ */
liquid: Helper;
/** @see https://lume.land/plugins/markdown/ */
md: Helper;
/** @see https://lume.land/plugins/nunjucks/ */
njk: Helper;
/** @see https://lume.land/plugins/postcss/ */
postcss: Helper;
/** @see https://lume.land/plugins/pug/ */
pug: Helper;
/** @see https://lume.land/plugins/slugify_urls/ */
slugify: Helper;
/** @see https://lume.land/plugins/terser/#the-terser-filter */
terser: Helper;
/** @see https://lume.land/plugins/url/#url-filter */
url: Helper;
/** @see https://lume.land/plugins/url/#htmlurl-filter */
htmlUrl: Helper;
[key: string]: Helper | undefined;
}
/** Definition used to create a new Page */
export interface Archetype {
path: string;
content: string | Record<string, unknown> | Uint8Array;
}