source

Documentation

Index

• type Dirs
  • func NewDirs(fs *hugofs.Fs, cfg config.Provider, logger *jww.Notepad) (*Dirs, error)
  • func (d *Dirs) CreateStaticFs() (afero.Fs, error)
  • func (d *Dirs) IsStatic(filename string) bool
  • func (d *Dirs) MakeStaticPathRelative(filename string) string
• type File
• type FileInfo
  • func (fi *FileInfo) BaseFileName() string
  • func (fi *FileInfo) Bytes() []byte
  • func (fi *FileInfo) Dir() string
  • func (fi *FileInfo) Ext() string
  • func (fi *FileInfo) Extension() string
  • func (fi *FileInfo) FileInfo() os.FileInfo
  • func (fi *FileInfo) Filename() string
  • func (fi *FileInfo) Lang() string
  • func (fi *FileInfo) LogicalName() string
  • func (fi *FileInfo) Open() (io.ReadCloser, error)
  • func (fi *FileInfo) Path() string
  • func (fi *FileInfo) Section() string
  • func (fi *FileInfo) String() string
  • func (fi *FileInfo) TranslationBaseName() string
  • func (fi *FileInfo) UniqueID() string
• type Filesystem
  • func (f *Filesystem) Files() []ReadableFile
• type Input
• type ReadableFile
• type SourceSpec
  • func NewSourceSpec(cfg config.Provider, fs *hugofs.Fs) *SourceSpec
  • func (s *SourceSpec) IgnoreFile(filename string) bool
  • func (s *SourceSpec) IsRegularSourceFile(filename string) (bool, error)
  • func (sp *SourceSpec) NewFileInfo(baseDir, filename string, fi os.FileInfo) *FileInfo
  • func (sp SourceSpec) NewFilesystem(base string) *Filesystem

Types

type Dirs

type Dirs struct {
	AbsStaticDirs []string

	Language *helpers.Language
	// contains filtered or unexported fields
}

Dirs holds the source directories for a given build. In case where there are more than one of a kind, the order matters: It will be used to construct a union filesystem, so the right-most directory will "win" on duplicates. Typically, the theme version will be the first.

func NewDirs

func NewDirs(fs *hugofs.Fs, cfg config.Provider, logger *jww.Notepad) (*Dirs, error)

NewDirs creates a new dirs with the given configuration and filesystem.

func (*Dirs) CreateStaticFs

func (d *Dirs) CreateStaticFs() (afero.Fs, error)

CreateStaticFs will create a union filesystem with the static paths configured. Any missing directories will be logged as warnings.

func (*Dirs) IsStatic

func (d *Dirs) IsStatic(filename string) bool

IsStatic returns whether the given filename is located in one of the static source dirs.

func (*Dirs) MakeStaticPathRelative

func (d *Dirs) MakeStaticPathRelative(filename string) string

MakeStaticPathRelative creates a relative path from the given filename. It will return an empty string if the filename is not a member of dirs.

type File

type File interface {

	// Filename gets the full path and filename to the file.
	Filename() string

	// Path gets the relative path including file name and extension.
	// The directory is relative to the content root.
	Path() string

	// Dir gets the name of the directory that contains this file.
	// The directory is relative to the content root.
	Dir() string

	// Extension gets the file extension, i.e "myblogpost.md" will return "md".
	Extension() string
	// Ext is an alias for Extension.
	Ext() string // Hmm... Deprecate Extension

	// Lang for this page, if `Multilingual` is enabled on your site.
	Lang() string

	// LogicalName is filename and extension of the file.
	LogicalName() string

	// Section is first directory below the content root.
	Section() string

	// BaseFileName is a filename without extension.
	BaseFileName() string

	// TranslationBaseName is a filename with no extension,
	// not even the optional language extension part.
	TranslationBaseName() string

	// UniqueID is the MD5 hash of the file's path and is for most practical applications,
	// Hugo content files being one of them, considered to be unique.
	UniqueID() string

	FileInfo() os.FileInfo

	String() string

	// Deprecated
	Bytes() []byte
}

type FileInfo

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

func (*FileInfo) BaseFileName

func (fi *FileInfo) BaseFileName() string

func (*FileInfo) Bytes

func (fi *FileInfo) Bytes() []byte

func (*FileInfo) Dir

func (fi *FileInfo) Dir() string

func (*FileInfo) Ext

func (fi *FileInfo) Ext() string

func (*FileInfo) Extension

func (fi *FileInfo) Extension() string

func (*FileInfo) FileInfo

func (fi *FileInfo) FileInfo() os.FileInfo

func (*FileInfo) Filename

func (fi *FileInfo) Filename() string

func (*FileInfo) Lang

func (fi *FileInfo) Lang() string

func (*FileInfo) LogicalName

func (fi *FileInfo) LogicalName() string

func (*FileInfo) Open

func (fi *FileInfo) Open() (io.ReadCloser, error)

Open implements ReadableFile.

func (*FileInfo) Path

func (fi *FileInfo) Path() string

func (*FileInfo) Section

func (fi *FileInfo) Section() string

func (*FileInfo) String

func (fi *FileInfo) String() string

func (*FileInfo) TranslationBaseName

func (fi *FileInfo) TranslationBaseName() string

func (*FileInfo) UniqueID

func (fi *FileInfo) UniqueID() string

type Filesystem

type Filesystem struct {
	Base string

	SourceSpec
	// contains filtered or unexported fields
}

func (*Filesystem) Files

func (f *Filesystem) Files() []ReadableFile

type Input

type Input interface {
	Files() []ReadableFile
}

type ReadableFile

type ReadableFile interface {
	File
	Open() (io.ReadCloser, error)
}

A ReadableFile is a File that is readable.

type SourceSpec

type SourceSpec struct {
	Cfg config.Provider
	Fs  *hugofs.Fs

	Languages              map[string]interface{}
	DefaultContentLanguage string
	// contains filtered or unexported fields
}

SourceSpec abstracts language-specific file creation. TODO(bep) rename to Spec

func NewSourceSpec

func NewSourceSpec(cfg config.Provider, fs *hugofs.Fs) *SourceSpec

NewSourceSpec initializes SourceSpec using languages from a given configuration.

func (*SourceSpec) IgnoreFile

func (s *SourceSpec) IgnoreFile(filename string) bool

func (*SourceSpec) IsRegularSourceFile

func (s *SourceSpec) IsRegularSourceFile(filename string) (bool, error)

func (*SourceSpec) NewFileInfo

func (sp *SourceSpec) NewFileInfo(baseDir, filename string, fi os.FileInfo) *FileInfo

func (SourceSpec) NewFilesystem

func (sp SourceSpec) NewFilesystem(base string) *Filesystem