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

Resolving selfdoc's directives against Dart source: public declarations, doc comments and class members, read with patterns and no Dart toolchain.

#internal/extractors/dart

#internal/extractors/dart

Package dart resolves selfdoc's directives against Dart source.

Nothing from the Dart toolchain is required: the file is read with patterns, which is what lets a documentation build run anywhere the repository is checked out. The four directives it serves are ref, prose-desc, table-schema and table-config.

#What the scanner knows about Dart

A library's public surface is not what one file declares. A part file's declarations belong to the library that declares the part, and a barrel file re-exports what it exports -- transitively, through show and hide combinators, and through both arms of a conditional export. Both are followed, with a visited set so a circular export answers instead of hanging, and local declarations shadow a re-exported name of the same spelling.

Generated files are refused at every level -- as the directive's own target, as a part, and as an export target -- because a name.generator.dart file is a build artifact whose contents restate what the hand-written file already says. The test is the file name: two dots before the extension.

#Extractor

Go go
type Extractor struct

Extractor reads Dart source.

#New

Go go
func New() extractors.Extractor

New builds the Dart extractor.

#Extractor.Detect

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

Detect reports whether dir is a Dart package, by its pubspec.

#Extractor.FileExtensions

Go go
func (e *Extractor) FileExtensions() []string { return []string{".dart"} }

FileExtensions is the one extension Dart source carries.

#Extractor.ResolvePath

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

ResolvePath resolves a directive's path argument to a Dart file or directory.

#Extractor.PublicSymbols

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

PublicSymbols lists what a Dart library exports: its own public top-level declarations, then the ones its part files declare, then the ones it re-exports. A generated file exports nothing.

#Extractor.ModuleDocstring

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

ModuleDocstring is the library-level doc comment at the top of a Dart file.

#Extractor.SymbolDetails

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

SymbolDetails reports what a Dart file says about one function's parameters and return value. A dotted name selects a member of a class, an abstract class or a mixin ("UserRepository.findById").

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