config

Documentation

Index

• type Config
  • func (c *Config) GetAllowedMethods() []string
  • func (c *Config) GetCommandName() string
  • func (c *Config) GetFileTypes() []string
  • func (c *Config) GetFolder() string
  • func (c *Config) GetIgnoreCharacters() []string
  • func (c *Config) GetIgnoreFiles() []string
  • func (c *Config) GetOneFile() string
  • func (c *Config) GetPrefix() string
  • func (c *Config) GetReportWarnings() bool
  • func (c *Config) GetSuffix() string
  • func (c *Config) GetWarnAsTable() bool
  • func (c *Config) GetWarningCharacters() []string
  • func (c *Config) Init()
  • func (c *Config) SetAllowedFileTypes(Allowed_file_types []string)
  • func (c *Config) SetAllowedParseMethods(Allowed_parse_methods []string)
  • func (c *Config) SetCurrentCommand(command_name string)
  • func (c *Config) SetDetailedReport(detailed bool)
  • func (c *Config) SetFolderToScan(Folder_to_scan string)
  • func (c *Config) SetForce(force bool)
  • func (c *Config) SetIgnoreCharacters(Ignore_characters []string)
  • func (c *Config) SetIgnoreFileTypes(Ignore_files_and_folders []string)
  • func (c *Config) SetLogFolder(folder string)
  • func (c *Config) SetOneFile(one_file string)
  • func (c *Config) SetPrefixToSet(prefix string)
  • func (c *Config) SetReportWarnings(report bool)
  • func (c *Config) SetSuffixToSet(suffix string)
  • func (c *Config) SetWarnAsTable(warn bool)
  • func (c *Config) SetWarningCharacters(Warning_characters []string)

Types

type Config

type Config struct {
	// Scanning
	Folder_to_scan           string   `json:"folder"`       // both | just folder to scan
	Allowed_file_types       []string `json:"file_types"`   // both | parses file only with given extensions
	Ignore_files_and_folders []string `json:"ignore_names"` // only json | ignores files and folders with given names

	// Parse
	Ignore_characters     []string `json:"ignore"`   // only json | ignores strings which contains given characters
	Warning_characters    []string `json:"warnings"` // only json | Warns about strings which contains given characters (not replaces)
	Allowed_parse_methods []string `json:"methods"`  // both | Uses only given parse methods. Available: text, placeholder, alt, title, hashtag
	// Replace
	Prefix_to_set string `json:"prefix"` // both | Prefix to set
	Suffix_to_set string `json:"suffix"` // both | Suffix to set
	Force         bool   `json:"force"`  // both | If true, git status check is ignored
	// Report
	Detailed_report bool `json:"detailed"` // both | if true, detailed report will be displayed
	// @todo use this config
	Warn_as_table   bool `json:"warn_as_Table"`   // JSON | if true, warnings will be displayed as table
	Report_warnings bool `json:"report_warnings"` // both | if true, warnings will be saved as JSON file
	// Log
	Log_folder string `json:"log_folder"` // only JSON | folder to store logs
	// contains filtered or unexported fields
}

func (*Config) GetAllowedMethods

func (c *Config) GetAllowedMethods() []string

func (*Config) GetCommandName

func (c *Config) GetCommandName() string

func (*Config) GetFileTypes

func (c *Config) GetFileTypes() []string

func (*Config) GetFolder

func (c *Config) GetFolder() string

func (*Config) GetIgnoreCharacters

func (c *Config) GetIgnoreCharacters() []string

func (*Config) GetIgnoreFiles

func (c *Config) GetIgnoreFiles() []string

func (*Config) GetOneFile

func (c *Config) GetOneFile() string

func (*Config) GetPrefix

func (c *Config) GetPrefix() string

func (*Config) GetReportWarnings

func (c *Config) GetReportWarnings() bool

func (*Config) GetSuffix

func (c *Config) GetSuffix() string

func (*Config) GetWarnAsTable

func (c *Config) GetWarnAsTable() bool

func (*Config) GetWarningCharacters

func (c *Config) GetWarningCharacters() []string

func (*Config) Init

func (c *Config) Init()

func (*Config) SetAllowedFileTypes

func (c *Config) SetAllowedFileTypes(Allowed_file_types []string)

func (*Config) SetAllowedParseMethods

func (c *Config) SetAllowedParseMethods(Allowed_parse_methods []string)

func (*Config) SetCurrentCommand

func (c *Config) SetCurrentCommand(command_name string)

func (*Config) SetDetailedReport

func (c *Config) SetDetailedReport(detailed bool)

func (*Config) SetFolderToScan

func (c *Config) SetFolderToScan(Folder_to_scan string)

func (*Config) SetForce

func (c *Config) SetForce(force bool)

func (*Config) SetIgnoreCharacters

func (c *Config) SetIgnoreCharacters(Ignore_characters []string)

func (*Config) SetIgnoreFileTypes

func (c *Config) SetIgnoreFileTypes(Ignore_files_and_folders []string)

func (*Config) SetLogFolder

func (c *Config) SetLogFolder(folder string)

func (*Config) SetOneFile

func (c *Config) SetOneFile(one_file string)

func (*Config) SetPrefixToSet

func (c *Config) SetPrefixToSet(prefix string)

func (*Config) SetReportWarnings

func (c *Config) SetReportWarnings(report bool)

func (*Config) SetSuffixToSet

func (c *Config) SetSuffixToSet(suffix string)

func (*Config) SetWarnAsTable

func (c *Config) SetWarnAsTable(warn bool)

func (*Config) SetWarningCharacters

func (c *Config) SetWarningCharacters(Warning_characters []string)