MahmoudEmad/herolib
1
0
Fork 0
Code Issues 55 Pull Requests 1 Actions Packages Projects Releases 26 Wiki Activity

refactor: overhaul Docusaurus command and generation

Browse Source 
- Rework `hero docusaurus` command to use local `cfg` files
- Scan and export doctree collections during site generation
- Fix `baseUrl` redirect path handling in `index.tsx`
- Add cycle detection for `play.include` in playbooks
- Improve site config processing to prevent duplicate items
This commit is contained in:
Mahmoud-Emad
2025-08-07 10:46:57 +03:00
parent 2667856633
commit 82a46e8149
15 changed files with 291 additions and 140 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
lib/web/docusaurus/dsite.v
View File

@@ -24,9 +24,9 @@ pub mut:
pub fn (mut s DocSite) build() ! {
s.generate()!
osal.exec(
cmd: '
cmd: '
cd ${s.path_build.path}
exit 1
bun run build
'
retry: 0
)!
@@ -35,9 +35,9 @@ pub fn (mut s DocSite) build() ! {
pub fn (mut s DocSite) build_dev_publish() ! {
s.generate()!
osal.exec(
cmd: '
cmd: '
cd ${s.path_build.path}
exit 1
bun run build
'
retry: 0
)!
@@ -46,9 +46,9 @@ pub fn (mut s DocSite) build_dev_publish() ! {
pub fn (mut s DocSite) build_publish() ! {
s.generate()!
osal.exec(
cmd: '
cmd: '
cd ${s.path_build.path}
exit 1
bun run build
'
retry: 0
)!

13
lib/web/docusaurus/dsite_add.v
View File

@@ -63,7 +63,12 @@ pub fn dsite_add(args_ AddArgs) !&DocSite {
osal.rm('${args.path}/sync.sh')!
osal.rm('${args.path}/.DS_Store')!
mut website := site.get(name: args.sitename)!
// Try to get the site by name, if it doesn't exist, try to get the default site
mut website := site.get(name: args.sitename) or {
site.get(name: 'default') or {
return error('Neither site "${args.sitename}" nor default site exists. Available sites need to be created first with docusaurus.config.')
}
}
mut myconfig := new_configuration(website.siteconfig)! // go from site.SiteConfig to docusaurus.Configuration
@@ -80,15 +85,15 @@ pub fn dsite_add(args_ AddArgs) !&DocSite {
path_build_ := '${f.path_build.path}/${args.sitename}'
// get our website
mut mysite := site.new(name: args.sitename)!
mut mysite := &site.Site(unsafe { nil })
if site.exists(name: args.sitename) {
console.print_debug('Docusaurus site ${args.sitename} already exists, using existing site.')
// Site already exists (likely processed by hero command), use existing site
mysite = site.get(name: args.sitename)!
} else {
if !args.play {
return error('Docusaurus site ${args.sitename} does not exist, please set play to true to create it.')
}
console.print_debug('Creating new Docusaurus site ${args.sitename}.')
// Create new site and process config files
mut plbook := playbook.new(path: '${args.path}/cfg')!
site.play(mut plbook)!
mysite = site.get(name: args.sitename) or {

23
lib/web/docusaurus/dsite_configuration.v
View File

@@ -155,15 +155,19 @@ fn new_configuration(site_cfg site.SiteConfig) !Configuration {
}
fn config_fix(config Configuration) !Configuration {
// Fix empty logo sources by removing logo entirely if all fields are empty
// Fix empty logo sources by providing defaults if all fields are empty
mut navbar_fixed := config.navbar
if config.navbar.logo.src == '' && config.navbar.logo.src_dark == ''
&& config.navbar.logo.alt == '' {
// Create navbar without logo if all logo fields are empty
// Provide default logo values when all are empty
navbar_fixed = Navbar{
title: config.navbar.title
logo: Logo{
alt: 'Logo'
src: 'img/logo.svg'
src_dark: 'img/logo_dark.svg'
}
items: config.navbar.items
// logo field omitted entirely
}
}
@@ -175,6 +179,19 @@ fn config_fix(config Configuration) !Configuration {
favicon: if config.main.favicon == '' { 'img/favicon.ico' } else { config.main.favicon }
url: if config.main.url == '' { 'https://example.com' } else { config.main.url }
base_url: if config.main.base_url == '' { '/' } else { config.main.base_url }
metadata: Metadata{
...config.main.metadata
description: if config.main.metadata.description == '' {
'Documentation built with Docusaurus.'
} else {
config.main.metadata.description
}
title: if config.main.metadata.title == '' {
config.main.title
} else {
config.main.metadata.title
}
}
}
navbar: navbar_fixed
}

138
lib/web/docusaurus/dsite_generate.v
View File

@@ -7,8 +7,7 @@ import json
import os
import freeflowuniverse.herolib.osal.core as osal
import freeflowuniverse.herolib.ui.console
import freeflowuniverse.herolib.core.texttools.regext
// import freeflowuniverse.herolib.data.doctree
import freeflowuniverse.herolib.data.doctree
import freeflowuniverse.herolib.web.site as sitegen
pub fn (mut site DocSite) generate() ! {
@@ -40,14 +39,8 @@ pub fn (mut site DocSite) generate() ! {
}
}
mut main_file := pathlib.get_file(path: '${cfg_path}/main.json', create: true)!
main_file.write(json.encode_pretty(site.config.main))!
mut navbar_file := pathlib.get_file(path: '${cfg_path}/navbar.json', create: true)!
navbar_file.write(json.encode_pretty(site.config.navbar))!
mut footer_file := pathlib.get_file(path: '${cfg_path}/footer.json', create: true)!
footer_file.write(json.encode_pretty(site.config.footer))!
// We'll generate the configuration files after processing the site
// This is moved to after sitegen.play() so we can use the processed site configuration
osal.rm('${f.path_build.path}/docs')!
@@ -71,44 +64,101 @@ pub fn (mut site DocSite) generate() ! {
sitegen.play(mut plbook)!
// Get the updated site object after processing
mut updated_site := sitegen.get(name: site.name)!
// The site name in the config might be different from the docusaurus site name
// Find the site with the most pages (should contain the processed page definitions)
available_sites := sitegen.list()
mut best_site := &sitegen.Site(unsafe { nil })
mut max_pages := 0
for site_name in available_sites {
mut test_site := sitegen.get(name: site_name) or { continue }
if test_site.pages.len > max_pages {
max_pages = test_site.pages.len
best_site = test_site
}
}
if best_site == unsafe { nil } || max_pages == 0 {
return error('No sites with pages found after processing playbook. Available sites: ${available_sites}')
}
mut updated_site := best_site
// Generate the configuration files using the processed site configuration
mut updated_config := new_configuration(updated_site.siteconfig)!
mut main_file := pathlib.get_file(path: '${cfg_path}/main.json', create: true)!
main_file.write(json.encode_pretty(updated_config.main))!
mut navbar_file := pathlib.get_file(path: '${cfg_path}/navbar.json', create: true)!
navbar_file.write(json.encode_pretty(updated_config.navbar))!
mut footer_file := pathlib.get_file(path: '${cfg_path}/footer.json', create: true)!
footer_file.write(json.encode_pretty(updated_config.footer))!
// Fix the index.tsx redirect to handle baseUrl properly
// When baseUrl is not '/', we need to use an absolute redirect path
if updated_config.main.base_url != '/' {
index_tsx_path := '${f.path_build.path}/src/pages/index.tsx'
if os.exists(index_tsx_path) {
// Create the corrected index.tsx content
fixed_index_content := "import React from 'react';
import { Redirect } from '@docusaurus/router';
import main from '../../cfg/main.json';
export default function Home() {
// Use absolute redirect path when baseUrl is not root
const redirectPath = main.baseUrl + main.url_home;
return <Redirect to={redirectPath} />;
}"
mut index_file := pathlib.get_file(path: index_tsx_path, create: false)!
index_file.write(fixed_index_content)!
}
}
// Scan and export doctree collections to Redis before generating docs
// This ensures the doctreeclient can access the collections when generating pages
console.print_header(' scanning doctree collections for site: ${site.name}')
// Find the collections directory relative to the source path
// The collections should be in the parent directory of the ebooks
mut collections_path := ''
// Try to find collections directory by going up from the source path
mut current_path := pathlib.get_dir(path: site.path_src.path)!
for _ in 0 .. 5 { // Search up to 5 levels up
collections_candidate := '${current_path.path}/collections'
if os.exists(collections_candidate) {
collections_path = collections_candidate
break
}
parent := current_path.parent() or { break } // reached root or error
if parent.path == current_path.path {
break // reached root
}
current_path = parent
}
if collections_path != '' {
// Create a doctree and scan the collections
mut tree := doctree.new(name: site.name)!
tree.scan(path: collections_path)!
// Export to Redis and temporary location for doctreeclient access
tree.export(
destination: '/tmp/doctree_export_${site.name}'
reset: true
exclude_errors: false
)!
}
// Generate the actual docs content from the processed site configuration
docs_path := '${f.path_build.path}/docs'
generate(
console.print_header(' generating docs from site pages to: ${docs_path}')
generate_docs(
path: docs_path
site: updated_site
)!
// site.process_imports()!
}
// pub fn (mut site DocSite) process_imports() ! {
// mut gs := gittools.new()!
// mut f:=factory_get()!
// for item in site.siteconfig.imports {
// mypath := gs.get_path(
// pull: false
// reset: false
// url: item.url
// )!
// mut mypatho := pathlib.get(mypath)
// mypatho.copy(dest: '${f.path_build.path}/docs/${item.dest}', delete: true)!
// // println(item)
// // replace: {'NAME': 'MyName', 'URGENCY': 'red'}
// mut ri := regext.regex_instructions_new()
// for key, val in item.replace {
// ri.add_item('\{${key}\}', val)!
// }
// mypatho.copy(dest: '${f.path_build.path}/docs/${item.dest}', delete: true)!
// ri.replace_in_dir(
// path: '${f.path_build.path}/docs/${item.dest}'
// extensions: [
// 'md',
// ]
// )!
// }
// }

7
lib/web/docusaurus/generator.v
View File

@@ -25,12 +25,13 @@ mut:
site Site
}
// new creates a new siteconfig and stores it in redis, or gets an existing one
fn generate(args SiteGeneratorArgs) ! {
// Generate docs from site configuration
pub fn generate_docs(args SiteGeneratorArgs) ! {
mut path := args.path
if args.path == '' {
return error('Path must be provided to generate site')
}
mut gen := SiteGenerator{
path: pathlib.get_dir(path: path, create: true)!
client: doctreeclient.new()!
@@ -127,8 +128,6 @@ fn (mut mysite SiteGenerator) page_generate(args_ Page) ! {
pagefile.write(c)!
// console.print_debug("Copy images in collection '${collection_name}' to ${pagefile.path_dir()}")
mysite.client.copy_images(collection_name, page_name, pagefile.path_dir()) or {
return error("Couldn't copy images for '${page_name}' in collection '${collection_name}' using doctreeclient. Available pages:\n${mysite.client.list_markdown()!}\nError: ${err}")
}

17
lib/web/docusaurus/play.v
View File

@@ -4,7 +4,6 @@ import freeflowuniverse.herolib.core.playbook { PlayBook }
import freeflowuniverse.herolib.web.site
pub fn play(mut plbook PlayBook) ! {
if !plbook.exists(filter: 'docusaurus.') {
return
}
@@ -41,10 +40,10 @@ pub fn play(mut plbook PlayBook) ! {
dsite_add(
sitename: site_name
path: p.get('path')!
git_url: p.get('git_url')!
path: p.get_default('path', '')! // Make path optional
git_url: p.get_default('git_url', '')! // Make git_url optional too
git_reset: p.get_default_false('git_reset')
git_root: p.get('git_root')!
git_root: p.get_default('git_root', '')! // Make git_root optional
git_pull: p.get_default_false('git_pull')
path_publish: p.get_default('path_publish', f.path_publish.path)!
play: false // need to make sure we don't play again
@@ -56,6 +55,7 @@ pub fn play(mut plbook PlayBook) ! {
if actions_dev.len > 1 {
return error('Multiple "docusaurus.dev" actions found. Only one is allowed.')
}
for mut action in actions_dev {
mut p := action.params
site_name := p.get('site')!
@@ -75,7 +75,14 @@ pub fn play(mut plbook PlayBook) ! {
}
for mut action in actions_build {
mut p := action.params
site_name := p.get('site')!
site_name := p.get('site') or {
// If no site specified, use the first available site
if docusaurus_sites.len == 0 {
return error('No docusaurus sites available to build. Use docusaurus.add to create a site first.')
}
// Get the first site name
docusaurus_sites.keys()[0]
}
mut dsite := dsite_get(site_name)!
dsite.build()!
action.done = true