Files
Cell 658f03d1e5 refactor(params)!: flatten [params.page] to [params], snake_case keys, more page-level params support (#805)
* refactor(params)!: snake_case config + eliminate params.page + use .Param

BREAKING CHANGE: All params keys renamed from camelCase to snake_case,
[params.page] section eliminated (moved to [params] level), and users
must update their hugo.toml and front matter accordingly.

Key changes:
- All camelCase config keys → snake_case (e.g., defaultTheme → default_theme)
- [params.page] flat keys and sub-sections moved to [params] level
- Removed function/params.html (manual merge), replaced with Hugo .Param
- New function/param.html partial for page-level section params with
  shorthand boolean support and site defaults merging
- New function/camel-case.html for string conversion
- snake2camel.html renamed to camel-case-keys.html
- New function/get-cover.html for cover image resolution
- Deprecation warnings in detection-deprecated.html for old config keys
- Front matter only params (subtitle, featured_image, password, repost,
  weight, message) use .Params.xxx instead of .Param
- Page-level sections use param.html partial
- Simplified patch.html (siteTime only) and init/index.html

Refs: camel-case-keys.html#29 (planned v1.0 breaking change)

* refactor(params)!: move params.link to page-level, simplify link guard

- Move [params.link] and [params.link.guard] to page-level section
- link.html: .Page optional, use param.html when available for
  page-level override, fall back to site config without .Page
- Remove $guardConfig variable, use $config.guard directly
- Remove unnecessary .Page from callers that don't need page override
- friends.html: use param.html for link guard instead of link_guard

* refactor(params)!: move image/codeblock/json_viewer/filetree to page-level

- Move [params.image], [params.codeblock], [params.json_viewer],
  [params.filetree] to page-level sub-sections
- Templates use param.html for merged config (page override + site defaults)
- image.html: .Page optional, falls back to site config without .Page
- Add v1- prefix to all deprecation warnidf IDs
- Fix camelCase key access in image.html (blackList, cacheRemote)
- Fix Hugo-lowered camelCase keys in code-block-wrapper.html
- Add deprecation warnings for codeblock camelCase Markdown attributes
- Add deprecation warnings for file-tree camelCase Markdown attributes
- Update render-codeblock-toggle.html for snake_case attribute names

* style: standardize @param comment style across all HTML templates

- PascalCase types: {string} → {String}, {boolean} → {Boolean},
  {int} → {Int}, {map} → {Map}, {array} → {Array}
- Add missing ` - ` separator between param name and description
- Remove extra alignment spaces between type and param name

* refactor(params)!: move params.mermaid to page-level, extract gen/ templates

- Move [params.mermaid] to page-level sub-sections
- Mermaid config injected into window.config (per-page override support)
- mermaid.ts reads config from window.config.mermaid instead of parameter
- Create _partials/gen/ directory for JS content generators
- Move mermaid-bootstrap.html from plugin/ to gen/
- Extract window.config JS generation into gen/config.html
- mermaid.html uses param.html for wrapper config

* refactor(params)!: consolidate link_to_* into params.post_link section

- Move link_to_markdown/source/edit/report/vscode into [params.post_link]
- Rename keys: markdown, source, edit, report (bool), editor (string)
- editor defaults to "vscode", supports "trae" etc. via protocol template
- footer.html uses .Param "post_link" for all link toggles
- Remove link_to_* from deprecated keys list

* fix: add fallback for deprecated camelCase attributes and expand deprecation warnings

- render-codeblock-file-tree.html: folderSlash attribute fallback
- render-codeblock-toggle.html: lineNosToggler/lineWrapToggler fallback + warnings
- code-block-wrapper.html: maxShownLines/wrapperClass fallback
- detection-deprecated.html: add nested key warnings for 13 sections
  (header, breadcrumb, navigation, watermark, busuanzi, image, mermaid,
  codeblock, filetree, math.katex, math.mathjax.options, post_summary, footer)
- detection-deprecated.html: add link_guard front matter deprecation warning

* fix(mermaid): fix rendering in hidden tab panels and neutral layer scheduling

- isRenderContextActive: check tab-panel visibility via getBoundingClientRect
  instead of panel.hidden (tab-container uses slot-based hiding, not hidden attr)
- bindTabContainerChanged: render neutral layers when switching tabs so
  print/fallback scenarios work correctly
2026-07-01 22:27:08 +08:00

102 lines
4.3 KiB
HTML

{{- /*
Build structured tree data from filesystem with root path validation
It attempts to resolve the path relative to the root of your project directory.
If a matching directory is not found, it will attempt to resolve the path relative to the contentDir.
A leading path separator (/) is optional.
NOTE: For performance reasons, the recursion depth is limited to 10 levels by default.
@param {String} root - The root path to scan (relative to project root or contentDir)
@param {String} [path] - The directory path for recursive calls
@param {Int} [level=10] - Descend only level directories deep
@param {Int} [deep=0] - Current depth level for recursive calls
@param {Array} [ignore_list] - List of file or folder names to ignore
@param {Boolean} [is_recursive=false] - Internal flag for recursive calls
@param {String} [name] - Project name for the root node, if set to `{path}`, uses the full root path
@param {String} [lang] - Page language for multilingual sites
@param {Boolean} [log=false] - Whether to log warnings
@return {Array} Array of tree items with structure: {name, type, children?}, or empty array if root doesn't exist
*/ -}}
{{- $result := slice -}}
{{- $level := .level | default 10 -}}
{{- $deep := .deep | default 0 -}}
{{- $isRecursive := .is_recursive | default false -}}
{{- $_ignoreList := slice ".DS_Store" "Thumbs.db" ".directory" ".git" "node_modules" "public" -}}
{{- $ignoreList := .ignore_list | default slice | union $_ignoreList -}}
{{- $_debug := eq hugo.Environment "debug" | and hugo.IsServer -}}
{{- if $isRecursive -}}
{{- if le $deep $level -}}
{{- /* Recursive mode: scan directory and build children */ -}}
{{- /* {{- if $_debug -}}{{- warnf "Path%v: %v" $deep .path -}}{{- end -}} */ -}}
{{- $path := .path -}}
{{- $items := readDir $path -}}
{{- range $items -}}
{{- if in $ignoreList .Name -}}
{{- continue -}}
{{- end -}}
{{- $item := dict "name" .Name "type" (cond .IsDir "dir" "file") -}}
{{- if .IsDir -}}
{{- $fullPath := path.Clean (path.Join $path .Name) -}}
{{- $childOptions := dict "path" $fullPath "deep" (add $deep 1) "ignore_list" $ignoreList "is_recursive" true -}}
{{- $children := partial "function/get-file-tree.html" $childOptions -}}
{{- $item = merge $item (dict "children" $children) -}}
{{- end -}}
{{- $result = $result | append $item -}}
{{- end -}}
{{- end -}}
{{- else -}}
{{- /* Initial call: validate root and build tree with root node */ -}}
{{- $root := .root -}}
{{- $rootIsExists := false -}}
{{- if (fileExists $root) -}}
{{- with try (readDir $root) -}}
{{- if .Err }}
{{- /* Attempt to resolve the path relative to the contentDir */ -}}
{{- $contentPath := path.Clean (path.Join "content" $root) -}}
{{- /* If multilingual site, try language-specific content directory */ -}}
{{- if hugo.IsMultilingual -}}
{{- $contentPath = path.Clean (path.Join "content" $.lang $root) -}}
{{- end -}}
{{- with try (readDir $contentPath) -}}
{{- if not .Err }}
{{- $rootIsExists = true -}}
{{- $root = $contentPath -}}
{{- end -}}
{{- end -}}
{{- else -}}
{{- $rootIsExists = true -}}
{{- end -}}
{{- end -}}
{{- end -}}
{{- if $rootIsExists -}}
{{- $f := os.Stat $root -}}
{{- /* Determine the root name for display */ -}}
{{- $rootLabel := .name | default $f.Name -}}
{{- $rootClean := path.Clean $root -}}
{{- if eq .name "{path}" -}}
{{- $rootLabel = $rootClean -}}
{{- end -}}
{{- /* Build children recursively */ -}}
{{- if $_debug -}}{{- warnf "[file-tree]> %v:" $rootLabel -}}{{- end -}}
{{- $childOptions := dict "path" $root "deep" (add $deep 1) "level" $level "ignore_list" $ignoreList "is_recursive" true -}}
{{- $children := partial "function/get-file-tree.html" $childOptions -}}
{{- /* Return root item with children */ -}}
{{- $result = slice (dict "name" $rootLabel "type" "dir" "children" $children) -}}
{{- else -}}
{{- /* Root doesn't exist, emit warning if context provided */ -}}
{{- if .log | default false -}}
{{- warnidf "warning-file-tree" "[get-file-tree]: The root path does not exist: %s." $root -}}
{{- end -}}
{{- end -}}
{{- end -}}
{{- return $result -}}