deno.land / x / pagic@v1.6.3 / src / Pagic.ts
نووسراو ببینە
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408import { React, fs, path, colors, EventEmitter } from '../deps.ts';
import { pick, unique, sortByInsert, importDefault, logger, walk, getPagicConfigPath, importPlugin, importTheme, serve, getGitBranch,} from './utils/mod.ts';import type { PagePropsSidebar, PagicConfigSidebar } from './plugins/sidebar.tsx';import type { PagePropsBlog } from './plugins/blog.tsx';import type { GaProps } from './plugins/ga_component.tsx';import type { GitalkProps } from './plugins/gitalk_component.tsx';
// #region typesexport interface PagicConfig { // base srcDir: string; outDir: string; include?: string[]; exclude?: string[]; root: string; theme: string; plugins: string[]; watch: boolean; serve: boolean; port: number;
// theme config title?: string; description?: string; head?: React.ReactElement | null; github?: string; tocAd?: React.ReactElement; tools?: { editOnGitHub: boolean; backToTop: boolean; }; branch?: string; footer?: React.ReactElement;
// plugins nav?: { text: string; link: string; icon?: string; target?: '_blank' | string; popover?: React.ReactElement; align?: 'left' | 'right'; }[]; sidebar?: PagicConfigSidebar; md?: { anchorLevel?: (1 | 2 | 3 | 4 | 5 | 6)[]; tocEnabled?: boolean; tocLevel?: (1 | 2 | 3 | 4 | 5 | 6)[]; katexMacros?: Record<string, string>; }; ga?: GaProps; gitalk?: GitalkProps; blog?: { root: string; social?: { github: string; email: string; twitter: string; v2ex: string; zhihu: string; }; }; i18n?: { languages: { code: string; name: string; root: string }[]; overrides?: Record<string, any>; resources?: Record<string, { translation: Record<string, string> }>; };
[key: string]: any;}
export interface PagicThemeConfig { files: [];}
export interface PagicPlugin { name: string; insert?: string; fn: (ctx: Pagic) => Promise<void>;}
export type PagicLayout<T = Record<string, any>> = React.FC<PageProps & T>;
export interface PageProps { // md title: string; content: React.ReactElement | null; contentTitle?: React.ReactElement; contentBody?: React.ReactElement; toc?: React.ReactElement | null; author?: string; contributors?: string[]; date?: Date | string; updated?: Date | string | null; excerpt?: string; cover?: string; tags?: string[]; categories?: string[];
// init config: PagicConfig; pagePath: string; layoutPath: string; outputPath: string; head: React.ReactElement | null; script: React.ReactElement | null; footer: React.ReactElement | null;
// script loading?: boolean;
// other plugins sidebar?: PagePropsSidebar; prev?: PagePropsSidebar[0]; next?: PagePropsSidebar[0]; ga?: React.ReactElement; gitalk?: React.ReactElement; blog?: PagePropsBlog; language?: { code: string; name: string; root: string };
[key: string]: any;}// #endregion
export default class Pagic extends EventEmitter { // #region properties public static defaultConfig: PagicConfig = { srcDir: '.', outDir: 'dist', include: undefined, exclude: [ // Dot files '**/.*', // Node common files '**/package.json', '**/package-lock.json', '**/node_modules', 'pagic.config.ts', 'pagic.config.tsx', // https://docs.npmjs.com/using-npm/developers.html#keeping-files-out-of-your-package '**/config.gypi', '**/CVS', '**/npm-debug.log',
// ${config.outDir} will be added later ], root: '/', theme: 'default', plugins: ['clean', 'init', 'md', 'tsx', 'script', 'layout', 'out'], watch: false, serve: false, port: 8000, footer: React.createElement( 'footer', {}, 'Powered by ', React.createElement( 'a', { href: 'https://github.com/xcatliu/pagic', target: '_blank', }, ['Pagic'], ), ), }; // foo.md public static REGEXP_PAGE = /[\/\\][^_][^\/\\]*\.(md|tsx)$/; // /_layout.tsx /_sidebar.tsx public static REGEXP_LAYOUT = /[\/\\]_[^\/\\]+\.tsx$/;
// @ts-ignore public pagicConfigPath: string; // @ts-ignore public config: PagicConfig = {};
/** Pages that need to be build */ public pagePaths: string[] = []; public layoutPaths: string[] = []; public staticPaths: string[] = []; /** Files that need to be write */ public writeFiles: Record<string, string> = {}; /** A map stored all pageProps */ public pagePropsMap: Record<string, PageProps> = {}; public rebuilding = true;
public projectConfig: Partial<PagicConfig> = {}; private runtimeConfig: Partial<PagicConfig> = {};
private changedPaths: string[] = []; private timeoutHandler: number | undefined = undefined; // #endregion
public constructor(config: Partial<PagicConfig> = {}) { super(); this.runtimeConfig = config; }
public async build() { await this.rebuild(); if (this.config.serve) { this.serve(); } if (this.config.watch) { this.watch(); }
this.emit('buildFinish'); }
public async generateThemeMod() { this.config = { ...Pagic.defaultConfig, exclude: [...Pagic.defaultConfig.exclude!, 'mod.ts'], };
await this.initPaths(); await Deno.writeTextFile( './mod.ts', `export default {\n files: [\n${[...this.staticPaths, ...this.layoutPaths] .map((filePath) => ` '${filePath}'`) .join(',\n')}\n ]\n};\n`, ); }
public getConfig(pagePath?: string) { if (typeof pagePath === 'undefined') { return this.config; } return this.pagePropsMap[pagePath].config; }
private async rebuild() { this.rebuilding = true; this.pagePropsMap = {}; this.writeFiles = {};
await this.initConfig(); await this.initPaths(); await this.runPlugins(); }
/** Deep merge defaultConfig, projectConfig and runtimeConfig, then sort plugins */ private async initConfig() { this.pagicConfigPath = await getPagicConfigPath(); this.projectConfig = await importDefault(this.pagicConfigPath, { reload: true, }); let config = { ...Pagic.defaultConfig, ...this.projectConfig, ...this.runtimeConfig, }; if (typeof config.branch === 'undefined') { const branch = await getGitBranch(); config.branch = branch; } config.exclude = unique([ ...(Pagic.defaultConfig.exclude ?? []), ...(this.projectConfig.exclude ?? []), ...(this.runtimeConfig.exclude ?? []), config.outDir, ]); config.plugins = unique([ ...Pagic.defaultConfig.plugins, ...(this.projectConfig.plugins ?? []), ...(this.runtimeConfig.plugins ?? []), ]); this.config = config; }
private async serve() { serve({ serveDir: this.config.outDir, root: this.config.root, port: this.config.port, }); logger.success( 'Serve', colors.underline(this.config.outDir), `on http://127.0.0.1:${this.config.port}${this.config.root}`, ); }
private async watch() { logger.success('Watch', colors.underline(this.config.srcDir)); const watcher = Deno.watchFs([this.config.srcDir, this.pagicConfigPath]); for await (const event of watcher) { // pagic.config.ts modified, rebuild if (event.kind === 'modify' && event.paths.includes(this.pagicConfigPath)) { clearTimeout(this.timeoutHandler); this.timeoutHandler = setTimeout(async () => { this.rebuild(); }, 100); continue; } let eventPaths = event.paths.map((eventPath) => path.relative(this.config.srcDir, eventPath)); this.config.include?.forEach((glob) => { eventPaths = eventPaths.filter( (eventPath) => path.globToRegExp(glob).test(eventPath) || path.globToRegExp(`${glob}/**`).test(eventPath), ); }); this.config.exclude?.forEach((glob) => { eventPaths = eventPaths.filter( (eventPath) => !path.globToRegExp(glob).test(eventPath) && !path.globToRegExp(`${glob}/**`).test(eventPath), ); }); this.handleFileChange(eventPaths); } }
private async handleFileChange(filePaths: string[]) { if (filePaths.length === 0) return; this.changedPaths = unique([...this.changedPaths, ...filePaths]); clearTimeout(this.timeoutHandler); this.timeoutHandler = setTimeout(async () => { this.rebuilding = false; this.pagePaths = []; this.staticPaths = []; for (const changedPath of this.changedPaths) { const fullChangedPath = path.resolve(this.config.srcDir, changedPath); if (!fs.existsSync(fullChangedPath)) { logger.warn(`${changedPath} removed, start rebuild`); this.rebuilding = true; break; } else if (Deno.statSync(fullChangedPath).isDirectory) { logger.warn(`Directory ${colors.underline(changedPath)} changed, start rebuild`); this.rebuilding = true; break; } else if (Pagic.REGEXP_LAYOUT.test(fullChangedPath)) { logger.warn(`Layout ${changedPath} changed, start rebuild`); this.rebuilding = true; break; } else if (Pagic.REGEXP_PAGE.test(fullChangedPath)) { this.pagePaths.push(changedPath); } else { this.staticPaths.push(changedPath); } } if (this.rebuilding) { await this.rebuild(); } else { await this.runPlugins(); } this.changedPaths = []; }, 100); }
private async initPaths() { const { files: themeFiles } = await importTheme(this.config.theme);
this.pagePaths = await walk(this.config.srcDir, { ...pick(this.config, ['include', 'exclude']), match: [Pagic.REGEXP_PAGE], }); this.layoutPaths = unique([ ...(await walk(this.config.srcDir, { ...pick(this.config, ['include', 'exclude']), match: [Pagic.REGEXP_LAYOUT], })), ...themeFiles.filter((filename) => Pagic.REGEXP_LAYOUT.test(`/${filename}`)), ]).sort(); this.staticPaths = unique([ ...(await walk(this.config.srcDir, { ...pick(this.config, ['include', 'exclude']), skip: [Pagic.REGEXP_PAGE, Pagic.REGEXP_LAYOUT], })), ...themeFiles.filter( (filename) => !Pagic.REGEXP_PAGE.test(`/${filename}`) && !Pagic.REGEXP_LAYOUT.test(`/${filename}`), ), ]).sort(); }
private async runPlugins() { if (this.pagePaths.length === 0 && this.staticPaths.length === 0) return;
let sortedPlugins: PagicPlugin[] = []; for (let pluginName of this.config.plugins) { if (pluginName.startsWith('-')) { continue; } let plugin = await importPlugin(pluginName); sortedPlugins.push(plugin); } sortedPlugins = sortByInsert(sortedPlugins); const removedPlugins = this.config.plugins.filter((pluginName) => pluginName.startsWith('-')); sortedPlugins = sortedPlugins.filter((plugin) => !removedPlugins.includes(`-${plugin.name}`));
for (let plugin of sortedPlugins) { logger.success('Plugin', plugin.name, 'start'); await plugin.fn(this); } }}
pagic
Version Info
11 months ago
