scanner

package

Go to main page

Versions in this module

v0

v0.35.0

Jun 21, 2026

Changes in this version

+ var ErrDegradedLoad = errors.New("degraded package load")

+ func JSONPointer(segments ...string) string

type EntityDecl

+ func (d *EntityDecl) DefKey() string

+ func (d *EntityDecl) ModelOverrideSuppressed() bool

+ func (d *EntityDecl) SuppressModelOverride()

type Options

+ EmitHierarchicalNames bool

+ EmitRefSiblings bool

+ EmitXGoType bool

+ NameConcatBudget float64

+ OnProvenance func(Provenance)

+ SingleLineCommentAsDescription bool

+ SkipAllOfCompounding bool

+ SkipEnumDescriptions bool

+ type Provenance struct

+ Pointer string

+ Pos token.Position

type ScanCtx

+ func (s *ScanCtx) EmitDiagnostic(d grammar.Diagnostic)

+ func (s *ScanCtx) EmitHierarchicalNames() bool

+ func (s *ScanCtx) EmitRefSiblings() bool

+ func (s *ScanCtx) EmitXGoType() bool

+ func (s *ScanCtx) FileForPos(pkgPath string, pos token.Pos) (*ast.File, bool)

+ func (s *ScanCtx) FindModelsByLeaf(name string) []*EntityDecl

+ func (s *ScanCtx) NameConcatBudget() float64

+ func (s *ScanCtx) OriginEnabled() bool

+ func (s *ScanCtx) ParamOrigin(opID, name string) (token.Position, bool)

+ func (s *ScanCtx) RecordOrigin(pointer string, pos token.Position)

+ func (s *ScanCtx) RecordParamOrigin(opID, name string, pos token.Position)

+ func (s *ScanCtx) SingleLineCommentAsDescription() bool

+ func (s *ScanCtx) SkipAllOfCompounding() bool

+ func (s *ScanCtx) SkipEnumDescriptions() bool

type TypeIndexOption

+ func WithOnDiagnostic(cb func(grammar.Diagnostic)) TypeIndexOption

v0.34.1

Jun 11, 2026

Changes in this version

type Options

+ OnDiagnostic func(grammar.Diagnostic)

type ScanCtx

+ func (s *ScanCtx) AddDiscoveredModel(decl *EntityDecl)

+ func (s *ScanCtx) FileSet() *token.FileSet

+ func (s *ScanCtx) GetModel(pkgPath, name string) (*EntityDecl, bool)

+ func (s *ScanCtx) OnDiagnostic() func(grammar.Diagnostic)

+ func (s *ScanCtx) PosOf(p token.Pos) token.Position

v0.34.0

May 26, 2026

Changes in this version

+ var ErrScanner = errors.New("codescan:scanner")

+ type EntityDecl struct

+ Alias *types.Alias

+ Comments *ast.CommentGroup

+ File *ast.File

+ Ident *ast.Ident

+ Pkg *packages.Package

+ Spec *ast.TypeSpec

+ Type *types.Named

+ func (d *EntityDecl) HasModelAnnotation() bool

+ func (d *EntityDecl) HasParameterAnnotation() bool

+ func (d *EntityDecl) HasResponseAnnotation() bool

+ func (d *EntityDecl) Names() (name, goName string)

+ func (d *EntityDecl) Obj() *types.TypeName

+ func (d *EntityDecl) ObjType() types.Type

+ func (d *EntityDecl) OperationIDs() (result []string)

+ func (d *EntityDecl) ResponseNames() (name, goName string)

+ type Options struct

+ BuildTags string

+ Debug bool

+ DescWithRef bool

+ Exclude []string

+ ExcludeDeps bool

+ ExcludeTags []string

+ Include []string

+ IncludeTags []string

+ InputSpec *spec.Swagger

+ Packages []string

+ RefAliases bool

+ ScanModels bool

+ SetXNullableForPointers bool

+ SkipExtensions bool

+ TransparentAliases bool

+ WorkDir string

+ type ScanCtx struct

+ func NewScanCtx(opts *Options) (*ScanCtx, error)

+ func (s *ScanCtx) Debug() bool

+ func (s *ScanCtx) DeclForType(t types.Type) (*EntityDecl, bool)

+ func (s *ScanCtx) DescWithRef() bool

+ func (s *ScanCtx) ExtraModels() iter.Seq2[*ast.Ident, *EntityDecl]

+ func (s *ScanCtx) FindComments(pkg *packages.Package, name string) (*ast.CommentGroup, bool)

+ func (s *ScanCtx) FindDecl(pkgPath, name string) (*EntityDecl, bool)

+ func (s *ScanCtx) FindEnumValues(pkg *packages.Package, enumName string) (list []any, descList []string, _ bool)

+ func (s *ScanCtx) FindModel(pkgPath, name string) (*EntityDecl, bool)

+ func (s *ScanCtx) Meta() iter.Seq[parsers.MetaSection]

+ func (s *ScanCtx) Models() iter.Seq2[*ast.Ident, *EntityDecl]

+ func (s *ScanCtx) MoveExtraToModel(k *ast.Ident)

+ func (s *ScanCtx) NumExtraModels() int

+ func (s *ScanCtx) Operations() iter.Seq[parsers.ParsedPathContent]

+ func (s *ScanCtx) Parameters() iter.Seq[*EntityDecl]

+ func (s *ScanCtx) PkgForType(t types.Type) (*packages.Package, bool)

+ func (s *ScanCtx) RefAliases() bool

+ func (s *ScanCtx) Responses() iter.Seq[*EntityDecl]

+ func (s *ScanCtx) Routes() iter.Seq[parsers.ParsedPathContent]

+ func (s *ScanCtx) SetXNullableForPointers() bool

+ func (s *ScanCtx) SkipExtensions() bool

+ func (s *ScanCtx) TransparentAliases() bool

+ type TypeIndex struct

+ AllPackages map[string]*packages.Package

+ ExtraModels map[*ast.Ident]*EntityDecl

+ Meta []parsers.MetaSection

+ Models map[*ast.Ident]*EntityDecl

+ Operations []parsers.ParsedPathContent

+ Parameters []*EntityDecl

+ Responses []*EntityDecl

+ Routes []parsers.ParsedPathContent

+ func NewTypeIndex(pkgs []*packages.Package, opts ...TypeIndexOption) (*TypeIndex, error)

+ type TypeIndexOption func(*TypeIndex)

+ func WithDebug(enabled bool) TypeIndexOption

+ func WithExcludeDeps(excluded bool) TypeIndexOption

+ func WithExcludePkgs(excluded []string) TypeIndexOption

+ func WithExcludeTags(excluded map[string]bool) TypeIndexOption

+ func WithIncludePkgs(included []string) TypeIndexOption

+ func WithIncludeTags(included map[string]bool) TypeIndexOption

+ func WithRefAliases(enabled bool) TypeIndexOption

+ func WithTransparentAliases(enabled bool) TypeIndexOption

+ func WithXNullableForPointers(enabled bool) TypeIndexOption

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL