core

package
v1.3.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Apr 22, 2024 License: MIT Imports: 18 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var ErrInvalidConfig = errors.New("invalid config")

Functions

func Listen 

func Listen(in, out chan contracts.Article, handler contracts.Handler)

func StackTraceError added in v0.1.1 

func StackTraceError(inner error) error

Types

type ArticleRenderingHandler 

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

func NewArticleRenderingHandler 

func NewArticleRenderingHandler(
	disk RenderingFileSystem,
	renderer contracts.Renderer,
	output string,
) *ArticleRenderingHandler

func (*ArticleRenderingHandler) Handle 

func (this *ArticleRenderingHandler) Handle(article *contracts.Article)

type BasePathRenderer added in v1.2.0 

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

func NewBasePathRenderer added in v1.2.0 

func NewBasePathRenderer(inner contracts.Renderer, basePath string) *BasePathRenderer

func (*BasePathRenderer) Render added in v1.2.0 

func (this *BasePathRenderer) Render(v any) (string, error)

type CLIParser added in v0.1.1 

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

func NewCLIParser added in v0.1.1 

func NewCLIParser(version string, args []string) *CLIParser

func (*CLIParser) Parse added in v0.1.1 

func (this *CLIParser) Parse() (config contracts.Config, err error)

type ContentConversionHandler added in v0.1.1 

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

func NewContentConversionHandler added in v0.1.1 

func NewContentConversionHandler(inner converter) *ContentConversionHandler

func (*ContentConversionHandler) Handle added in v0.1.1 

func (this *ContentConversionHandler) Handle(article *contracts.Article)

type DraftFilteringHandler 

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

func NewDraftFilteringHandler 

func NewDraftFilteringHandler(enabled bool) *DraftFilteringHandler

func (*DraftFilteringHandler) Handle 

func (this *DraftFilteringHandler) Handle(article *contracts.Article)

type FileReadingHandler 

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

func NewFileReadingHandler 

func NewFileReadingHandler(disk contracts.ReadFile) *FileReadingHandler

func (*FileReadingHandler) Handle 

func (this *FileReadingHandler) Handle(article *contracts.Article)

type FutureFilteringHandler 

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

func NewFutureFilteringHandler 

func NewFutureFilteringHandler(now time.Time, enabled bool) *FutureFilteringHandler

func (*FutureFilteringHandler) Handle 

func (this *FutureFilteringHandler) Handle(article *contracts.Article)

type GoldmarkMarkdownConverter added in v0.1.1 

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

func NewGoldmarkMarkdownConverter added in v0.1.1 

func NewGoldmarkMarkdownConverter() *GoldmarkMarkdownConverter

func (*GoldmarkMarkdownConverter) Convert added in v0.1.1 

func (this *GoldmarkMarkdownConverter) Convert(content string) (string, error)

type ListRenderingHandler added in v1.0.0 

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

func NewListRenderingHandler added in v1.0.0 

func NewListRenderingHandler(
	filter contracts.Filter,
	sorter contracts.Sorter,
	renderer contracts.Renderer,
	disk RenderingFileSystem,
	output, title string,
) *ListRenderingHandler

func (*ListRenderingHandler) Finalize added in v1.0.0 

func (this *ListRenderingHandler) Finalize() error

func (*ListRenderingHandler) Handle added in v1.0.0 

func (this *ListRenderingHandler) Handle(article *contracts.Article)

type MetadataParser 

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

func NewMetadataParser 

func NewMetadataParser(lines []string) *MetadataParser

func (*MetadataParser) Parse 

func (this *MetadataParser) Parse() error

func (*MetadataParser) Parsed 

func (this *MetadataParser) Parsed() contracts.ArticleMetadata

type MetadataParsingHandler 

type MetadataParsingHandler struct{}

func NewMetadataParsingHandler 

func NewMetadataParsingHandler() *MetadataParsingHandler

func (*MetadataParsingHandler) Handle 

func (this *MetadataParsingHandler) Handle(article *contracts.Article)

type MetadataValidationHandler 

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

func NewMetadataValidationHandler 

func NewMetadataValidationHandler() *MetadataValidationHandler

func (*MetadataValidationHandler) Handle 

func (this *MetadataValidationHandler) Handle(article *contracts.Article)

type PathLoader 

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

func NewPathLoader 

func NewPathLoader(
	files contracts.Walk,
	root string,
	output chan contracts.Article,
) *PathLoader

func (*PathLoader) Finalize 

func (this *PathLoader) Finalize() error

func (*PathLoader) Start 

func (this *PathLoader) Start()

type Pipeline added in v0.1.1 

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

func NewPipeline added in v0.1.1 

func NewPipeline(
	clock contracts.Clock,
	config contracts.Config,
	disk contracts.FileSystem,
	renderer contracts.Renderer,
) *Pipeline

func (*Pipeline) Run added in v0.1.1 

func (this *Pipeline) Run() (out chan contracts.Article)

type PipelineRunner added in v0.1.1 

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

func NewPipelineRunner added in v0.1.1 

func NewPipelineRunner(
	version string,
	args []string,
	fs contracts.FileSystem,
	now contracts.Clock,
	log contracts.Logger,
) *PipelineRunner

func (*PipelineRunner) Run added in v0.1.1 

func (this *PipelineRunner) Run() (errors int)

type RenderingFileSystem 

type RenderingFileSystem interface {
	contracts.MkdirAll
	contracts.WriteFile
}

type Reporter added in v0.1.1 

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

func NewReporter added in v0.1.1 

func NewReporter(started time.Time, log contracts.Logger) *Reporter

func (*Reporter) Errors added in v0.1.1 

func (this *Reporter) Errors() int

func (*Reporter) ProcessStream added in v0.1.1 

func (this *Reporter) ProcessStream(out chan contracts.Article)

func (*Reporter) RenderFinalReport added in v0.1.1 

func (this *Reporter) RenderFinalReport(finished time.Time)

type TemplateLoader added in v0.1.1 

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

func NewTemplateLoader added in v0.1.1 

func NewTemplateLoader(disk TemplateLoaderFileSystem, folder string) *TemplateLoader

func (*TemplateLoader) Load added in v0.1.1 

func (this *TemplateLoader) Load() (templates *template.Template, err error)

type TemplateLoaderFileSystem added in v0.1.1 

type TemplateLoaderFileSystem interface {
	contracts.ReadFile
	contracts.Walk
}

type TemplateRenderer added in v0.1.1 

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

func NewTemplateRenderer added in v0.1.1 

func NewTemplateRenderer(templates *template.Template) *TemplateRenderer

func (*TemplateRenderer) Render added in v0.1.1 

func (this *TemplateRenderer) Render(v any) (string, error)

func (*TemplateRenderer) Validate added in v0.1.1 

func (this *TemplateRenderer) Validate() error

type TopicPageRenderingHandler 

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

func NewTopicPageRenderingHandler 

func NewTopicPageRenderingHandler(
	disk RenderingFileSystem,
	renderer contracts.Renderer,
	output string,
) *TopicPageRenderingHandler

func (*TopicPageRenderingHandler) Finalize 

func (this *TopicPageRenderingHandler) Finalize() error

func (*TopicPageRenderingHandler) Handle 

func (this *TopicPageRenderingHandler) Handle(article *contracts.Article)

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.