bash

Documentation

Index

• type BashExtractor
  • func NewBashExtractor(runner site.CommandRunner) *BashExtractor
  • func (b *BashExtractor) Extract(ctx context.Context, req *extractors.ExtractRequest) (*extractors.ExtractResult, error)
  • func (b *BashExtractor) Language() extractors.Language
  • func (b *BashExtractor) Validate(ctx context.Context) error

Types

type BashExtractor

type BashExtractor struct {
	// contains filtered or unexported fields
}

BashExtractor extracts documentation from Bash scripts

func NewBashExtractor

func NewBashExtractor(runner site.CommandRunner) *BashExtractor

NewBashExtractor creates a new Bash documentation extractor

func (*BashExtractor) Extract

func (b *BashExtractor) Extract(ctx context.Context, req *extractors.ExtractRequest) (*extractors.ExtractResult, error)

Extract generates documentation from Bash scripts

func (*BashExtractor) Language

func (b *BashExtractor) Language() extractors.Language

Language returns the language this extractor handles

func (*BashExtractor) Validate

func (b *BashExtractor) Validate(ctx context.Context) error

Validate checks if Bash is available.

Only a genuine lookup failure means bash is unavailable; a bash that is installed and exits non-zero is an extraction error, not a skip.