hugofs

package
v0.55.0 Latest Latest
Warning

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

 Go to latest Published: Apr 8, 2019 License: Apache-2.0 Imports: 17 Imported by: 242

Documentation

Overview

Package hugofs provides the file systems used by Hugo.

Index

Constants

This section is empty.

Variables

View Source 
var LanguageDirsMerger = func(lofi, bofi []os.FileInfo) ([]os.FileInfo, error) {
	m := make(map[string]*LanguageFileInfo)

	for _, fi := range lofi {
		fil, ok := fi.(*LanguageFileInfo)
		if !ok {
			return nil, fmt.Errorf("received %T, expected *LanguageFileInfo", fi)
		}
		m[fil.virtualName] = fil
	}

	for _, fi := range bofi {
		fil, ok := fi.(*LanguageFileInfo)
		if !ok {
			return nil, fmt.Errorf("received %T, expected *LanguageFileInfo", fi)
		}
		existing, found := m[fil.virtualName]

		if !found || existing.weight < fil.weight {
			m[fil.virtualName] = fil
		}
	}

	merged := make([]os.FileInfo, len(m))
	i := 0
	for _, v := range m {
		merged[i] = v
		i++
	}

	return merged, nil
}

LanguageDirsMerger implements the afero.DirsMerger interface, which is used to merge two directories.

View Source 
var (

	// NoOpFs provides a no-op filesystem that implements the afero.Fs
	// interface.
	NoOpFs = &noOpFs{}
)
View Source 
var Os = &afero.OsFs{}

Os points to an Os Afero file system.

Functions

func NewCreateCountingFs added in v0.55.0 

func NewCreateCountingFs(fs afero.Fs) afero.Fs

func NewHashingFs added in v0.45.1 

func NewHashingFs(delegate afero.Fs, hashReceiver FileHashReceiver) afero.Fs

NewHashingFs creates a new filesystem that will receive MD5 checksums of any written file content on Close. Note that this is probably not a good idea for "full build" situations, but when doing fast render mode, the amount of files published is low, and it would be really nice to know exactly which of these files where actually changed. Note that this will only work for file operations that use the io.Writer to write content to file, but that is fine for the "publish content" use case.

func NewLanguageCompositeFs added in v0.38.1 

func NewLanguageCompositeFs(base afero.Fs, overlay *LanguageFs) afero.Fs

NewLanguageCompositeFs creates a composite and language aware filesystem. This is a hybrid filesystem. To get a specific file in Open, Stat etc., use the full filename to the target filesystem. This information is available in Readdir, Stat etc. via the special LanguageFileInfo FileInfo implementation.

func NewNoLstatFs added in v0.49.1 

func NewNoLstatFs(fs afero.Fs) afero.Fs

NewNoLstatFs creates a new filesystem with no Lstat support.

func NewStacktracerFs added in v0.55.0 

func NewStacktracerFs(fs afero.Fs, pattern string) afero.Fs

NewStacktracerFs wraps the given fs printing stack traces for file creates matching the given regexp pattern.

Types

type BasePathRealFilenameFs added in v0.45.1 

type BasePathRealFilenameFs struct {
	*afero.BasePathFs
}

BasePathRealFilenameFs is a thin wrapper around afero.BasePathFs that provides the real filename in Stat and LstatIfPossible.

func NewBasePathRealFilenameFs added in v0.45.1 

func NewBasePathRealFilenameFs(base *afero.BasePathFs) *BasePathRealFilenameFs

NewBasePathRealFilenameFs returns a new BasePathRealFilenameFs instance using base.

func (*BasePathRealFilenameFs) LstatIfPossible added in v0.45.1 

func (b *BasePathRealFilenameFs) LstatIfPossible(name string) (os.FileInfo, bool, error)

LstatIfPossible returns the os.FileInfo structure describing a given file. It attempts to use Lstat if supported or defers to the os. In addition to the FileInfo, a boolean is returned telling whether Lstat was called.

func (*BasePathRealFilenameFs) Stat added in v0.45.1 

func (b *BasePathRealFilenameFs) Stat(name string) (os.FileInfo, error)

Stat returns the os.FileInfo structure describing a given file. If there is an error, it will be of type *os.PathError.

type DuplicatesReporter added in v0.55.0 

type DuplicatesReporter interface {
	ReportDuplicates() string
}

DuplicatesReporter reports about duplicate filenames.

type FileHashReceiver added in v0.45.1 

type FileHashReceiver interface {
	OnFileClose(name, md5sum string)
}

FileHashReceiver will receive the filename an the content's MD5 sum on file close.

type FilePather added in v0.38.1 

type FilePather interface {
	// Filename gets the full path and filename to the file.
	Filename() string

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

	// RealName is FileInfo.Name in its original form.
	RealName() string

	BaseDir() string
}

FilePather is aware of its file's location.

type Fs added in v0.20.1 

type Fs struct {
	// Source is Hugo's source file system.
	Source afero.Fs

	// Destination is Hugo's destination file system.
	Destination afero.Fs

	// Os is an OS file system.
	// NOTE: Field is currently unused.
	Os afero.Fs

	// WorkingDir is a read-only file system
	// restricted to the project working dir.
	WorkingDir *afero.BasePathFs
}

Fs abstracts the file system to separate source and destination file systems and allows both to be mocked for testing.

func NewDefault added in v0.20.1 

func NewDefault(cfg config.Provider) *Fs

NewDefault creates a new Fs with the OS file system as source and destination file systems.

func NewFrom added in v0.20.1 

func NewFrom(fs afero.Fs, cfg config.Provider) *Fs

NewFrom creates a new Fs based on the provided Afero Fs as source and destination file systems. Useful for testing.

func NewMem added in v0.20.1 

func NewMem(cfg config.Provider) *Fs

NewMem creates a new Fs with the MemMapFs as source and destination file systems. Useful for testing.

type LanguageAnnouncer added in v0.38.1 

type LanguageAnnouncer interface {
	Lang() string
	TranslationBaseName() string
}

LanguageAnnouncer is aware of its language.

type LanguageFileInfo added in v0.38.1 

type LanguageFileInfo struct {
	os.FileInfo
	// contains filtered or unexported fields
}

LanguageFileInfo is a super-set of os.FileInfo with additional information about the file in relation to its Hugo language.

func (*LanguageFileInfo) BaseDir added in v0.38.1 

func (fi *LanguageFileInfo) BaseDir() string

BaseDir returns a file's base directory (ie. "/my/base").

func (*LanguageFileInfo) Filename added in v0.38.1 

func (fi *LanguageFileInfo) Filename() string

Filename returns a file's real filename including the base (ie. "/my/base/sect/page.md").

func (*LanguageFileInfo) Lang added in v0.38.1 

func (fi *LanguageFileInfo) Lang() string

Lang returns a file's language (ie. "sv").

func (*LanguageFileInfo) Name added in v0.38.1 

func (fi *LanguageFileInfo) Name() string

Name is the name of the file within this filesystem without any path info. It will be marked with language information so we can identify it as ours (ie. "__hugofs_sv_page.md").

func (*LanguageFileInfo) Path added in v0.38.1 

func (fi *LanguageFileInfo) Path() string

Path returns a file's filename relative to the base (ie. "sect/page.md").

func (*LanguageFileInfo) RealName added in v0.38.1 

func (fi *LanguageFileInfo) RealName() string

RealName returns a file's real base name (ie. "page.md").

func (*LanguageFileInfo) TranslationBaseName added in v0.38.1 

func (fi *LanguageFileInfo) TranslationBaseName() string

TranslationBaseName returns the base filename without any extension or language identifiers (ie. "page").

type LanguageFs added in v0.38.1 

type LanguageFs struct {
	afero.Fs
	// contains filtered or unexported fields
}

LanguageFs represents a language filesystem.

func NewLanguageFs added in v0.38.1 

func NewLanguageFs(lang string, languages map[string]bool, fs afero.Fs) *LanguageFs

NewLanguageFs creates a new language filesystem.

func (*LanguageFs) Lang added in v0.38.1 

func (fs *LanguageFs) Lang() string

Lang returns a language filesystem's language (ie. "sv").

func (*LanguageFs) LstatIfPossible added in v0.38.1 

func (fs *LanguageFs) LstatIfPossible(name string) (os.FileInfo, bool, error)

LstatIfPossible returns the os.FileInfo structure describing a given file. It attempts to use Lstat if supported or defers to the os. In addition to the FileInfo, a boolean is returned telling whether Lstat was called.

func (*LanguageFs) Open added in v0.38.1 

func (fs *LanguageFs) Open(name string) (afero.File, error)

Open opens the named file for reading.

func (*LanguageFs) Stat added in v0.38.1 

func (fs *LanguageFs) Stat(name string) (os.FileInfo, error)

Stat returns the os.FileInfo of a given file.

type RealFilenameInfo added in v0.45.1 

type RealFilenameInfo interface {
	os.FileInfo

	// This is the real filename to the file in the underlying filesystem.
	RealFilename() string
}

RealFilenameInfo is a thin wrapper around os.FileInfo adding the real filename.

type Reseter added in v0.55.0 

type Reseter interface {
	Reset()
}

Reseter is implemented by some of the stateful filesystems.

type RootMappingFs added in v0.42.1 

type RootMappingFs struct {
	afero.Fs
	// contains filtered or unexported fields
}

A RootMappingFs maps several roots into one. Note that the root of this filesystem is directories only, and they will be returned in Readdir and Readdirnames in the order given.

func NewRootMappingFs added in v0.42.1 

func NewRootMappingFs(fs afero.Fs, fromTo ...string) (*RootMappingFs, error)

NewRootMappingFs creates a new RootMappingFs on top of the provided with a list of from, to string pairs of root mappings. Note that 'from' represents a virtual root that maps to the actual filename in 'to'.

func (*RootMappingFs) LstatIfPossible added in v0.42.1 

func (fs *RootMappingFs) LstatIfPossible(name string) (os.FileInfo, bool, error)

LstatIfPossible returns the os.FileInfo structure describing a given file. It attempts to use Lstat if supported or defers to the os. In addition to the FileInfo, a boolean is returned telling whether Lstat was called.

func (*RootMappingFs) Open added in v0.42.1 

func (fs *RootMappingFs) Open(name string) (afero.File, error)

Open opens the named file for reading.

func (*RootMappingFs) Stat added in v0.42.1 

func (fs *RootMappingFs) Stat(name string) (os.FileInfo, error)

Stat returns the os.FileInfo structure describing a given file. If there is an error, it will be of type *os.PathError.

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.