mediawiki

Documentation

Index

• func CheckIfInCoreDirectory()
• func GuessMediaWikiDirectoryBasedOnContext() string
• type CloneSetupOpts
• type MediaWiki
  • func ForCurrentWorkingDirectory() (MediaWiki, error)
  • func ForDirectory(directory string) (MediaWiki, error)
  • func (m MediaWiki) CloneSetup(options CloneSetupOpts)
  • func (m MediaWiki) Directory() string
  • func (m MediaWiki) LocalSettingsContains(text string) bool
  • func (m MediaWiki) LocalSettingsIsPresent() bool
  • func (m MediaWiki) MediaWikiIsPresent() bool
  • func (m MediaWiki) Path(subPath string) string
  • func (m MediaWiki) VectorIsPresent() bool
• type NotMediaWikiDirectory
  • func (e *NotMediaWikiDirectory) Error() string

Functions

func CheckIfInCoreDirectory

func CheckIfInCoreDirectory()

CheckIfInCoreDirectory checks that the current working directory looks like a MediaWiki directory.

func GuessMediaWikiDirectoryBasedOnContext

func GuessMediaWikiDirectoryBasedOnContext() string

GuessMediaWikiDirectoryBasedOnContext ...

Types

type CloneSetupOpts

type CloneSetupOpts = struct {
	GetMediaWiki          bool
	GetVector             bool
	UseGithub             bool
	UseShallow            bool
	GerritInteractionType string
	GerritUsername        string
}

CloneSetupOpts for use with GithubCloneMediaWiki.

type MediaWiki

type MediaWiki string

MediaWiki representation of a MediaWiki install directory.

func ForCurrentWorkingDirectory

func ForCurrentWorkingDirectory() (MediaWiki, error)

ForCurrentWorkingDirectory returns a MediaWiki for the current working directory.

func ForDirectory

func ForDirectory(directory string) (MediaWiki, error)

ForDirectory returns a MediaWiki for the current working directory.

func (MediaWiki) CloneSetup

func (m MediaWiki) CloneSetup(options CloneSetupOpts)

CloneSetup provides a packages initial setup method for MediaWiki and Vector with some speedy features.

func (MediaWiki) Directory

func (m MediaWiki) Directory() string

Directory the directory containing MediaWiki.

func (MediaWiki) LocalSettingsContains

func (m MediaWiki) LocalSettingsContains(text string) bool

LocalSettingsContains ...

func (MediaWiki) LocalSettingsIsPresent

func (m MediaWiki) LocalSettingsIsPresent() bool

LocalSettingsIsPresent ...

func (MediaWiki) MediaWikiIsPresent

func (m MediaWiki) MediaWikiIsPresent() bool

MediaWikiIsPresent ...

func (MediaWiki) Path

func (m MediaWiki) Path(subPath string) string

Path within the MediaWiki directory.

func (MediaWiki) VectorIsPresent

func (m MediaWiki) VectorIsPresent() bool

VectorIsPresent ...

type NotMediaWikiDirectory

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

NotMediaWikiDirectory error when a directory appears to not contain MediaWiki code.

func (*NotMediaWikiDirectory) Error

func (e *NotMediaWikiDirectory) Error() string