Directories
¶
| Path | Synopsis |
|---|---|
|
Package benchmarks measures what a scan costs, on two generated projects that ship with this repository.
|
Package benchmarks measures what a scan costs, on two generated projects that ship with this repository. |
|
corpus
Package corpus resolves the trees the benchmarks measure.
|
Package corpus resolves the trees the benchmarks measure. |
|
corpus/unpack
command
Command unpack makes the benchmark corpora available on disk and prints where they are, one `name<TAB>directory` line per corpus.
|
Command unpack makes the benchmark corpora available on disk and prints where they are, one `name<TAB>directory` line per corpus. |
|
loader-benchmark
command
Command loader-benchmark measures one codescan scan and reports what it cost.
|
Command loader-benchmark measures one codescan scan and reports what it cost. |
|
builders
|
|
|
common
Package common holds shared per-Builder state every concrete per-decl builder (schema, parameters, responses, routes, operations, spec) embeds.
|
Package common holds shared per-Builder state every concrete per-decl builder (schema, parameters, responses, routes, operations, spec) embeds. |
|
godoclink
Package godoclink rewrites godoc-specific syntax.
|
Package godoclink rewrites godoc-specific syntax. |
|
handlers
Package handlers ships shared grammar Walker callbacks for the SimpleSchema and full-Schema families of OAS v2 dispatchers.
|
Package handlers ships shared grammar Walker callbacks for the SimpleSchema and full-Schema families of OAS v2 dispatchers. |
|
validations
Package validations owns cross-builder validation and coercion concerns shared by the schema, parameters, responses, and items/headers code paths.
|
Package validations owns cross-builder validation and coercion concerns shared by the schema, parameters, responses, and items/headers code paths. |
|
Package exportdata optionally carries dependencies' export data inside the binary.
|
Package exportdata optionally carries dependencies' export data inside the binary. |
|
Package ifaces defines the internal interfaces that decouple the comment-parsing pipeline from the concrete Swagger spec builders.
|
Package ifaces defines the internal interfaces that decouple the comment-parsing pipeline from the concrete Swagger spec builders. |
|
Package integration provides integration tests.
|
Package integration provides integration tests. |
|
Package packages loads and type-checks the Go packages codescan scans.
|
Package packages loads and type-checks the Go packages codescan scans. |
|
list
Package list answers the question `go list` answers: given a pattern or an import path, which directory holds that package, and what is it called.
|
Package list answers the question `go list` answers: given a pattern or an import path, which directory holds that package, and what is it called. |
|
vfs
Package vfs is the loader's single point of filesystem contact.
|
Package vfs is the loader's single point of filesystem contact. |
|
grammar
Package grammar is the annotation parser for codescan.
|
Package grammar is the annotation parser for codescan. |
|
routebody
Package routebody parses the body sub-language of swagger:route / swagger:operation `Parameters:` and `Responses:` raw blocks.
|
Package routebody parses the body sub-language of swagger:route / swagger:operation `Parameters:` and `Responses:` raw blocks. |
|
security
Package security is the sub-parser for the `Security:` block body that appears under `swagger:meta`, `swagger:route` and `swagger:operation`.
|
Package security is the sub-parser for the `Security:` block body that appears under `swagger:meta`, `swagger:route` and `swagger:operation`. |
|
yaml
Package yaml is a thin wrapper around go.yaml.in/yaml/v3 for consuming the RawYAML bodies that internal/parsers/grammar/ isolates between `---` fences, plus the typed-extensions service the grammar lexer calls for `extensions:` raw blocks.
|
Package yaml is a thin wrapper around go.yaml.in/yaml/v3 for consuming the RawYAML bodies that internal/parsers/grammar/ isolates between `---` fences, plus the typed-extensions service the grammar lexer calls for `extensions:` raw blocks. |
|
classify
Package classify provides small classification predicates used by the scanner and by builders to decide whether a given name or comment line belongs to a particular Swagger-annotation family.
|
Package classify provides small classification predicates used by the scanner and by builders to decide whether a given name or comment line belongs to a particular Swagger-annotation family. |
|
Package scantest exposes utilities for testing the codescan packages.
|
Package scantest exposes utilities for testing the codescan packages. |
|
mocks
Package mocks contains mock types for all interfaces.
|
Package mocks contains mock types for all interfaces. |
|
Package testloader carries the one setting that decides which loader a test run uses.
|
Package testloader carries the one setting that decides which loader a test run uses. |
Click to show internal directories.
Click to hide internal directories.