stego-cli 0.4.2 → 0.5.0

package/filters/image-layout.lua

@@ -0,0 +1,170 @@
+local function get_image_attr(img, key)
+  if not img or not img.attributes then
+    return nil
+  end
+  local value = img.attributes[key]
+  if value == nil or value == "" then
+    return nil
+  end
+  return value
+end
+
+local function get_layout(img)
+  local layout = get_image_attr(img, "layout") or get_image_attr(img, "data-layout")
+  if layout == "block" or layout == "inline" then
+    return layout
+  end
+  return nil
+end
+
+local function get_align(img)
+  local align = get_image_attr(img, "align") or get_image_attr(img, "data-align")
+  if align == "left" or align == "center" or align == "right" then
+    return align
+  end
+  return nil
+end
+
+local function extract_single_image(block)
+  if not block or not (block.t == "Para" or block.t == "Plain") then
+    return nil
+  end
+  if #block.content ~= 1 then
+    return nil
+  end
+  local img = block.content[1]
+  if not img or img.t ~= "Image" then
+    return nil
+  end
+  return img
+end
+
+local function append_css_rule(existing, rule)
+  if not rule or rule == "" then
+    return existing
+  end
+  if not existing or existing == "" then
+    return rule
+  end
+  if existing:match(rule, 1, true) then
+    return existing
+  end
+  return existing .. " " .. rule
+end
+
+local function apply_html_layout_alignment(img)
+  local layout = get_layout(img)
+  local align = get_align(img)
+  if not layout and not align then
+    return img
+  end
+
+  local effective_layout = layout
+  if not effective_layout and align then
+    effective_layout = "block"
+  end
+
+  local style = get_image_attr(img, "style") or ""
+
+  if effective_layout == "block" then
+    style = append_css_rule(style, "display:block;")
+  elseif effective_layout == "inline" then
+    style = append_css_rule(style, "display:inline;")
+  end
+
+  if effective_layout ~= "inline" then
+    if align == "left" then
+      style = append_css_rule(style, "margin-left:0; margin-right:auto;")
+    elseif align == "right" then
+      style = append_css_rule(style, "margin-left:auto; margin-right:0;")
+    elseif align == "center" then
+      style = append_css_rule(style, "margin-left:auto; margin-right:auto;")
+    end
+  end
+
+  if style ~= "" then
+    img.attributes["style"] = style
+  end
+
+  return img
+end
+
+local function wrap_latex_image_alignment(block, align)
+  if not align then
+    return block
+  end
+
+  local code = nil
+  if align == "left" then
+    code = "l"
+  elseif align == "center" then
+    code = "c"
+  elseif align == "right" then
+    code = "r"
+  end
+  if not code then
+    return block
+  end
+
+  table.insert(block.content, 1, pandoc.RawInline("latex", "\\makebox[\\linewidth][" .. code .. "]{"))
+  table.insert(block.content, pandoc.RawInline("latex", "}"))
+  return block
+end
+
+function Image(img)
+  if FORMAT:match("html") or FORMAT:match("epub") or FORMAT:match("revealjs") then
+    return apply_html_layout_alignment(img)
+  end
+  return img
+end
+
+function Figure(fig)
+  if not FORMAT:match("latex") then
+    return nil
+  end
+
+  if #fig.content ~= 1 then
+    return nil
+  end
+
+  local block = fig.content[1]
+  local img = extract_single_image(block)
+  if not img then
+    return nil
+  end
+
+  local layout = get_layout(img)
+  local align = get_align(img)
+  if not layout and not align then
+    return nil
+  end
+
+  if layout == "inline" then
+    return pandoc.Para({ img })
+  end
+
+  fig.content[1] = wrap_latex_image_alignment(block, align)
+  return fig
+end
+
+function Para(para)
+  if not FORMAT:match("latex") then
+    return nil
+  end
+
+  local img = extract_single_image(para)
+  if not img then
+    return nil
+  end
+
+  local layout = get_layout(img)
+  local align = get_align(img)
+  if layout == "inline" then
+    return nil
+  end
+
+  if align then
+    return wrap_latex_image_alignment(para, align)
+  end
+  return nil
+end

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "stego-cli",
-  "version": "0.4.2",
+  "version": "0.5.0",
   "type": "module",
   "description": "Installable CLI for the Stego writing monorepo workflow.",
   "license": "Apache-2.0",
@@ -21,6 +21,7 @@
   },
   "files": [
     "dist/**",
+    "filters/**",
     "projects/**",
     "!projects/local-only/**",
     "!projects/*/dist/*.md",
@@ -52,9 +53,10 @@
     "test:compile-structure": "node --test tools/test/compile-structure.test.mjs",
     "test:comments": "node --test tools/test/comments-add.test.mjs",
     "test:cli-core": "node --test tools/test/cli-core.test.mjs",
+    "test:image-support": "node --test tools/test/image-support.test.mjs",
     "test:spine-v2": "node --test tools/test/spine-v2.test.mjs",
     "test:workspace-project": "node --test tools/test/workspace-project.test.mjs",
-    "test": "npm run test:compile-structure && npm run test:comments && npm run test:cli-core && npm run test:spine-v2 && npm run test:workspace-project && npm run check:module-apis && npm run check:boundaries",
+    "test": "npm run test:compile-structure && npm run test:comments && npm run test:cli-core && npm run test:image-support && npm run test:spine-v2 && npm run test:workspace-project && npm run check:module-apis && npm run check:boundaries",
     "check:boundaries": "node scripts/check-module-boundaries.mjs",
     "check:module-apis": "node scripts/check-module-apis.mjs"
   },

package/projects/fiction-example/assets/README.md

@@ -0,0 +1,31 @@
+# Assets
+
+Store manuscript images in this directory (or nested subdirectories).
+
+Reference them from manuscript files with Markdown image syntax, for example:
+
+```md
+![Map](../assets/maps/city-plan.png)
+```
+
+Set global image defaults in `stego-project.json`:
+
+```json
+{
+  "images": {
+    "layout": "block",
+    "align": "center",
+    "width": "50%"
+  }
+}
+```
+
+Use manuscript frontmatter `images` only for per-path overrides:
+
+```yaml
+images:
+  assets/maps/city-plan.png:
+    layout: inline
+    align: left
+    width: 100%
+```

package/projects/stego-docs/assets/README.md

@@ -0,0 +1,31 @@
+# Assets
+
+Store manuscript images in this directory (or nested subdirectories).
+
+Reference them from manuscript files with Markdown image syntax, for example:
+
+```md
+![Diagram](../assets/diagrams/system-overview.png)
+```
+
+Set global image defaults in `stego-project.json`:
+
+```json
+{
+  "images": {
+    "layout": "block",
+    "align": "center",
+    "width": "60%"
+  }
+}
+```
+
+Use manuscript frontmatter `images` only for per-path overrides:
+
+```yaml
+images:
+  assets/diagrams/system-overview.png:
+    layout: inline
+    align: left
+    width: 100%
+```

package/projects/stego-docs/manuscript/500-project-configuration.md

@@ -41,6 +41,43 @@ Stego reports missing keys as warnings so teams can standardize frontmatter with
 
 Common keys include `status`, grouping fields such as `chapter`, and project-specific metadata such as point of view or timeline.
 
+## Manuscript image settings
+
+Stego projects use `assets/` for local manuscript images.
+
+Project-level image defaults belong in `stego-project.json`:
+
+```json
+{
+  "images": {
+    "layout": "block",
+    "align": "center",
+    "width": "50%",
+    "classes": ["illustration"]
+  }
+}
+```
+
+Manuscript files can define per-path overrides with `images` frontmatter:
+
+```yaml
+images:
+  assets/maps/city-plan.png:
+    layout: inline
+    align: left
+    width: 100%
+```
+
+Global keys are `width`, `height`, `classes`, `id`, `attrs`, `layout`, and `align`, but those defaults should be set in project config.
+
+All manuscript-frontmatter keys under `images` are treated as per-image overrides by project-relative asset path.
+
+`layout` and `align` are emitted in compiled markdown as `data-layout` and `data-align` image attrs.
+
+When the same image also has inline Pandoc attrs in markdown, inline attrs win.
+
+Validation warns if a local image target is outside `assets/`.
+
 ## Compile structure
 
 Projects can define `compileStructure.levels` to group manuscript files during build.

package/projects/stego-docs/manuscript/800-build-export-and-release-outputs.md

@@ -36,6 +36,10 @@ Generated files in `dist/` should not be hand-edited.
 
 `stego export` supports markdown output directly and optional richer formats through Pandoc, including docx, pdf, and epub.
 
+For local manuscript images, keep files in `assets/`. Stego exports with project-aware resource paths so image references in compiled markdown can resolve during Pandoc conversion.
+
+EPUB exports include a default stylesheet for image layout metadata (`data-layout` and `data-align`), so block/inline and left/center/right image alignment rules apply without extra setup.
+
 If you export pdf through Pandoc, you also need a compatible PDF engine installed on your machine.
 
 ## Recommended release sequence

package/dist/stego-cli/src/modules/manuscript/domain/manuscript.js

@@ -1 +0,0 @@
-export {};

package/dist/stego-cli/src/modules/project/domain/project.js

@@ -1 +0,0 @@
-export {};