config

Documentation

Overview

Package config for interacting with the cli config

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/>.

Package config for interacting with the cli config

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

• Constants
• Variables
• type AllowedOptions
  • func (cao AllowedOptions) Contains(value string) bool
• type Config
  • func LoadFromDisk() Config
  • func (c Config) PrettyPrint()
  • func (c Config) WriteToDisk()

Constants

const DevModeMwdd string = "docker"

DevModeMwdd value for DevMode that will use the docker/mediawiki-docker-dev command set

const UpdateChannelDev string = "dev-addshore"

UpdateChannelDev value for UpdateChannel that will pull updates from addshore's dev builds

const UpdateChannelStable string = "stable-wikimedia"

UpdateChannelStable value for UpdateChannel that will pull updates from wikimedia's stable builds

Variables

var DevModeValues = AllowedOptions([]string{DevModeMwdd})

DevModeValues allowed values for DevMode

var UpdateChannelValues = AllowedOptions([]string{UpdateChannelDev, UpdateChannelStable})

UpdateChannelValues allowed values for UpdateChannel

Types

type AllowedOptions

type AllowedOptions []string

AllowedOptions representation of allowed options for a config value

func (AllowedOptions) Contains

func (cao AllowedOptions) Contains(value string) bool

Contains do the allowed options contain this value

type Config

type Config struct {
	DevMode       string `json:"dev_mode"`
	UpdateChannel string `json:"update_channel"`
}

Config representation of a cli config

func LoadFromDisk

func LoadFromDisk() Config

LoadFromDisk loads the config.json from disk

func (Config) PrettyPrint

func (c Config) PrettyPrint()

PrettyPrint writers the config to disk

func (Config) WriteToDisk

func (c Config) WriteToDisk()

WriteToDisk writers the config to disk