Skip to content
internal/extractors/zig
Updated
On this page

Reading Zig source: the public declarations a file exports, their doc comments and their test blocks, grouped into a reference page by declaration kind.

#internal/extractors/zig

#internal/extractors/zig

Package zig reads Zig source for selfdoc.

It answers directives by scanning source text with regular expressions rather than by parsing it: no Zig toolchain is required, and a file that does not compile still documents. What it reads out of a file is the module's //! documentation, the public declarations -- functions including the extern, export and inline forms, constants whatever their right side is, and variables -- with the /// comment block above each, the fields of a public struct, and the file's test blocks.

#New

Go go
func New() extractors.Extractor

New builds the Zig extractor. It spawns nothing and writes nothing, it only reads source files.

#extractor.Detect

Go go
func (e *extractor) Detect(dir string) bool

Detect reports whether dir is a Zig project, by its build script or that script's dependency manifest.

#extractor.ResolvePath

Go go
func (e *extractor) ResolvePath(pathArg string, sourcePaths []string, baseDir string) string

ResolvePath resolves a directive's path argument to a Zig source file or to a directory of them.

#extractor.FileExtensions

Go go
func (e *extractor) FileExtensions() []string

FileExtensions lists the extensions the build walks a Zig source tree for.

#extractor.PublicSymbols

Go go
func (e *extractor) PublicSymbols(file string) ([]string, error)

PublicSymbols lists the public declarations of a Zig source file, in source order.

A private declaration -- one without "pub" -- is not public API and is not reported, and neither is a test block.

#extractor.ModuleDocstring

Go go
func (e *extractor) ModuleDocstring(path string) (string, error)

ModuleDocstring is a file's //! module documentation.

#extractor.SymbolDetails

Go go
func (e *extractor) SymbolDetails(file, symbol string) (*extractors.SymbolDetails, error)

SymbolDetails reports what a file says about one function's parameters and return value. A dotted name selects a member of a container type ("Config.init").

More tools from this site

  • claudestream Drive Claude Code from Python: run it as a subprocess and read its output as typed events, with async and sync sessions, sandbox policies, and tools you define in Python
  • claudewheel A TUI Claude Code Launcher that lets you have more than one profile, manage sessions lifecycle, pick the exact CC version, model to use (even older unlisted ones), pick which GitHub account to use, etc.
  • dirstat Fast, single-binary directory statistics CLI: every file under a tree grouped by format, with counts, sizes, and lines of code, as a colored terminal table or as JSON
  • fastware A batteries-included ASGI framework: msgspec JSON, a managed Granian server, dependency injection, SSE, WebSockets, auth, and a test client
  • go-toml-edit Zero-dep TOML editing library for Go with comment preservation
  • howmuchleft The fastest Claude Code statusline: context window, 5-hour, and weekly limit usage as three customizable gradient bars, rendering in about 6 ms
  • orxtra
  • pgdesign
  • predraw Declarative rendering pipeline: describe a scene in JSON and get SVG, PNG and WebP out, with light and dark style tokens, reusable components and text converted to path outlines
  • reposummary Turn a git repository's history into a Markdown journal: pick a time window or revision range and get a readable digest of what changed, optionally narrated by an LLM
  • rlsbl Release orchestration and project scaffolding CLI that bumps versions, validates a structured JSONL changelog, tags only the commit CI verified, and publishes to npm, PyPI, Go and more
  • safegit git wrapper CLI that gives each commit its own temporary index and retries ref updates on conflict, so concurrent agents share one repository
  • saferm Command-line replacement for rm that archives every deletion with a mandatory reason and the context it ran in, so deleted files can be listed, inspected and restored
  • strictcli
  • stricttest An always-on test-isolation floor: a pytest plugin and a Go env-hygiene module that make a test suite structurally unable to reach real credentials, the real HOME, the network, or the development repository.
  • wesktop A Python framework that turns an ASGI web app into a desktop application, serving it from a local Granian server and displaying it in a native OS window via pywebview
Search