Documentation
¶
Overview ¶
Package mediawiki is used to interact with MediaWiki
Copyright © 2020 Addshore ¶
This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this program. If not, see <http://www.gnu.org/licenses/>.
Index ¶
- func CheckIfInCoreDirectory()
- type CloneSetupOpts
- type MediaWiki
- func (m MediaWiki) CloneSetup(options CloneSetupOpts)
- func (m MediaWiki) DeleteCache()
- func (m MediaWiki) DeleteVendor()
- func (m MediaWiki) Directory() string
- func (m MediaWiki) EnsureCacheDirectory()
- func (m MediaWiki) GitCloneMediaWiki(options exec.HandlerOptions)
- func (m MediaWiki) GitCloneVector(options exec.HandlerOptions)
- 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) RenameLocalSettings()
- func (m MediaWiki) VectorIsPresent() bool
- type NotMediaWikiDirectory
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CheckIfInCoreDirectory ¶
func CheckIfInCoreDirectory()
CheckIfInCoreDirectory checks that the current working directory looks like a MediaWiki directory
Types ¶
type CloneSetupOpts ¶
type CloneSetupOpts = struct {
GetMediaWiki bool
GetVector bool
UseGithub bool
UseShallow bool
GerritInteractionType string
GerritUsername string
Options exec.HandlerOptions
}
CloneSetupOpts for use with GithubCloneMediaWiki
type MediaWiki ¶
type MediaWiki string
MediaWiki representation of a MediaWiki install directory
func ForCurrentWorkingDirectory ¶
ForCurrentWorkingDirectory returns a MediaWiki for the current working directory
func ForDirectory ¶
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 ¶
Directory the directory containing MediaWiki
func (MediaWiki) EnsureCacheDirectory ¶
func (m MediaWiki) EnsureCacheDirectory()
EnsureCacheDirectory ...
func (MediaWiki) GitCloneMediaWiki ¶
func (m MediaWiki) GitCloneMediaWiki(options exec.HandlerOptions)
GitCloneMediaWiki ...
func (MediaWiki) GitCloneVector ¶
func (m MediaWiki) GitCloneVector(options exec.HandlerOptions)
GitCloneVector ...
func (MediaWiki) LocalSettingsContains ¶
LocalSettingsContains ...
func (MediaWiki) LocalSettingsIsPresent ¶
LocalSettingsIsPresent ...
func (MediaWiki) MediaWikiIsPresent ¶
MediaWikiIsPresent ...
func (MediaWiki) Path ¶
Path within the MediaWiki directory
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
Source Files