docula 0.3.2 → 0.3.3
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/dist/config.d.ts +21 -0
- package/dist/config.d.ts.map +1 -0
- package/dist/config.js +78 -0
- package/dist/config.js.map +1 -0
- package/dist/docula-plugin.d.ts +9 -0
- package/dist/docula-plugin.d.ts.map +1 -0
- package/dist/docula-plugin.js +2 -0
- package/dist/docula-plugin.js.map +1 -0
- package/dist/docula.d.ts +22 -0
- package/dist/docula.d.ts.map +1 -0
- package/dist/docula.js +192 -0
- package/dist/docula.js.map +1 -0
- package/dist/eleventy/filters.d.ts +2 -0
- package/dist/eleventy/filters.d.ts.map +1 -0
- package/dist/eleventy/filters.js +10 -0
- package/dist/eleventy/filters.js.map +1 -0
- package/dist/eleventy/global-data.d.ts +3 -0
- package/dist/eleventy/global-data.d.ts.map +1 -0
- package/dist/eleventy/global-data.js +2 -0
- package/dist/eleventy/global-data.js.map +1 -0
- package/dist/eleventy/shortcodes.d.ts +4 -0
- package/dist/eleventy/shortcodes.d.ts.map +1 -0
- package/dist/eleventy/shortcodes.js +18 -0
- package/dist/eleventy/shortcodes.js.map +1 -0
- package/dist/eleventy.d.ts +24 -0
- package/dist/eleventy.d.ts.map +1 -0
- package/dist/eleventy.js +82 -0
- package/dist/eleventy.js.map +1 -0
- package/dist/index.d.ts +9 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +53 -0
- package/dist/index.js.map +1 -0
- package/dist/logger.d.ts +4 -0
- package/dist/logger.d.ts.map +1 -0
- package/dist/logger.js +20 -0
- package/dist/logger.js.map +1 -0
- package/dist/plugins/algolia.d.ts +21 -0
- package/dist/plugins/algolia.d.ts.map +1 -0
- package/dist/plugins/algolia.js +54 -0
- package/dist/plugins/algolia.js.map +1 -0
- package/dist/plugins/github.d.ts +16 -0
- package/dist/plugins/github.d.ts.map +1 -0
- package/dist/plugins/github.js +68 -0
- package/dist/plugins/github.js.map +1 -0
- package/dist/plugins/index.d.ts +18 -0
- package/dist/plugins/index.d.ts.map +1 -0
- package/dist/plugins/index.js +16 -0
- package/dist/plugins/index.js.map +1 -0
- package/dist/plugins/npm.d.ts +14 -0
- package/dist/plugins/npm.d.ts.map +1 -0
- package/dist/plugins/npm.js +36 -0
- package/dist/plugins/npm.js.map +1 -0
- package/dist/plugins/pagefind.d.ts +10 -0
- package/dist/plugins/pagefind.d.ts.map +1 -0
- package/dist/plugins/pagefind.js +22 -0
- package/dist/plugins/pagefind.js.map +1 -0
- package/dist/plugins/robots.d.ts +14 -0
- package/dist/plugins/robots.d.ts.map +1 -0
- package/dist/plugins/robots.js +34 -0
- package/dist/plugins/robots.js.map +1 -0
- package/dist/plugins/sitemap.d.ts +11 -0
- package/dist/plugins/sitemap.d.ts.map +1 -0
- package/dist/plugins/sitemap.js +27 -0
- package/dist/plugins/sitemap.js.map +1 -0
- package/dist/schemas.d.ts +21 -0
- package/dist/schemas.d.ts.map +1 -0
- package/dist/schemas.js +25 -0
- package/dist/schemas.js.map +1 -0
- package/dist/tools/__mocks__/inquirer-prompt.d.ts +20 -0
- package/dist/tools/__mocks__/inquirer-prompt.d.ts.map +1 -0
- package/dist/tools/__mocks__/inquirer-prompt.js +19 -0
- package/dist/tools/__mocks__/inquirer-prompt.js.map +1 -0
- package/dist/tools/__mocks__/path.d.ts +5 -0
- package/dist/tools/__mocks__/path.d.ts.map +1 -0
- package/dist/tools/__mocks__/path.js +7 -0
- package/dist/tools/__mocks__/path.js.map +1 -0
- package/dist/tools/inquirer-prompt.d.ts +11 -0
- package/dist/tools/inquirer-prompt.d.ts.map +1 -0
- package/dist/tools/inquirer-prompt.js +139 -0
- package/dist/tools/inquirer-prompt.js.map +1 -0
- package/dist/tools/path.d.ts +4 -0
- package/dist/tools/path.d.ts.map +1 -0
- package/dist/tools/path.js +6 -0
- package/dist/tools/path.js.map +1 -0
- package/dist/tools/tools.d.ts +3 -0
- package/dist/tools/tools.d.ts.map +1 -0
- package/dist/tools/tools.js +10 -0
- package/dist/tools/tools.js.map +1 -0
- package/dist/types/config.d.ts +8 -0
- package/dist/types/config.d.ts.map +1 -0
- package/dist/types/config.js +2 -0
- package/dist/types/config.js.map +1 -0
- package/package.json +1 -1
package/dist/config.d.ts
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
import type { PluginConfig, PluginConfigs, PluginName, Plugins } from './types/config.js';
|
|
2
|
+
export declare class Config {
|
|
3
|
+
originPath: string;
|
|
4
|
+
outputPath: string;
|
|
5
|
+
dataPath: string;
|
|
6
|
+
templatePath: string;
|
|
7
|
+
searchEngine: string;
|
|
8
|
+
pluginConfig: PluginConfigs;
|
|
9
|
+
plugins: Plugins;
|
|
10
|
+
imagesPath: string;
|
|
11
|
+
assetsPath: string;
|
|
12
|
+
siteUrl: string;
|
|
13
|
+
siteType: string;
|
|
14
|
+
ajv: any;
|
|
15
|
+
private readonly schema;
|
|
16
|
+
constructor(path?: string);
|
|
17
|
+
loadConfig(path: string): void;
|
|
18
|
+
loadPlugins(name: PluginName, config: PluginConfig): void;
|
|
19
|
+
checkConfigFile(path: string): boolean;
|
|
20
|
+
}
|
|
21
|
+
//# sourceMappingURL=config.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAC,YAAY,EAAE,aAAa,EAAE,UAAU,EAAE,OAAO,EAAC,MAAM,mBAAmB,CAAC;AAGxF,qBAAa,MAAM;IAClB,UAAU,SAAU;IACpB,UAAU,SAAU;IACpB,QAAQ,SAAU;IAClB,YAAY,SAAc;IAC1B,YAAY,SAAc;IAE1B,YAAY,EAAE,aAAa,CAAuB;IAClD,OAAO,EAAE,OAAO,CAAM;IACtB,UAAU,SAAY;IACtB,UAAU,SAAS;IACnB,OAAO,SAAM;IACb,QAAQ,SAAM;IAEd,GAAG,MAAa;IAEhB,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAe;gBAE1B,IAAI,CAAC,EAAE,MAAM;IAczB,UAAU,CAAC,IAAI,EAAE,MAAM;IAwCvB,WAAW,CAAC,IAAI,EAAE,UAAU,EAAE,MAAM,EAAE,YAAY;IAWlD,eAAe,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO;CAGtC"}
|
package/dist/config.js
ADDED
|
@@ -0,0 +1,78 @@
|
|
|
1
|
+
import { existsSync, readFileSync } from 'node:fs';
|
|
2
|
+
import Ajv from 'ajv';
|
|
3
|
+
import { jsonConfigSchema } from './schemas.js';
|
|
4
|
+
import DoculaPlugins from './plugins/index.js';
|
|
5
|
+
export class Config {
|
|
6
|
+
originPath = 'site';
|
|
7
|
+
outputPath = 'dist';
|
|
8
|
+
dataPath = 'data';
|
|
9
|
+
templatePath = 'template';
|
|
10
|
+
searchEngine = 'pagefind';
|
|
11
|
+
// eslint-disable-next-line @typescript-eslint/consistent-type-assertions
|
|
12
|
+
pluginConfig = {};
|
|
13
|
+
plugins = [];
|
|
14
|
+
imagesPath = 'images';
|
|
15
|
+
assetsPath = 'css';
|
|
16
|
+
siteUrl = '';
|
|
17
|
+
siteType = '';
|
|
18
|
+
// @ts-expect-error - ajv is not callable
|
|
19
|
+
ajv = new Ajv();
|
|
20
|
+
schema;
|
|
21
|
+
constructor(path) {
|
|
22
|
+
this.schema = { ...jsonConfigSchema };
|
|
23
|
+
this.schema.required = [];
|
|
24
|
+
const configPath = path ?? `./${this.originPath}/config.json`;
|
|
25
|
+
const configFileExists = this.checkConfigFile(configPath);
|
|
26
|
+
if (configFileExists) {
|
|
27
|
+
this.loadConfig(configPath);
|
|
28
|
+
}
|
|
29
|
+
if (path && !configFileExists) {
|
|
30
|
+
throw new Error('Config file not found');
|
|
31
|
+
}
|
|
32
|
+
}
|
|
33
|
+
loadConfig(path) {
|
|
34
|
+
const data = readFileSync(path, { encoding: 'utf8' });
|
|
35
|
+
const jsonConfig = JSON.parse(data);
|
|
36
|
+
if (jsonConfig.plugins) {
|
|
37
|
+
for (const name of jsonConfig.plugins) {
|
|
38
|
+
this.loadPlugins(name, jsonConfig[name]);
|
|
39
|
+
}
|
|
40
|
+
}
|
|
41
|
+
this.schema.required = [...new Set(this.schema.required)];
|
|
42
|
+
const validate = this.ajv.compile(this.schema);
|
|
43
|
+
validate(jsonConfig);
|
|
44
|
+
if (validate.errors) {
|
|
45
|
+
const [error] = validate.errors;
|
|
46
|
+
// @ts-expect-error - dataPath exist without error"
|
|
47
|
+
const { dataPath, message, keyword, params } = error;
|
|
48
|
+
if (keyword === 'additionalProperties') {
|
|
49
|
+
const { additionalProperty } = params;
|
|
50
|
+
throw new Error(`The config file has an invalid property: ${additionalProperty}`);
|
|
51
|
+
}
|
|
52
|
+
throw new Error(`${dataPath} ${message}`);
|
|
53
|
+
}
|
|
54
|
+
this.originPath = jsonConfig.originPath ?? this.originPath;
|
|
55
|
+
this.outputPath = jsonConfig.outputPath ?? this.outputPath;
|
|
56
|
+
this.dataPath = jsonConfig.dataPath ?? this.dataPath;
|
|
57
|
+
this.templatePath = jsonConfig.templatePath ?? this.templatePath;
|
|
58
|
+
this.searchEngine = jsonConfig.searchEngine ?? this.searchEngine;
|
|
59
|
+
this.imagesPath = jsonConfig.imagesPath ?? this.imagesPath;
|
|
60
|
+
this.assetsPath = jsonConfig.assetsPath ?? this.assetsPath;
|
|
61
|
+
this.plugins = jsonConfig.plugins ?? this.plugins;
|
|
62
|
+
this.siteUrl = jsonConfig.siteUrl ?? this.siteUrl;
|
|
63
|
+
}
|
|
64
|
+
loadPlugins(name, config) {
|
|
65
|
+
if (config) {
|
|
66
|
+
this.pluginConfig[name] = config;
|
|
67
|
+
const pluginSchema = DoculaPlugins[name].schema;
|
|
68
|
+
this.schema.properties[name] = pluginSchema;
|
|
69
|
+
if (pluginSchema.required?.length) {
|
|
70
|
+
this.schema.required.push(name);
|
|
71
|
+
}
|
|
72
|
+
}
|
|
73
|
+
}
|
|
74
|
+
checkConfigFile(path) {
|
|
75
|
+
return existsSync(path);
|
|
76
|
+
}
|
|
77
|
+
}
|
|
78
|
+
//# sourceMappingURL=config.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"config.js","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,UAAU,EAAE,YAAY,EAAC,MAAM,SAAS,CAAC;AACjD,OAAO,GAAG,MAAM,KAAK,CAAC;AACtB,OAAO,EAAoB,gBAAgB,EAAC,MAAM,cAAc,CAAC;AAEjE,OAAO,aAAa,MAAM,oBAAoB,CAAC;AAE/C,MAAM,OAAO,MAAM;IAClB,UAAU,GAAG,MAAM,CAAC;IACpB,UAAU,GAAG,MAAM,CAAC;IACpB,QAAQ,GAAG,MAAM,CAAC;IAClB,YAAY,GAAG,UAAU,CAAC;IAC1B,YAAY,GAAG,UAAU,CAAC;IAC1B,0EAA0E;IAC1E,YAAY,GAAkB,EAAmB,CAAC;IAClD,OAAO,GAAY,EAAE,CAAC;IACtB,UAAU,GAAG,QAAQ,CAAC;IACtB,UAAU,GAAG,KAAK,CAAC;IACnB,OAAO,GAAG,EAAE,CAAC;IACb,QAAQ,GAAG,EAAE,CAAC;IACd,yCAAyC;IACzC,GAAG,GAAG,IAAI,GAAG,EAAE,CAAC;IAEC,MAAM,CAAe;IAEtC,YAAY,IAAa;QACxB,IAAI,CAAC,MAAM,GAAG,EAAC,GAAG,gBAAgB,EAAC,CAAC;QACpC,IAAI,CAAC,MAAM,CAAC,QAAQ,GAAG,EAAE,CAAC;QAC1B,MAAM,UAAU,GAAG,IAAI,IAAI,KAAK,IAAI,CAAC,UAAU,cAAc,CAAC;QAC9D,MAAM,gBAAgB,GAAG,IAAI,CAAC,eAAe,CAAC,UAAU,CAAC,CAAC;QAC1D,IAAI,gBAAgB,EAAE;YACrB,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;SAC5B;QAED,IAAI,IAAI,IAAI,CAAC,gBAAgB,EAAE;YAC9B,MAAM,IAAI,KAAK,CAAC,uBAAuB,CAAC,CAAC;SACzC;IACF,CAAC;IAED,UAAU,CAAC,IAAY;QACtB,MAAM,IAAI,GAAG,YAAY,CAAC,IAAI,EAAE,EAAC,QAAQ,EAAE,MAAM,EAAC,CAAC,CAAC;QACpD,MAAM,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAwB,CAAC;QAE3D,IAAI,UAAU,CAAC,OAAO,EAAE;YACvB,KAAK,MAAM,IAAI,IAAI,UAAU,CAAC,OAAO,EAAE;gBACtC,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC;aACzC;SACD;QAED,IAAI,CAAC,MAAM,CAAC,QAAQ,GAAG,CAAC,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC;QAE1D,MAAM,QAAQ,GAAyB,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAErE,QAAQ,CAAC,UAAU,CAAC,CAAC;QAErB,IAAI,QAAQ,CAAC,MAAM,EAAE;YACpB,MAAM,CAAC,KAAK,CAAC,GAAG,QAAQ,CAAC,MAAM,CAAC;YAChC,mDAAmD;YACnD,MAAM,EAAC,QAAQ,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,EAAC,GAAG,KAAK,CAAC;YACnD,IAAI,OAAO,KAAK,sBAAsB,EAAE;gBACvC,MAAM,EAAC,kBAAkB,EAAC,GAAG,MAAgC,CAAC;gBAC9D,MAAM,IAAI,KAAK,CAAC,4CAA4C,kBAAkB,EAAE,CAAC,CAAC;aAClF;YAED,MAAM,IAAI,KAAK,CAAC,GAAG,QAAkB,IAAI,OAAQ,EAAE,CAAC,CAAC;SACrD;QAED,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC,UAAU,IAAI,IAAI,CAAC,UAAU,CAAC;QAC3D,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC,UAAU,IAAI,IAAI,CAAC,UAAU,CAAC;QAC3D,IAAI,CAAC,QAAQ,GAAG,UAAU,CAAC,QAAQ,IAAI,IAAI,CAAC,QAAQ,CAAC;QACrD,IAAI,CAAC,YAAY,GAAG,UAAU,CAAC,YAAY,IAAI,IAAI,CAAC,YAAY,CAAC;QACjE,IAAI,CAAC,YAAY,GAAG,UAAU,CAAC,YAAY,IAAI,IAAI,CAAC,YAAY,CAAC;QAEjE,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC,UAAU,IAAI,IAAI,CAAC,UAAU,CAAC;QAC3D,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC,UAAU,IAAI,IAAI,CAAC,UAAU,CAAC;QAC3D,IAAI,CAAC,OAAO,GAAG,UAAU,CAAC,OAAO,IAAI,IAAI,CAAC,OAAO,CAAC;QAClD,IAAI,CAAC,OAAO,GAAG,UAAU,CAAC,OAAO,IAAI,IAAI,CAAC,OAAO,CAAC;IACnD,CAAC;IAED,WAAW,CAAC,IAAgB,EAAE,MAAoB;QACjD,IAAI,MAAM,EAAE;YACX,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC;YACjC,MAAM,YAAY,GAAG,aAAa,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC;YAChD,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,GAAG,YAAY,CAAC;YAC5C,IAAI,YAAY,CAAC,QAAQ,EAAE,MAAM,EAAE;gBAClC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;aAChC;SACD;IACF,CAAC;IAED,eAAe,CAAC,IAAY;QAC3B,OAAO,UAAU,CAAC,IAAI,CAAC,CAAC;IACzB,CAAC;CACD"}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
export type Runtime = 'before' | 'after';
|
|
2
|
+
export type Options = Record<string, string>;
|
|
3
|
+
export type Schema = Record<string, any>;
|
|
4
|
+
export type DoculaPlugin = {
|
|
5
|
+
options: Record<string, string>;
|
|
6
|
+
runtime: Runtime;
|
|
7
|
+
execute(): Promise<void>;
|
|
8
|
+
};
|
|
9
|
+
//# sourceMappingURL=docula-plugin.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"docula-plugin.d.ts","sourceRoot":"","sources":["../src/docula-plugin.ts"],"names":[],"mappings":"AACA,MAAM,MAAM,OAAO,GAAG,QAAQ,GAAG,OAAO,CAAC;AACzC,MAAM,MAAM,OAAO,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AAC7C,MAAM,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;AAEzC,MAAM,MAAM,YAAY,GAAG;IAC1B,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAChC,OAAO,EAAE,OAAO,CAAC;IACjB,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;CACzB,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"docula-plugin.js","sourceRoot":"","sources":["../src/docula-plugin.ts"],"names":[],"mappings":""}
|
package/dist/docula.d.ts
ADDED
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
import { Config } from './config.js';
|
|
2
|
+
import type { CommanderOptions } from './index.js';
|
|
3
|
+
export declare class Docula {
|
|
4
|
+
readonly config: Config;
|
|
5
|
+
private readonly eleventy;
|
|
6
|
+
private pluginInstances;
|
|
7
|
+
private readonly beforePlugins;
|
|
8
|
+
private readonly afterPlugins;
|
|
9
|
+
private readonly landingFilesExceptions;
|
|
10
|
+
constructor(options?: CommanderOptions);
|
|
11
|
+
init(sitePath?: string): Promise<void>;
|
|
12
|
+
build(): Promise<void>;
|
|
13
|
+
serve(): Promise<void>;
|
|
14
|
+
copyLandingFolder(source: string, target: string): void;
|
|
15
|
+
copyFolder(source: string, target: string): void;
|
|
16
|
+
copySearchEngineFiles(): void;
|
|
17
|
+
writeConfigFile(sitePath?: string): Promise<Record<string, unknown>>;
|
|
18
|
+
validateFilePath(source: string, target: string): Record<string, any>;
|
|
19
|
+
private loadPlugins;
|
|
20
|
+
private readonly executePlugins;
|
|
21
|
+
}
|
|
22
|
+
//# sourceMappingURL=docula.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"docula.d.ts","sourceRoot":"","sources":["../src/docula.ts"],"names":[],"mappings":"AAKA,OAAO,EAAC,MAAM,EAAC,MAAM,aAAa,CAAC;AAMnC,OAAO,KAAK,EAAC,gBAAgB,EAAC,MAAM,YAAY,CAAC;AAEjD,qBAAa,MAAM;IAClB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAW;IACpC,OAAO,CAAC,eAAe,CAAuB;IAE9C,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAwB;IACtD,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAwB;IACrD,OAAO,CAAC,QAAQ,CAAC,sBAAsB,CAAyE;gBAEpG,OAAO,CAAC,EAAE,gBAAgB;IASzB,IAAI,CAAC,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAetC,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAYtB,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAc5B,iBAAiB,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,IAAI;IA4BvD,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,IAAI;IA4BvD,qBAAqB,IAAI,IAAI;IAsCvB,eAAe,CAAC,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAuB1E,gBAAgB,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;IAiBrE,OAAO,CAAC,WAAW;IAkBnB,OAAO,CAAC,QAAQ,CAAC,cAAc,CAE7B;CACF"}
|
package/dist/docula.js
ADDED
|
@@ -0,0 +1,192 @@
|
|
|
1
|
+
import * as path from 'node:path';
|
|
2
|
+
import process from 'node:process';
|
|
3
|
+
import fs from 'fs-extra';
|
|
4
|
+
import express from 'express';
|
|
5
|
+
import { Eleventy } from './eleventy.js';
|
|
6
|
+
import { Config } from './config.js';
|
|
7
|
+
import { setPlugins } from './tools/inquirer-prompt.js';
|
|
8
|
+
import DoculaPlugins from './plugins/index.js';
|
|
9
|
+
import { getConfigPath, getFileName, getSitePath } from './tools/path.js';
|
|
10
|
+
import logger from './logger.js';
|
|
11
|
+
export class Docula {
|
|
12
|
+
config;
|
|
13
|
+
eleventy;
|
|
14
|
+
pluginInstances = {};
|
|
15
|
+
beforePlugins = [];
|
|
16
|
+
afterPlugins = [];
|
|
17
|
+
landingFilesExceptions = ['search-index.md', 'versions.njk', 'index.njk', 'doc.njk'];
|
|
18
|
+
constructor(options) {
|
|
19
|
+
const parameters = options?.opts();
|
|
20
|
+
const defaultConfigPath = getConfigPath();
|
|
21
|
+
const configPath = parameters ? parameters?.config : defaultConfigPath;
|
|
22
|
+
this.config = new Config(configPath);
|
|
23
|
+
this.eleventy = new Eleventy(this.config);
|
|
24
|
+
this.loadPlugins();
|
|
25
|
+
}
|
|
26
|
+
async init(sitePath) {
|
|
27
|
+
const config = await this.writeConfigFile(sitePath);
|
|
28
|
+
const { originPath } = this.config;
|
|
29
|
+
const rootSitePath = path.join(process.cwd(), sitePath ?? originPath);
|
|
30
|
+
if (config.siteType === 'multi page') {
|
|
31
|
+
this.copyFolder('init', rootSitePath);
|
|
32
|
+
this.copySearchEngineFiles();
|
|
33
|
+
}
|
|
34
|
+
if (config.siteType === 'landing') {
|
|
35
|
+
this.copyLandingFolder('init', rootSitePath);
|
|
36
|
+
}
|
|
37
|
+
}
|
|
38
|
+
async build() {
|
|
39
|
+
const { originPath } = this.config;
|
|
40
|
+
const userOriginPath = `${process.cwd()}/${originPath}`;
|
|
41
|
+
if (!fs.existsSync(userOriginPath)) {
|
|
42
|
+
throw new Error(`The origin path "${userOriginPath}" does not exist.`);
|
|
43
|
+
}
|
|
44
|
+
await this.executePlugins(this.beforePlugins);
|
|
45
|
+
await this.eleventy.build();
|
|
46
|
+
await this.executePlugins(this.afterPlugins);
|
|
47
|
+
}
|
|
48
|
+
async serve() {
|
|
49
|
+
const { outputPath } = this.config;
|
|
50
|
+
if (!fs.existsSync(outputPath)) {
|
|
51
|
+
throw new Error(`The origin path "${outputPath}" does not exist.`);
|
|
52
|
+
}
|
|
53
|
+
const app = express();
|
|
54
|
+
const port = 8080;
|
|
55
|
+
app.use(express.static(outputPath));
|
|
56
|
+
app.listen(port, () => {
|
|
57
|
+
logger.info(`Docula is running on http://localhost:${port}`);
|
|
58
|
+
});
|
|
59
|
+
}
|
|
60
|
+
copyLandingFolder(source, target) {
|
|
61
|
+
const { sourcePath, targetExists, isDirectory } = this.validateFilePath(source, target);
|
|
62
|
+
if (isDirectory) {
|
|
63
|
+
const regex = /(search|docs|multipage)+/gi;
|
|
64
|
+
if (regex.test(source)) {
|
|
65
|
+
return;
|
|
66
|
+
}
|
|
67
|
+
if (!targetExists) {
|
|
68
|
+
fs.mkdirSync(target);
|
|
69
|
+
}
|
|
70
|
+
for (const file of fs.readdirSync(sourcePath)) {
|
|
71
|
+
if (!fs.existsSync(path.join(target, file))) {
|
|
72
|
+
this.copyLandingFolder(path.join(source, file), path.join(target, file));
|
|
73
|
+
}
|
|
74
|
+
}
|
|
75
|
+
}
|
|
76
|
+
else if (!fs.existsSync(target)) {
|
|
77
|
+
const isExcepted = this.landingFilesExceptions.some(file => source.includes(file));
|
|
78
|
+
if (isExcepted) {
|
|
79
|
+
return;
|
|
80
|
+
}
|
|
81
|
+
fs.copyFileSync(sourcePath, target);
|
|
82
|
+
}
|
|
83
|
+
}
|
|
84
|
+
copyFolder(source, target) {
|
|
85
|
+
const { sourcePath, targetExists, isDirectory } = this.validateFilePath(source, target);
|
|
86
|
+
if (isDirectory) {
|
|
87
|
+
// Exclude the search folder
|
|
88
|
+
if (source.includes('search') || source.includes('landing')) {
|
|
89
|
+
return;
|
|
90
|
+
}
|
|
91
|
+
if (!targetExists) {
|
|
92
|
+
fs.mkdirSync(target);
|
|
93
|
+
}
|
|
94
|
+
for (const file of fs.readdirSync(sourcePath)) {
|
|
95
|
+
if (!fs.existsSync(path.join(target, file))) {
|
|
96
|
+
this.copyFolder(path.join(source, file), path.join(target, file));
|
|
97
|
+
}
|
|
98
|
+
}
|
|
99
|
+
}
|
|
100
|
+
else if (!fs.existsSync(target)) {
|
|
101
|
+
// Exclude the search-index file
|
|
102
|
+
if (source.includes('search-index.md') || source.includes('releases')) {
|
|
103
|
+
return;
|
|
104
|
+
}
|
|
105
|
+
fs.copyFileSync(sourcePath, target);
|
|
106
|
+
}
|
|
107
|
+
}
|
|
108
|
+
copySearchEngineFiles() {
|
|
109
|
+
const { searchEngine, originPath } = this.config;
|
|
110
|
+
const __filename = getFileName();
|
|
111
|
+
const doculaPath = path.dirname(path.dirname(path.dirname(__filename)));
|
|
112
|
+
const sourcePath = path.join(doculaPath, `init/_includes/search/${searchEngine}.njk`);
|
|
113
|
+
const searchPath = path.join(process.cwd(), `${originPath}/_includes/search`);
|
|
114
|
+
const targetPath = path.join(process.cwd(), `${originPath}/_includes/search/${searchEngine}.njk`);
|
|
115
|
+
const searchStylesPath = path.join(process.cwd(), `${originPath}/_includes/assets/css/styles/search`);
|
|
116
|
+
const sourceSearchStylesPath = path.join(doculaPath, `init/_includes/assets/css/styles/search/${searchEngine}.css`);
|
|
117
|
+
const searchStylesTargetPath = path.join(process.cwd(), `${originPath}/_includes/assets/css/styles/search/${searchEngine}.css`);
|
|
118
|
+
if (!fs.existsSync(searchPath)) {
|
|
119
|
+
fs.mkdirSync(searchPath);
|
|
120
|
+
}
|
|
121
|
+
if (!fs.existsSync(targetPath)) {
|
|
122
|
+
fs.copyFileSync(sourcePath, targetPath);
|
|
123
|
+
}
|
|
124
|
+
// Copy search styles
|
|
125
|
+
if (!fs.existsSync(searchStylesPath)) {
|
|
126
|
+
fs.mkdirSync(searchStylesPath);
|
|
127
|
+
}
|
|
128
|
+
if (!fs.existsSync(searchStylesTargetPath)) {
|
|
129
|
+
fs.copyFileSync(sourceSearchStylesPath, searchStylesTargetPath);
|
|
130
|
+
}
|
|
131
|
+
if (searchEngine === 'algolia') {
|
|
132
|
+
const indexSource = path.join(doculaPath, 'init/search-index.md');
|
|
133
|
+
const indexTarget = path.join(process.cwd(), `${originPath}/search-index.md`);
|
|
134
|
+
if (!fs.existsSync(indexTarget)) {
|
|
135
|
+
fs.copyFileSync(indexSource, indexTarget);
|
|
136
|
+
}
|
|
137
|
+
}
|
|
138
|
+
}
|
|
139
|
+
async writeConfigFile(sitePath) {
|
|
140
|
+
const plugins = await setPlugins();
|
|
141
|
+
for (const plugin in plugins) {
|
|
142
|
+
if (Object.prototype.hasOwnProperty.call(plugins, plugin)) {
|
|
143
|
+
// @ts-expect-error fix later
|
|
144
|
+
this.config[plugin] = plugins[plugin];
|
|
145
|
+
}
|
|
146
|
+
}
|
|
147
|
+
const originPath = getSitePath();
|
|
148
|
+
const configPath = getConfigPath();
|
|
149
|
+
const rootSitePath = sitePath ? path.join(process.cwd(), sitePath) : originPath;
|
|
150
|
+
// Create the <site> folder
|
|
151
|
+
if (!fs.existsSync(rootSitePath)) {
|
|
152
|
+
fs.mkdirSync(rootSitePath);
|
|
153
|
+
}
|
|
154
|
+
fs.writeFileSync(configPath, JSON.stringify(plugins, null, 2));
|
|
155
|
+
return plugins;
|
|
156
|
+
}
|
|
157
|
+
validateFilePath(source, target) {
|
|
158
|
+
const __filename = getFileName();
|
|
159
|
+
const doculaPath = path.dirname(path.dirname(path.dirname(__filename)));
|
|
160
|
+
const sourcePath = path.join(doculaPath, source);
|
|
161
|
+
const sourceExists = fs.existsSync(sourcePath);
|
|
162
|
+
const targetExists = fs.existsSync(target);
|
|
163
|
+
const sourceStats = fs.statSync(sourcePath);
|
|
164
|
+
const isDirectory = sourceExists && sourceStats.isDirectory();
|
|
165
|
+
return {
|
|
166
|
+
sourcePath,
|
|
167
|
+
sourceExists,
|
|
168
|
+
targetExists,
|
|
169
|
+
isDirectory,
|
|
170
|
+
};
|
|
171
|
+
}
|
|
172
|
+
loadPlugins() {
|
|
173
|
+
const { plugins } = this.config;
|
|
174
|
+
for (const plugin of plugins) {
|
|
175
|
+
const pluginClass = DoculaPlugins[plugin];
|
|
176
|
+
// eslint-disable-next-line new-cap
|
|
177
|
+
const pluginInstance = new pluginClass(this.config);
|
|
178
|
+
this.pluginInstances[plugin] = pluginInstance;
|
|
179
|
+
const { runtime } = pluginInstance;
|
|
180
|
+
if (runtime === 'before') {
|
|
181
|
+
this.beforePlugins.push(pluginInstance);
|
|
182
|
+
}
|
|
183
|
+
else if (runtime === 'after') {
|
|
184
|
+
this.afterPlugins.push(pluginInstance);
|
|
185
|
+
}
|
|
186
|
+
}
|
|
187
|
+
}
|
|
188
|
+
executePlugins = async (plugins) => {
|
|
189
|
+
await Promise.all(plugins.map(async (plugin) => plugin.execute()));
|
|
190
|
+
};
|
|
191
|
+
}
|
|
192
|
+
//# sourceMappingURL=docula.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"docula.js","sourceRoot":"","sources":["../src/docula.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,IAAI,MAAM,WAAW,CAAC;AAClC,OAAO,OAAO,MAAM,cAAc,CAAC;AACnC,OAAO,EAAE,MAAM,UAAU,CAAC;AAC1B,OAAO,OAAO,MAAM,SAAS,CAAC;AAC9B,OAAO,EAAC,QAAQ,EAAC,MAAM,eAAe,CAAC;AACvC,OAAO,EAAC,MAAM,EAAC,MAAM,aAAa,CAAC;AACnC,OAAO,EAAC,UAAU,EAAC,MAAM,4BAA4B,CAAC;AACtD,OAAO,aAAa,MAAM,oBAAoB,CAAC;AAE/C,OAAO,EAAC,aAAa,EAAE,WAAW,EAAE,WAAW,EAAC,MAAM,iBAAiB,CAAC;AACxE,OAAO,MAAM,MAAM,aAAa,CAAC;AAGjC,MAAM,OAAO,MAAM;IACT,MAAM,CAAS;IACP,QAAQ,CAAW;IAC5B,eAAe,GAAoB,EAAE,CAAC;IAE7B,aAAa,GAAqB,EAAE,CAAC;IACrC,YAAY,GAAqB,EAAE,CAAC;IACpC,sBAAsB,GAAa,CAAC,iBAAiB,EAAE,cAAc,EAAE,WAAW,EAAE,SAAS,CAAC,CAAC;IAEhH,YAAY,OAA0B;QACrC,MAAM,UAAU,GAAG,OAAO,EAAE,IAAI,EAAE,CAAC;QACnC,MAAM,iBAAiB,GAAG,aAAa,EAAE,CAAC;QAC1C,MAAM,UAAU,GAAW,UAAU,CAAC,CAAC,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC,CAAC,iBAAiB,CAAC;QAC/E,IAAI,CAAC,MAAM,GAAG,IAAI,MAAM,CAAC,UAAU,CAAC,CAAC;QACrC,IAAI,CAAC,QAAQ,GAAG,IAAI,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAC1C,IAAI,CAAC,WAAW,EAAE,CAAC;IACpB,CAAC;IAEM,KAAK,CAAC,IAAI,CAAC,QAAiB;QAClC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,QAAQ,CAAC,CAAC;QACpD,MAAM,EAAC,UAAU,EAAC,GAAG,IAAI,CAAC,MAAM,CAAC;QACjC,MAAM,YAAY,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,QAAQ,IAAI,UAAU,CAAC,CAAC;QAEtE,IAAI,MAAM,CAAC,QAAQ,KAAK,YAAY,EAAE;YACrC,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;YACtC,IAAI,CAAC,qBAAqB,EAAE,CAAC;SAC7B;QAED,IAAI,MAAM,CAAC,QAAQ,KAAK,SAAS,EAAE;YAClC,IAAI,CAAC,iBAAiB,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;SAC7C;IACF,CAAC;IAEM,KAAK,CAAC,KAAK;QACjB,MAAM,EAAC,UAAU,EAAC,GAAG,IAAI,CAAC,MAAM,CAAC;QACjC,MAAM,cAAc,GAAG,GAAG,OAAO,CAAC,GAAG,EAAE,IAAI,UAAU,EAAE,CAAC;QACxD,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,cAAc,CAAC,EAAE;YACnC,MAAM,IAAI,KAAK,CAAC,oBAAoB,cAAc,mBAAmB,CAAC,CAAC;SACvE;QAED,MAAM,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QAC9C,MAAM,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC;QAC5B,MAAM,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;IAC9C,CAAC;IAEM,KAAK,CAAC,KAAK;QACjB,MAAM,EAAC,UAAU,EAAC,GAAG,IAAI,CAAC,MAAM,CAAC;QACjC,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,UAAU,CAAC,EAAE;YAC/B,MAAM,IAAI,KAAK,CAAC,oBAAoB,UAAU,mBAAmB,CAAC,CAAC;SACnE;QAED,MAAM,GAAG,GAAG,OAAO,EAAE,CAAC;QACtB,MAAM,IAAI,GAAG,IAAI,CAAC;QAClB,GAAG,CAAC,GAAG,CAAC,OAAO,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC;QACpC,GAAG,CAAC,MAAM,CAAC,IAAI,EAAE,GAAG,EAAE;YACrB,MAAM,CAAC,IAAI,CAAC,yCAAyC,IAAI,EAAE,CAAC,CAAC;QAC9D,CAAC,CAAC,CAAC;IACJ,CAAC;IAEM,iBAAiB,CAAC,MAAc,EAAE,MAAc;QACtD,MAAM,EAAC,UAAU,EAAE,YAAY,EAAE,WAAW,EAAC,GAAG,IAAI,CAAC,gBAAgB,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QAEtF,IAAI,WAAW,EAAE;YAChB,MAAM,KAAK,GAAG,4BAA4B,CAAC;YAC3C,IAAI,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE;gBACvB,OAAO;aACP;YAED,IAAI,CAAC,YAAY,EAAE;gBAClB,EAAE,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;aACrB;YAED,KAAK,MAAM,IAAI,IAAI,EAAE,CAAC,WAAW,CAAC,UAAU,CAAC,EAAE;gBAC9C,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,EAAE;oBAC5C,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC;iBACzE;aACD;SACD;aAAM,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE;YAClC,MAAM,UAAU,GAAG,IAAI,CAAC,sBAAsB,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC;YACnF,IAAI,UAAU,EAAE;gBACf,OAAO;aACP;YAED,EAAE,CAAC,YAAY,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC;SACpC;IACF,CAAC;IAEM,UAAU,CAAC,MAAc,EAAE,MAAc;QAC/C,MAAM,EAAC,UAAU,EAAE,YAAY,EAAE,WAAW,EAAC,GAAG,IAAI,CAAC,gBAAgB,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QAEtF,IAAI,WAAW,EAAE;YAChB,4BAA4B;YAC5B,IAAI,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,MAAM,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE;gBAC5D,OAAO;aACP;YAED,IAAI,CAAC,YAAY,EAAE;gBAClB,EAAE,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;aACrB;YAED,KAAK,MAAM,IAAI,IAAI,EAAE,CAAC,WAAW,CAAC,UAAU,CAAC,EAAE;gBAC9C,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,EAAE;oBAC5C,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC;iBAClE;aACD;SACD;aAAM,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE;YAClC,gCAAgC;YAChC,IAAI,MAAM,CAAC,QAAQ,CAAC,iBAAiB,CAAC,IAAI,MAAM,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE;gBACtE,OAAO;aACP;YAED,EAAE,CAAC,YAAY,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC;SACpC;IACF,CAAC;IAED,qBAAqB;QACpB,MAAM,EAAC,YAAY,EAAE,UAAU,EAAC,GAAG,IAAI,CAAC,MAAM,CAAC;QAC/C,MAAM,UAAU,GAAG,WAAW,EAAE,CAAC;QACjC,MAAM,UAAU,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;QACxE,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,yBAAyB,YAAY,MAAM,CAAC,CAAC;QACtF,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,GAAG,UAAU,mBAAmB,CAAC,CAAC;QAC9E,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,GAAG,UAAU,qBAAqB,YAAY,MAAM,CAAC,CAAC;QAClG,MAAM,gBAAgB,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,GAAG,UAAU,qCAAqC,CAAC,CAAC;QACtG,MAAM,sBAAsB,GAAG,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,2CAA2C,YAAY,MAAM,CAAC,CAAC;QACpH,MAAM,sBAAsB,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,GAAG,UAAU,uCAAuC,YAAY,MAAM,CAAC,CAAC;QAEhI,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,UAAU,CAAC,EAAE;YAC/B,EAAE,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;SACzB;QAED,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,UAAU,CAAC,EAAE;YAC/B,EAAE,CAAC,YAAY,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC;SACxC;QAED,qBAAqB;QACrB,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,gBAAgB,CAAC,EAAE;YACrC,EAAE,CAAC,SAAS,CAAC,gBAAgB,CAAC,CAAC;SAC/B;QAED,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,sBAAsB,CAAC,EAAE;YAC3C,EAAE,CAAC,YAAY,CAAC,sBAAsB,EAAE,sBAAsB,CAAC,CAAC;SAChE;QAED,IAAI,YAAY,KAAK,SAAS,EAAE;YAC/B,MAAM,WAAW,GAAG,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,sBAAsB,CAAC,CAAC;YAClE,MAAM,WAAW,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,GAAG,UAAU,kBAAkB,CAAC,CAAC;YAE9E,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,WAAW,CAAC,EAAE;gBAChC,EAAE,CAAC,YAAY,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC;aAC1C;SACD;IACF,CAAC;IAED,KAAK,CAAC,eAAe,CAAC,QAAiB;QACtC,MAAM,OAAO,GAAG,MAAM,UAAU,EAAE,CAAC;QACnC,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE;YAC7B,IAAI,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,OAAO,EAAE,MAAM,CAAC,EAAE;gBAC1D,6BAA6B;gBAC7B,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;aACtC;SACD;QAED,MAAM,UAAU,GAAG,WAAW,EAAE,CAAC;QACjC,MAAM,UAAU,GAAG,aAAa,EAAE,CAAC;QAEnC,MAAM,YAAY,GAAG,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC;QAEhF,2BAA2B;QAC3B,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,YAAY,CAAC,EAAE;YACjC,EAAE,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC;SAC3B;QAED,EAAE,CAAC,aAAa,CAAC,UAAU,EAAE,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;QAC/D,OAAO,OAAO,CAAC;IAChB,CAAC;IAED,gBAAgB,CAAC,MAAc,EAAE,MAAc;QAC9C,MAAM,UAAU,GAAG,WAAW,EAAE,CAAC;QACjC,MAAM,UAAU,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;QACxE,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC;QACjD,MAAM,YAAY,GAAG,EAAE,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;QAC/C,MAAM,YAAY,GAAG,EAAE,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;QAC3C,MAAM,WAAW,GAAG,EAAE,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;QAC5C,MAAM,WAAW,GAAG,YAAY,IAAI,WAAW,CAAC,WAAW,EAAE,CAAC;QAE9D,OAAO;YACN,UAAU;YACV,YAAY;YACZ,YAAY;YACZ,WAAW;SACX,CAAC;IACH,CAAC;IAEO,WAAW;QAClB,MAAM,EAAC,OAAO,EAAC,GAAG,IAAI,CAAC,MAAM,CAAC;QAE9B,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE;YAC7B,MAAM,WAAW,GAAG,aAAa,CAAC,MAAM,CAAC,CAAC;YAC1C,mCAAmC;YACnC,MAAM,cAAc,GAAG,IAAI,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YACpD,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,GAAG,cAAc,CAAC;YAE9C,MAAM,EAAC,OAAO,EAAC,GAAG,cAAc,CAAC;YACjC,IAAI,OAAO,KAAK,QAAQ,EAAE;gBACzB,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;aACxC;iBAAM,IAAI,OAAO,KAAK,OAAO,EAAE;gBAC/B,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;aACvC;SACD;IACF,CAAC;IAEgB,cAAc,GAAG,KAAK,EAAE,OAAyB,EAAiB,EAAE;QACpF,MAAM,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,EAAC,MAAM,EAAC,EAAE,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC;IAClE,CAAC,CAAC;CACF"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"filters.d.ts","sourceRoot":"","sources":["../../src/eleventy/filters.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,cAAc,SAAU,MAAM,KAAG,MAU7C,CAAC"}
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
export const squashCallback = (text) => {
|
|
2
|
+
const content = text.toString().toLowerCase();
|
|
3
|
+
// Remove duplicated words
|
|
4
|
+
const words = content.split(' ');
|
|
5
|
+
const deduped = [...(new Set(words))];
|
|
6
|
+
const dedupedString = deduped.join(' ');
|
|
7
|
+
// Remove repeated spaces
|
|
8
|
+
return dedupedString.replaceAll(/ {2,}/g, ' ');
|
|
9
|
+
};
|
|
10
|
+
//# sourceMappingURL=filters.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"filters.js","sourceRoot":"","sources":["../../src/eleventy/filters.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,IAAY,EAAU,EAAE;IACtD,MAAM,OAAO,GAAG,IAAI,CAAC,QAAQ,EAAE,CAAC,WAAW,EAAE,CAAC;IAE9C,0BAA0B;IAC1B,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACjC,MAAM,OAAO,GAAG,CAAC,GAAG,CAAC,IAAI,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IACtC,MAAM,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAExC,yBAAyB;IACzB,OAAO,aAAa,CAAC,UAAU,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC;AAChD,CAAC,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"global-data.d.ts","sourceRoot":"","sources":["../../src/eleventy/global-data.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,KAAK,MAAM,EAAC,MAAM,cAAc,CAAC;AAEzC,eAAO,MAAM,SAAS,WAAY,MAAM,KAAG,MAAgB,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"global-data.js","sourceRoot":"","sources":["../../src/eleventy/global-data.ts"],"names":[],"mappings":"AAEA,MAAM,CAAC,MAAM,SAAS,GAAG,CAAC,MAAc,EAAU,EAAE,CAAC,MAAM,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"shortcodes.d.ts","sourceRoot":"","sources":["../../src/eleventy/shortcodes.ts"],"names":[],"mappings":"AAGA,eAAO,MAAM,OAAO,QAAO,MAAmD,CAAC;AAE/E,eAAO,MAAM,UAAU,WAAY,MAAM,SAAS,MAAM,KAAG,MAM1D,CAAC;AAEF,eAAO,MAAM,YAAY,YAAa,MAAM,WAO3C,CAAC"}
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
import { DateTime } from 'luxon';
|
|
2
|
+
import MarkdownIt from 'markdown-it';
|
|
3
|
+
export const getYear = () => DateTime.local().toUTC().toFormat('yyyy');
|
|
4
|
+
export const formatDate = (format, date) => {
|
|
5
|
+
if (date) {
|
|
6
|
+
return DateTime.fromISO(date).toUTC().toFormat(format);
|
|
7
|
+
}
|
|
8
|
+
return DateTime.now().toUTC().toFormat(format);
|
|
9
|
+
};
|
|
10
|
+
export const parseRelease = (content) => {
|
|
11
|
+
const md = new MarkdownIt({
|
|
12
|
+
html: true,
|
|
13
|
+
linkify: true,
|
|
14
|
+
typographer: true,
|
|
15
|
+
});
|
|
16
|
+
return md.render(content);
|
|
17
|
+
};
|
|
18
|
+
//# sourceMappingURL=shortcodes.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"shortcodes.js","sourceRoot":"","sources":["../../src/eleventy/shortcodes.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,QAAQ,EAAC,MAAM,OAAO,CAAC;AAC/B,OAAO,UAAU,MAAM,aAAa,CAAC;AAErC,MAAM,CAAC,MAAM,OAAO,GAAG,GAAW,EAAE,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC,KAAK,EAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;AAE/E,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,MAAc,EAAE,IAAa,EAAU,EAAE;IACnE,IAAI,IAAI,EAAE;QACT,OAAO,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;KACvD;IAED,OAAO,QAAQ,CAAC,GAAG,EAAE,CAAC,KAAK,EAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;AAChD,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,OAAe,EAAE,EAAE;IAC/C,MAAM,EAAE,GAAG,IAAI,UAAU,CAAC;QACzB,IAAI,EAAE,IAAI;QACV,OAAO,EAAE,IAAI;QACb,WAAW,EAAE,IAAI;KACjB,CAAC,CAAC;IACH,OAAO,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;AAC3B,CAAC,CAAC"}
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
import type { Config } from './config.js';
|
|
2
|
+
type ElevJSONOutput = {
|
|
3
|
+
url: string;
|
|
4
|
+
inputPath: string;
|
|
5
|
+
outputPath: string;
|
|
6
|
+
content: string;
|
|
7
|
+
};
|
|
8
|
+
export declare class Eleventy {
|
|
9
|
+
private readonly _config;
|
|
10
|
+
private readonly eleventyConfig;
|
|
11
|
+
private readonly eleventy;
|
|
12
|
+
get config(): Config;
|
|
13
|
+
constructor(config: Config);
|
|
14
|
+
build(): Promise<void>;
|
|
15
|
+
toJSON(): Promise<ElevJSONOutput[]>;
|
|
16
|
+
private addPassthroughCopy;
|
|
17
|
+
private setLibrary;
|
|
18
|
+
private addPlugin;
|
|
19
|
+
private addShortcode;
|
|
20
|
+
private addFilter;
|
|
21
|
+
private addGlobalData;
|
|
22
|
+
}
|
|
23
|
+
export {};
|
|
24
|
+
//# sourceMappingURL=eleventy.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"eleventy.d.ts","sourceRoot":"","sources":["../src/eleventy.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EAAC,MAAM,EAAC,MAAM,aAAa,CAAC;AAgCxC,KAAK,cAAc,GAAG;IACrB,GAAG,EAAE,MAAM,CAAC;IACZ,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;IACnB,OAAO,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,qBAAa,QAAQ;IACpB,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAS;IACjC,OAAO,CAAC,QAAQ,CAAC,cAAc,CAA2J;IAC1L,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAgB;IACzC,IAAI,MAAM,IAAI,MAAM,CAEnB;gBAEW,MAAM,EAAE,MAAM;IA2Bb,KAAK;IASL,MAAM;IAKnB,OAAO,CAAC,kBAAkB;IAK1B,OAAO,CAAC,UAAU;IAOlB,OAAO,CAAC,SAAS;IAOjB,OAAO,CAAC,YAAY;IAMpB,OAAO,CAAC,SAAS;IAIjB,OAAO,CAAC,aAAa;CAIrB"}
|
package/dist/eleventy.js
ADDED
|
@@ -0,0 +1,82 @@
|
|
|
1
|
+
// @ts-expect-error - 11ty doesn't have types
|
|
2
|
+
import * as pkg from '@11ty/eleventy';
|
|
3
|
+
// @ts-expect-error - 11ty doesn't have types
|
|
4
|
+
import eleventyNavigationPlugin from '@11ty/eleventy-navigation';
|
|
5
|
+
// @ts-expect-error - 11ty doesn't have types
|
|
6
|
+
import pluginTOC from 'eleventy-plugin-toc';
|
|
7
|
+
import markdownIt from 'markdown-it';
|
|
8
|
+
import markdownItAnchor from 'markdown-it-anchor';
|
|
9
|
+
import { squashCallback } from './eleventy/filters.js';
|
|
10
|
+
import { getYear, formatDate, parseRelease } from './eleventy/shortcodes.js';
|
|
11
|
+
import { getConfig } from './eleventy/global-data.js';
|
|
12
|
+
// eslint-disable-next-line @typescript-eslint/naming-convention
|
|
13
|
+
const Elev = pkg.default;
|
|
14
|
+
export class Eleventy {
|
|
15
|
+
_config;
|
|
16
|
+
eleventyConfig;
|
|
17
|
+
eleventy;
|
|
18
|
+
get config() {
|
|
19
|
+
return this._config;
|
|
20
|
+
}
|
|
21
|
+
constructor(config) {
|
|
22
|
+
this._config = config;
|
|
23
|
+
this.eleventyConfig = {
|
|
24
|
+
quietMode: true,
|
|
25
|
+
config: (eleventyConfig) => {
|
|
26
|
+
eleventyConfig.ignores.add(`./${this.config.originPath}/README.md`);
|
|
27
|
+
this.addPassthroughCopy(eleventyConfig);
|
|
28
|
+
this.setLibrary(eleventyConfig);
|
|
29
|
+
this.addPlugin(eleventyConfig);
|
|
30
|
+
this.addShortcode(eleventyConfig);
|
|
31
|
+
this.addFilter(eleventyConfig);
|
|
32
|
+
this.addGlobalData(eleventyConfig);
|
|
33
|
+
eleventyConfig.setTemplateFormats(['njk', 'md', 'html']);
|
|
34
|
+
return {
|
|
35
|
+
markdownTemplateEngine: 'njk',
|
|
36
|
+
htmlTemplateEngine: 'njk',
|
|
37
|
+
passthroughFileCopy: true,
|
|
38
|
+
};
|
|
39
|
+
},
|
|
40
|
+
};
|
|
41
|
+
this.eleventy = new Elev(this.config.originPath, this.config.outputPath, this.eleventyConfig);
|
|
42
|
+
}
|
|
43
|
+
async build() {
|
|
44
|
+
try {
|
|
45
|
+
await this.eleventy.write();
|
|
46
|
+
}
|
|
47
|
+
catch (error) {
|
|
48
|
+
throw new Error(`Eleventy build failed: ${error.message}`);
|
|
49
|
+
}
|
|
50
|
+
}
|
|
51
|
+
// eslint-disable-next-line @typescript-eslint/naming-convention
|
|
52
|
+
async toJSON() {
|
|
53
|
+
const json = await this.eleventy.toJSON();
|
|
54
|
+
return json.filter((element) => element.url);
|
|
55
|
+
}
|
|
56
|
+
addPassthroughCopy(eleventyConfig) {
|
|
57
|
+
const assetsPath = `${this.config.originPath}/_includes/assets`;
|
|
58
|
+
eleventyConfig.addPassthroughCopy({ [assetsPath]: '/assets/' });
|
|
59
|
+
}
|
|
60
|
+
setLibrary(eleventyConfig) {
|
|
61
|
+
eleventyConfig.setLibrary('md', markdownIt().use(markdownItAnchor));
|
|
62
|
+
}
|
|
63
|
+
addPlugin(eleventyConfig) {
|
|
64
|
+
eleventyConfig.addPlugin(eleventyNavigationPlugin);
|
|
65
|
+
eleventyConfig.addPlugin(pluginTOC, {
|
|
66
|
+
tags: ['h2'],
|
|
67
|
+
});
|
|
68
|
+
}
|
|
69
|
+
addShortcode(eleventyConfig) {
|
|
70
|
+
eleventyConfig.addShortcode('year', getYear);
|
|
71
|
+
eleventyConfig.addShortcode('formatDate', formatDate);
|
|
72
|
+
eleventyConfig.addShortcode('parseRelease', parseRelease);
|
|
73
|
+
}
|
|
74
|
+
addFilter(eleventyConfig) {
|
|
75
|
+
eleventyConfig.addFilter('squash', squashCallback);
|
|
76
|
+
}
|
|
77
|
+
addGlobalData(eleventyConfig) {
|
|
78
|
+
// EleventyConfig.addGlobalData('algoliaKeys', () => algoliaKeys(this.config));
|
|
79
|
+
eleventyConfig.addGlobalData('config', () => getConfig(this.config));
|
|
80
|
+
}
|
|
81
|
+
}
|
|
82
|
+
//# sourceMappingURL=eleventy.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"eleventy.js","sourceRoot":"","sources":["../src/eleventy.ts"],"names":[],"mappings":"AAAA,6CAA6C;AAC7C,OAAO,KAAK,GAAG,MAAM,gBAAgB,CAAC;AACtC,6CAA6C;AAC7C,OAAO,wBAAwB,MAAM,2BAA2B,CAAC;AACjE,6CAA6C;AAC7C,OAAO,SAAS,MAAM,qBAAqB,CAAC;AAC5C,OAAO,UAAU,MAAM,aAAa,CAAC;AACrC,OAAO,gBAAgB,MAAM,oBAAoB,CAAC;AAElD,OAAO,EAAC,cAAc,EAAC,MAAM,uBAAuB,CAAC;AACrD,OAAO,EAAC,OAAO,EAAE,UAAU,EAAE,YAAY,EAAC,MAAM,0BAA0B,CAAC;AAC3E,OAAO,EAAC,SAAS,EAAC,MAAM,2BAA2B,CAAC;AAEpD,gEAAgE;AAChE,MAAM,IAAI,GAAG,GAAG,CAAC,OAAO,CAAC;AAiCzB,MAAM,OAAO,QAAQ;IACH,OAAO,CAAS;IAChB,cAAc,CAA2J;IACzK,QAAQ,CAAgB;IACzC,IAAI,MAAM;QACT,OAAO,IAAI,CAAC,OAAO,CAAC;IACrB,CAAC;IAED,YAAY,MAAc;QACzB,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;QACtB,IAAI,CAAC,cAAc,GAAG;YACrB,SAAS,EAAE,IAAI;YACf,MAAM,EAAE,CAAC,cAA0B,EAAE,EAAE;gBACtC,cAAc,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,IAAI,CAAC,MAAM,CAAC,UAAU,YAAY,CAAC,CAAC;gBAEpE,IAAI,CAAC,kBAAkB,CAAC,cAAc,CAAC,CAAC;gBACxC,IAAI,CAAC,UAAU,CAAC,cAAc,CAAC,CAAC;gBAChC,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC,CAAC;gBAC/B,IAAI,CAAC,YAAY,CAAC,cAAc,CAAC,CAAC;gBAClC,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC,CAAC;gBAC/B,IAAI,CAAC,aAAa,CAAC,cAAc,CAAC,CAAC;gBAEnC,cAAc,CAAC,kBAAkB,CAAC,CAAC,KAAK,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC;gBAEzD,OAAO;oBACN,sBAAsB,EAAE,KAAK;oBAC7B,kBAAkB,EAAE,KAAK;oBACzB,mBAAmB,EAAE,IAAI;iBACzB,CAAC;YACH,CAAC;SACD,CAAC;QAEF,IAAI,CAAC,QAAQ,GAAG,IAAI,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC;IAC/F,CAAC;IAEM,KAAK,CAAC,KAAK;QACjB,IAAI;YACH,MAAM,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC;SAC5B;QAAC,OAAO,KAAc,EAAE;YACxB,MAAM,IAAI,KAAK,CAAC,0BAA2B,KAAe,CAAC,OAAO,EAAE,CAAC,CAAC;SACtE;IACF,CAAC;IAED,gEAAgE;IACzD,KAAK,CAAC,MAAM;QAClB,MAAM,IAAI,GAAqB,MAAM,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;QAC5D,OAAO,IAAI,CAAC,MAAM,CAAC,CAAC,OAAuB,EAAE,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IAC9D,CAAC;IAEO,kBAAkB,CAAC,cAA0B;QACpD,MAAM,UAAU,GAAG,GAAG,IAAI,CAAC,MAAM,CAAC,UAAU,mBAAmB,CAAC;QAChE,cAAc,CAAC,kBAAkB,CAAC,EAAC,CAAC,UAAU,CAAC,EAAE,UAAU,EAAC,CAAC,CAAC;IAC/D,CAAC;IAEO,UAAU,CAAC,cAA0B;QAC5C,cAAc,CAAC,UAAU,CACxB,IAAI,EACJ,UAAU,EAAE,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAClC,CAAC;IACH,CAAC;IAEO,SAAS,CAAC,cAA0B;QAC3C,cAAc,CAAC,SAAS,CAAC,wBAAwB,CAAC,CAAC;QACnD,cAAc,CAAC,SAAS,CAAC,SAAS,EAAE;YACnC,IAAI,EAAE,CAAC,IAAI,CAAC;SACZ,CAAC,CAAC;IACJ,CAAC;IAEO,YAAY,CAAC,cAA0B;QAC9C,cAAc,CAAC,YAAY,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QAC7C,cAAc,CAAC,YAAY,CAAC,YAAY,EAAE,UAAU,CAAC,CAAC;QACtD,cAAc,CAAC,YAAY,CAAC,cAAc,EAAE,YAAY,CAAC,CAAC;IAC3D,CAAC;IAEO,SAAS,CAAC,cAA0B;QAC3C,cAAc,CAAC,SAAS,CAAC,QAAQ,EAAE,cAAc,CAAC,CAAC;IACpD,CAAC;IAEO,aAAa,CAAC,cAA0B;QAC/C,+EAA+E;QAC/E,cAAc,CAAC,aAAa,CAAC,QAAQ,EAAE,GAAG,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;IACtE,CAAC;CACD"}
|
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
/// <reference types="node" resolution-mode="require"/>
|
|
2
|
+
import { type OptionValues } from 'commander';
|
|
3
|
+
export type CommanderOptions = {
|
|
4
|
+
opts: () => OptionValues;
|
|
5
|
+
};
|
|
6
|
+
export declare class Executable {
|
|
7
|
+
parseCLI(process: NodeJS.Process): Promise<void>;
|
|
8
|
+
}
|
|
9
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA,OAAO,EAAgB,KAAK,YAAY,EAAC,MAAM,WAAW,CAAC;AAK3D,MAAM,MAAM,gBAAgB,GAAG;IAC9B,IAAI,EAAE,MAAM,YAAY,CAAC;CACzB,CAAC;AAEF,qBAAa,UAAU;IAEhB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC,OAAO;CA+CtC"}
|
package/dist/index.js
ADDED
|
@@ -0,0 +1,53 @@
|
|
|
1
|
+
import { createCommand } from 'commander';
|
|
2
|
+
import { Docula } from './docula.js';
|
|
3
|
+
import { reportError } from './tools/tools.js';
|
|
4
|
+
import logger from './logger.js';
|
|
5
|
+
export class Executable {
|
|
6
|
+
// eslint-disable-next-line @typescript-eslint/naming-convention
|
|
7
|
+
async parseCLI(process) {
|
|
8
|
+
const program = createCommand();
|
|
9
|
+
program.storeOptionsAsProperties(true);
|
|
10
|
+
program.command('build', { isDefault: true })
|
|
11
|
+
.description('Build the site')
|
|
12
|
+
.option('-c, --config <config>', 'Path of where the config file is located')
|
|
13
|
+
.action(async (options) => {
|
|
14
|
+
try {
|
|
15
|
+
logger.info('Building your documentation...');
|
|
16
|
+
const docula = new Docula(options);
|
|
17
|
+
await docula.build();
|
|
18
|
+
logger.info('Site was built successfully!');
|
|
19
|
+
}
|
|
20
|
+
catch (error) {
|
|
21
|
+
reportError(error);
|
|
22
|
+
}
|
|
23
|
+
});
|
|
24
|
+
program.command('init')
|
|
25
|
+
.description('Initialize the site')
|
|
26
|
+
.action(async (options) => {
|
|
27
|
+
try {
|
|
28
|
+
logger.info('Initializing Docula...');
|
|
29
|
+
const docula = new Docula(options);
|
|
30
|
+
await docula.init();
|
|
31
|
+
}
|
|
32
|
+
catch (error) {
|
|
33
|
+
reportError(error);
|
|
34
|
+
}
|
|
35
|
+
});
|
|
36
|
+
program.command('serve')
|
|
37
|
+
.description('build and serve the site')
|
|
38
|
+
.action(async (options) => {
|
|
39
|
+
try {
|
|
40
|
+
logger.info('Building your documentation...');
|
|
41
|
+
const docula = new Docula(options);
|
|
42
|
+
await docula.build();
|
|
43
|
+
logger.info('Site was built successfully!');
|
|
44
|
+
await docula.serve();
|
|
45
|
+
}
|
|
46
|
+
catch (error) {
|
|
47
|
+
reportError(error);
|
|
48
|
+
}
|
|
49
|
+
});
|
|
50
|
+
program.parse(process.argv);
|
|
51
|
+
}
|
|
52
|
+
}
|
|
53
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,aAAa,EAAoB,MAAM,WAAW,CAAC;AAC3D,OAAO,EAAC,MAAM,EAAC,MAAM,aAAa,CAAC;AACnC,OAAO,EAAC,WAAW,EAAC,MAAM,kBAAkB,CAAC;AAC7C,OAAO,MAAM,MAAM,aAAa,CAAC;AAMjC,MAAM,OAAO,UAAU;IACtB,gEAAgE;IAChE,KAAK,CAAC,QAAQ,CAAC,OAAuB;QACrC,MAAM,OAAO,GAAG,aAAa,EAAE,CAAC;QAEhC,OAAO,CAAC,wBAAwB,CAAC,IAAI,CAAC,CAAC;QAEvC,OAAO,CAAC,OAAO,CAAC,OAAO,EAAE,EAAC,SAAS,EAAE,IAAI,EAAC,CAAC;aACzC,WAAW,CAAC,gBAAgB,CAAC;aAC7B,MAAM,CAAC,uBAAuB,EAAE,0CAA0C,CAAC;aAC3E,MAAM,CAAC,KAAK,EAAE,OAAyB,EAAE,EAAE;YAC3C,IAAI;gBACH,MAAM,CAAC,IAAI,CAAC,gCAAgC,CAAC,CAAC;gBAC9C,MAAM,MAAM,GAAG,IAAI,MAAM,CAAC,OAAO,CAAC,CAAC;gBACnC,MAAM,MAAM,CAAC,KAAK,EAAE,CAAC;gBACrB,MAAM,CAAC,IAAI,CAAC,8BAA8B,CAAC,CAAC;aAC5C;YAAC,OAAO,KAAc,EAAE;gBACxB,WAAW,CAAC,KAAK,CAAC,CAAC;aACnB;QACF,CAAC,CAAC,CAAC;QAEJ,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC;aACrB,WAAW,CAAC,qBAAqB,CAAC;aAClC,MAAM,CAAC,KAAK,EAAE,OAAyB,EAAE,EAAE;YAC3C,IAAI;gBACH,MAAM,CAAC,IAAI,CAAC,wBAAwB,CAAC,CAAC;gBACtC,MAAM,MAAM,GAAG,IAAI,MAAM,CAAC,OAAO,CAAC,CAAC;gBACnC,MAAM,MAAM,CAAC,IAAI,EAAE,CAAC;aACpB;YAAC,OAAO,KAAc,EAAE;gBACxB,WAAW,CAAC,KAAK,CAAC,CAAC;aACnB;QACF,CAAC,CAAC,CAAC;QAEJ,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC;aACtB,WAAW,CAAC,0BAA0B,CAAC;aACvC,MAAM,CAAC,KAAK,EAAE,OAAyB,EAAE,EAAE;YAC3C,IAAI;gBACH,MAAM,CAAC,IAAI,CAAC,gCAAgC,CAAC,CAAC;gBAC9C,MAAM,MAAM,GAAG,IAAI,MAAM,CAAC,OAAO,CAAC,CAAC;gBACnC,MAAM,MAAM,CAAC,KAAK,EAAE,CAAC;gBACrB,MAAM,CAAC,IAAI,CAAC,8BAA8B,CAAC,CAAC;gBAC5C,MAAM,MAAM,CAAC,KAAK,EAAE,CAAC;aACrB;YAAC,OAAO,KAAc,EAAE;gBACxB,WAAW,CAAC,KAAK,CAAC,CAAC;aACnB;QACF,CAAC,CAAC,CAAC;QAEJ,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAC7B,CAAC;CACD"}
|
package/dist/logger.d.ts
ADDED