Skip to content

Commit

Permalink
[gem-book] Fixed nav & dev init book config
Browse files Browse the repository at this point in the history 
See #113
  • Loading branch information
@mantou132
mantou132 committed Jan 8, 2024
1 parent cafb44f commit d9e7598
Show file tree
Hide file tree
Showing 4 changed files with 104 additions and 90 deletions.
2 changes: 1 addition & 1 deletion packages/gem-book/package.json
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "gem-book",
"version": "1.5.33",
"version": "1.5.34",
"description": "Create your document website easily and quickly",
"keywords": [
"doc",
Expand Down
8 changes: 1 addition & 7 deletions packages/gem-book/src/bin/builder.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ const entryDir = path.resolve(__dirname, process.env.GEM_BOOK_DEV ? '../src/webs
const pluginDir = path.resolve(__dirname, process.env.GEM_BOOK_DEV ? '../src/plugins' : '../plugins');

// dev mode uses memory file system
export async function startBuilder(dir: string, options: Required<CliUniqueConfig>, bookConfig: BookConfig) {
export async function build(dir: string, options: Required<CliUniqueConfig>, bookConfig: BookConfig) {
const { debug, build, theme, template, output, icon, plugin, ga } = options;

const plugins = [...plugin];
Expand Down Expand Up @@ -162,7 +162,6 @@ export async function startBuilder(dir: string, options: Required<CliUniqueConfi
'Cache-Control': 'no-store',
},
historyApiFallback: true,
open: process.env.PORT ? false : true,
setupMiddlewares: (middlewares, devServer) => {
devServer.app!.use('/_assets/', serveStatic(process.cwd()));
return middlewares;
Expand All @@ -171,11 +170,6 @@ export async function startBuilder(dir: string, options: Required<CliUniqueConfi
},
compiler,
);
server.startCallback((err) => {
if (err) {
print(err);
}
});

return server;
}
Expand Down
144 changes: 77 additions & 67 deletions packages/gem-book/src/bin/index.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ import {
importObject,
resolveModule,
} from './utils';
import { startBuilder } from './builder';
import { build } from './builder';
import lang from './lang.json'; // https://developers.google.com/search/docs/advanced/crawling/localized-versions#language-codes

const devServerEventTarget = new EventTarget();
Expand Down Expand Up @@ -90,13 +90,16 @@ async function syncConfig(fullPath?: string) {

if (cliConfig.debug) print(cliConfig);

obj.nav = obj.nav?.filter((e) => {
if (e.title?.toLowerCase() === 'github') {
bookConfig.github = e.link;
} else {
return true;
}
});
if (obj.nav) {
obj.nav = obj.nav?.filter((e) => {
if (e.title?.toLowerCase() === 'github') {
bookConfig.github = e.link;
} else {
return true;
}
});
}

Object.assign(bookConfig, obj);
}

Expand Down Expand Up @@ -251,27 +254,64 @@ async function generateBookConfig(dir: string) {
print(chalk.green(`[${new Date().toISOString()}]: book config updated! ${Date.now() - t}ms`));
}

let updateBookTimer: ReturnType<typeof setTimeout>;
const updateBookConfig = (dir: string) => {
clearTimeout(updateBookTimer);
updateBookTimer = setTimeout(async () => {
await generateBookConfig(dir);
devServerEventTarget.dispatchEvent(
Object.assign(new Event(UPDATE_EVENT), {
detail: { config: bookConfig },
}),
);
}, 100);
};

const watchTheme = () => {
const themePath = resolveTheme(cliConfig.theme);
if (themePath) {
return watch(themePath).on('change', async () => {
devServerEventTarget.dispatchEvent(
Object.assign(new Event(UPDATE_EVENT), {
detail: { theme: await importObject(themePath) },
}),
);
});
}
};

const startBuild = async (dir: string) => {
const devServer = await build(dir, cliConfig, bookConfig);
if (!devServer) return;

await devServer.start();
devServer.webSocketServer?.implementation.on('connection', (client) => {
devServer.sendMessage([client], UPDATE_EVENT, { config: bookConfig });
});
return devServer;
};

program
.option('-t, --title <title>', 'document title', (title: string) => {
.option('-t, --title <title>', 'document title', (title) => {
bookConfig.title = title;
})
.option('-d, --source-dir <dir>', 'github source dir, default use docs dir', (sourceDir: string) => {
.option('-d, --source-dir <dir>', 'github source dir, default use docs dir', (sourceDir) => {
bookConfig.sourceDir = sourceDir;
})
.option(
'-b, --source-branch <branch>',
`github source branch, default \`${DEFAULT_SOURCE_BRANCH}\``,
(sourceBranch: string) => {
(sourceBranch) => {
bookConfig.sourceBranch = sourceBranch;
},
)
.option('--base <dir>', 'github base dir', (base: string) => {
.option('--base <dir>', 'github base dir', (base) => {
bookConfig.base = base;
})
.option('--github <url>', 'project github url', (link: string) => {
.option('--github <url>', 'project github url', (link) => {
bookConfig.github = link;
})
.option('--footer <string>', 'footer content, support markdown format', (footer: string) => {
.option('--footer <string>', 'footer content, support markdown format', (footer) => {
bookConfig.footer = footer;
})
.option('--display-rank', 'sorting number is not displayed in the link', () => {
Expand All @@ -283,36 +323,39 @@ program
.option('--only-file', 'not include heading navigation', () => {
bookConfig.onlyFile = true;
})
.option('--nav <title,link>', 'attach a nav item', (item: string) => {
.option('--nav <title,link>', 'attach a nav item', (item) => {
bookConfig.nav ||= [];
const [title, link] = item.split(',');
if (!link) throw new Error('nav options error');
if (!link) {
print(chalk.red('nav options error'));
process.exit(1);
}
if (title.toLowerCase() === 'github') {
bookConfig.github = link;
} else {
bookConfig.nav.push({ title, link });
}
})
.option('-i, --icon <path>', 'project icon path or url', (path: string) => {
.option('-i, --icon <path>', 'project icon path or url', (path) => {
cliConfig.icon = path;
})
.option(
'-o, --output <path>',
`output file or directory, default use docs dir, generate an \`${DEFAULT_FILE}\` file if only JSON is generated`,
(dir: string) => {
(dir) => {
cliConfig.output = dir;
if (path.extname(dir) === '.json') {
cliConfig.json = true;
}
},
)
.option('--plugin <name or path>', 'load plugin', (name: string) => {
.option('--plugin <name or path>', 'load plugin', (name) => {
cliConfig.plugin.push(name);
})
.option('--ignored <path>', 'html template path', (path) => {
cliConfig.ignored.push(path);
.option('--ignored <string>', 'ignore file or dir', (str) => {
cliConfig.ignored.push(str);
})
.option('--ga <id>', 'google analytics ID', (id: string) => {
.option('--ga <id>', 'google analytics ID', (id) => {
cliConfig.ga = id;
})
.option('--template <path>', 'html template path', (path) => {
Expand All @@ -333,13 +376,9 @@ program
.option('--debug', 'enabled debug mode', () => {
cliConfig.debug = true;
})
.option(
'--config <path>',
`specify config file, default use \`${DEFAULT_CLI_FILE}\`.{js|json|mjs}`,
(configPath: string) => {
cliConfig.config = configPath;
},
)
.option('--config <path>', `specify config file, default use \`${DEFAULT_CLI_FILE}\`.{js|json|mjs}`, (configPath) => {
cliConfig.config = configPath;
})
.arguments('<dir>')
.action(async (dir: string) => {
const initCliOptions = structuredClone(cliConfig);
Expand All @@ -353,53 +392,24 @@ program
await syncConfig(configPath);
await generateBookConfig(dir);

let updateBookTimer: ReturnType<typeof setTimeout>;
const updateBookConfig = () => {
clearTimeout(updateBookTimer);
updateBookTimer = setTimeout(async () => {
await generateBookConfig(dir);
devServerEventTarget.dispatchEvent(
Object.assign(new Event(UPDATE_EVENT), {
detail: { config: bookConfig },
}),
);
}, 100);
};

const watchTheme = () => {
const themePath = resolveTheme(cliConfig.theme);
if (themePath) {
return watch(themePath).on('change', async () => {
devServerEventTarget.dispatchEvent(
Object.assign(new Event(UPDATE_EVENT), {
detail: { theme: await importObject(themePath) },
}),
);
});
}
};

let server = cliConfig.json ? undefined : await startBuilder(dir, cliConfig, bookConfig);
let devServer = cliConfig.json ? undefined : await startBuild(dir);

if (!cliConfig.build) {
devServerEventTarget.addEventListener(UPDATE_EVENT, ({ detail }: CustomEvent) => {
server?.sendMessage(server.webSocketServer?.clients || [], UPDATE_EVENT, detail);
devServer?.sendMessage(devServer.webSocketServer?.clients || [], UPDATE_EVENT, detail);
});

// start server

let themeWatcher = watchTheme();
if (configPath) {
watch(configPath).on('change', async () => {
cliConfig = structuredClone(initCliOptions);
bookConfig = structuredClone(initBookConfig);
await syncConfig(configPath);
await generateBookConfig(dir);
await server?.stop();
server = await startBuilder(dir, cliConfig, bookConfig);
devServerEventTarget.dispatchEvent(
Object.assign(new Event(UPDATE_EVENT), {
detail: { config: bookConfig },
}),
);
await devServer?.stop();
devServer = await startBuild(dir);
await themeWatcher?.close();
themeWatcher = watchTheme();
});
Expand All @@ -410,7 +420,7 @@ program
ignored: cliConfig.ignored || undefined,
}).on('all', (type, filePathWithDir) => {
if (type !== 'change') {
return updateBookConfig();
return updateBookConfig(dir);
}

const filePath = path.relative(dir, filePathWithDir);
Expand All @@ -426,7 +436,7 @@ program
}

if (isDirConfigFile(filePath)) {
return updateBookConfig();
return updateBookConfig(dir);
}

if (cliConfig.debug) {
Expand All @@ -441,7 +451,7 @@ program
);

if (metadataChanged) {
updateBookConfig();
updateBookConfig(dir);
}
});
}
Expand Down
40 changes: 25 additions & 15 deletions packages/gem-book/src/element/elements/nav.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ import {
boolattribute,
classMap,
history,
state,
} from '@mantou/gem';
import { mediaQuery } from '@mantou/gem/helper/mediaquery';

Expand Down Expand Up @@ -42,6 +43,8 @@ export class Nav extends GemElement {
updateBookConfig(bookStore.config);
};

@state compact: boolean;
@refobject spaceRef: RefObject<HTMLDivElement>;
@refobject i18nRef: RefObject<HTMLSelectElement>;

renderI18nSelect = () => {
Expand Down Expand Up @@ -112,10 +115,6 @@ export class Nav extends GemElement {
:where(.item + .item) {
margin-left: 1rem;
}
.external:not(.icon) gem-use {
width: 1em;
margin-left: 0.3rem;
}
.item select {
-webkit-appearance: none;
appearance: none;
Expand All @@ -131,6 +130,19 @@ export class Nav extends GemElement {
.left .item {
padding: 0 1rem;
}
.external:not(.icon) {
padding-inline-end: 0;
}
.external:not(.icon) gem-use {
width: 1em;
margin-left: 0.3rem;
}
:host(:where([data-compact], :state(compact))) .external:not(.icon) {
display: none;
}
:host(:where([data-compact], :state(compact))) .left .item {
padding: 0 0.5rem;
}
gem-link,
gem-active-link {
text-decoration: none;
Expand Down Expand Up @@ -172,11 +184,6 @@ export class Nav extends GemElement {
padding-inline: 1rem;
margin-inline-start: -1rem;
}
@media not ${`(${mediaQuery.DESKTOP})`} {
.external:not(.icon) {
display: none;
}
}
@media ${mediaQuery.PHONE} {
.menu {
display: block;
Expand All @@ -195,6 +202,7 @@ export class Nav extends GemElement {
<div class="left">
${internals.map((item) => this.renderInternalItem(item))}
${textExternals.map((item) => this.renderExternalItem(item))}
<div ref=${this.spaceRef.ref} style="flex-grow: 1;"></div>
</div>
<slot class="item"></slot>
${this.renderI18nSelect()}
Expand All @@ -203,10 +211,12 @@ export class Nav extends GemElement {
`;
}

updated() {
if (this.i18nRef.element && bookStore.lang) {
// browser history back
this.i18nRef.element.value = bookStore.lang;
}
}
mounted = () => {
this.effect(() => {
if (this.i18nRef.element) {
this.i18nRef.element.value = bookStore.lang!;
}
this.compact ||= this.spaceRef.element!.getBoundingClientRect().width < 100;
});
};
}

0 comments on commit d9e7598

Please sign in to comment.