A simple and easy-to-use library to import and export string resources into your Go applications just like you would do in Android Studio. Useful to separate business logic from UI texts or to handle string translations.

• References
• Prerequisites
• Installing
  • Install module
  • Import in your project

• Documentation
  • Types
    • Plural
    • PluralItem
    • Item
    • StringArray
    • String
    • Nesting
  • CreateResourceFile
  • DeleteResourceFile
  • LoadValues
  • SetResourceType
  • NewString
  • NewStringArray
  • NewQuantityString
  • SetFewThreshold
  • GetString
  • GetArrayString
  • GetQuantityString
• Contributors

• Android Studio string resources
• CHANGELOG

Back to top

• Make sure you have at least installed Go v1.17.

Back to top

go get github.com/Vinetwigs/stres

Back to top

import("github.com/Vinetwigs/stres")

Back to top

type Plural struct {
	XMLName xml.Name      `xml:"plurals" json:"plurals" yaml:"plurals" toml:"plurals" watson:"plurals" msgpack:"plurals"`
	Name    string        `xml:"name,attr" json:"name" yaml:"name" toml:"name" watson:"name" msgpack:"name"`
	Items   []*PluralItem `xml:"item" json:"items" yaml:"items,flow" toml:"items,multiline" watson:"items" msgpack:"items,as_array"`
}

Back to top

type PluralItem struct {
	XMLName  xml.Name `xml:"item" json:"item" yaml:"item" toml:"item" watson:"item" msgpack:"item"`
	Quantity string   `xml:"quantity,attr" json:"quantity" yaml:"quantity" toml:"quantity" watson:"quantity" msgpack:"quantity"`
	Value    string   `xml:",innerxml" json:"value" yaml:"value" toml:"value" watson:"value" msgpack:"value"`
}

Back to top

type Item struct {
	XMLName xml.Name `xml:"item" json:"item" yaml:"item" toml:"item" watson:"item" msgpack:"item"`
	Value   string   `xml:",innerxml" json:"value" yaml:"value" toml:"value" watson:"value" msgpack:"value"`
}

Back to top

type StringArray struct {
	XMLName xml.Name `xml:"string-array" json:"string-array" yaml:"string-array" toml:"string-array" watson:"string-array" msgpack:"string-array"`
	Name    string   `xml:"name,attr" json:"name" yaml:"name" toml:"name" watson:"name" msgpack:"name"`
	Items   []*Item  `xml:"item" json:"items" yaml:"items,flow" toml:"items,multiline" watson:"items" msgpack:"items,as_array" `
}

Back to top

type String struct {
	XMLName xml.Name `xml:"string" json:"string" yaml:"string" toml:"string" watson:"string" msgpack:"string"`
	Name    string   `xml:"name,attr" json:"name" yaml:"name" toml:"name" watson:"name" msgpack:"name"`
	Value   string   `xml:",innerxml" json:"value" yaml:"value" toml:"value" watson:"value" msgpack:"value"`
}

Back to top

type Nesting struct {
	XMLName      xml.Name       `xml:"resources" json:"resources" yaml:"resources" toml:"resources" watson:"resources" msgpack:"resources"`
	Strings      []*String      `xml:"string" json:"string" yaml:"string,flow" toml:"string,multiline" watson:"string" msgpack:"string,as_array"`
	StringsArray []*StringArray `xml:"string-array" json:"string-array" yaml:"string-array,flow" toml:"string-array,multiline" watson:"string-array" msgpack:"string-array,as_array"`
	Plurals      []*Plural      `xml:"plurals" json:"plurals" yaml:"plurals,flow" toml:"plurals,multiline" watson:"plurals" msgpack:"plurals,as_array"`
}

Back to top

Creates strings resource file in "strings" directory, throws an error otherwise. Takes a FileType parameter to specify strings file format.

file, err := stres.CreateXMLFile()

Back to top

Deletes resource file if exists, throws an error otherwise. Uses setted resource file extension.

err := stres.DeleteXMLFile()

Back to top

Loads values from strings file into internal dictionaries. Needs to be invoked only one time (but before getting strings values).Takes a FileType parameter to specify strings file format.

err := stres.LoadValues()

Back to top

Used to specify string file extension. If t is a wrong FileType, sets resource type to XML by default.

stres.SetResourceType(stres.WATSON)

Back to top

Adds a new string resource to resource file. Throws an error if the chosen name is already inserted or it is an empty string. Used for programmatic insertion (manual insertion recommended).

String, err := stres.NewString("name", "value")

Returns String instance and error.

Back to top

Adds a new string-array resource to resource file. Throws an error if the chosen name is already inserted or it is an empty string. Used for programmatic insertion (manual insertion recommended).

strArr, err := stres.NewStringArray("name", []string{"value1","value2",...})

Returns StringArray instance and error.

Back to top

Adds a new quantity string resource to resource file. Throws an error if the chosen name is already inserted or it is an empty string. The function uses only the first 5 values in the array. The first value is assigned to "zero" quantity. The second value is assigned to "one" quantity. The third value is assigned to "two" quantity. The fourth value is assigned to "few" quantity. The fifth value is assigned to "more" quantity. Used for programmatic insertion (manual insertion recommended).

qntStr, err := stres.NewQuantityString("name", []string{"zero","one", "two", ...})

Returns Plural instance and error.

Back to top

Sets the threshold for "few" values in quantity strings.When getting quantity strings values, the function checks if the given count is less OR EQUAL to this value.(default value: 20)

stres.SetFewThreshold(25)

Returns Plural instance and error.

Back to top

Returns the string resource's value with the given name. If not exists, returns empty string.

str := GetString("name")

Returns a string.

Back to top

Returns the string-array resource's values with the given name. If not exists, returns nil.

strArr := GetStringArray("name")

Returns an array of strings.

Back to top

Returns the quantity string resource's corresponding string value based on the value of the given count parameter. If the plural is not found, returns an empty string.

strArr := GetQuantityString("name", 10)

Returns a string.

Back to top