materialize-base: Instructions file for Codex

Repository Guidelines

This is a Deno CLI to read Obsidian Bases files, and query an Obsidian vault accordingly, and return the output in markdown. Obsidian provides no API for this, so we're doing it ourselves.

Scraped Obsidian Bases docs are all provided in obsidian-base-docs/.

Project Structure & Module Organization

Core CLI logic lives in module.ts, which wires together runtime flags and orchestrates vault queries. Supporting utilities sit under src/, e.g. src/materalize.ts for query planning, src/parse-file.ts for Obsidian markdown ingestion, and src/types.ts for shared interfaces. Tests reside in test/ as *.test.ts files mirroring their source counterparts. Scraped reference material is kept in obsidian-base-docs/; treat it as read-only documentation inputs. Configuration for tasks, formatting, and dependency imports is centralized in deno.json.

Documentation

• README.md covers CLI usage, expected permissions, and the --vault and --view flags for controlling output.
• vendor/SKILL.md mirrors the CLI instructions for the Claude skill variant and reiterates the optional --vault override.
• obsidian-base-docs/ stores scraped Obsidian Bases documentation for reference only; do not modify.

Build, Test, and Development Commands

• deno task check: Run formatter, linter, and type-check to keep the codebase healthy.
• deno task test: Execute all unit tests under test/.
• deno task coverage: Generate coverage data into cov_profile/ and report totals.
• deno task demo: Try the CLI end-to-end with a local base definition.

Coding Style & Naming Conventions

Default to 2-space indentation and rely on deno fmt for layout. Prefer TypeScript readonly modifiers for data passed across modules, and use explicit return types on exported functions. Follow camelCase for variables and functions, PascalCase for types and classes, and kebab-case for new filenames. Imports should be relative within src/ and managed via deno.json when pulling from @std.