Skip to content

Apply some go lint fixes #25

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Nov 8, 2022
Merged

Apply some go lint fixes #25

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
6a9c9bb
Pass of go-fmt
cmaglie Nov 8, 2022
484e95d
linter: error message should not be capitalized
cmaglie Nov 8, 2022
b884f29
linter: use `!strings.Contains` instead of `Index(..)!=-1`
cmaglie Nov 8, 2022
60684f0
linter: use verbatim strings with MustCompile to avoid double escaping
cmaglie Nov 8, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
266 changes: 133 additions & 133 deletions properties.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,26 +33,26 @@ This library is mainly used in the Arduino platform software to handle
configurations made of key/value pairs stored in files with an INI like
syntax, for example:

...
uno.name=Arduino/Genuino Uno
uno.upload.tool=avrdude
uno.upload.protocol=arduino
uno.upload.maximum_size=32256
uno.upload.maximum_data_size=2048
uno.upload.speed=115200
uno.build.mcu=atmega328p
uno.build.f_cpu=16000000L
uno.build.board=AVR_UNO
uno.build.core=arduino
uno.build.variant=standard
diecimila.name=Arduino Duemilanove or Diecimila
diecimila.upload.tool=avrdude
diecimila.upload.protocol=arduino
diecimila.build.f_cpu=16000000L
diecimila.build.board=AVR_DUEMILANOVE
diecimila.build.core=arduino
diecimila.build.variant=standard
...
...
uno.name=Arduino/Genuino Uno
uno.upload.tool=avrdude
uno.upload.protocol=arduino
uno.upload.maximum_size=32256
uno.upload.maximum_data_size=2048
uno.upload.speed=115200
uno.build.mcu=atmega328p
uno.build.f_cpu=16000000L
uno.build.board=AVR_UNO
uno.build.core=arduino
uno.build.variant=standard
diecimila.name=Arduino Duemilanove or Diecimila
diecimila.upload.tool=avrdude
diecimila.upload.protocol=arduino
diecimila.build.f_cpu=16000000L
diecimila.build.board=AVR_DUEMILANOVE
diecimila.build.core=arduino
diecimila.build.variant=standard
...

This library has methods to parse this kind of file into a Map object.

Expand Down Expand Up @@ -139,7 +139,7 @@ func LoadFromBytes(bytes []byte) (*Map, error) {

for lineNum, line := range strings.Split(text, "\n") {
if err := properties.parseLine(line); err != nil {
return nil, fmt.Errorf("Error parsing data at line %d: %s", lineNum, err)
return nil, fmt.Errorf("error parsing data at line %d: %s", lineNum, err)
}
}

Expand All @@ -150,12 +150,12 @@ func LoadFromBytes(bytes []byte) (*Map, error) {
func Load(filepath string) (*Map, error) {
bytes, err := ioutil.ReadFile(filepath)
if err != nil {
return nil, fmt.Errorf("Error reading file: %s", err)
return nil, fmt.Errorf("error reading file: %s", err)
}

res, err := LoadFromBytes(bytes)
if err != nil {
return nil, fmt.Errorf("Error reading file: %s", err)
return nil, fmt.Errorf("error reading file: %s", err)
}
return res, nil
}
Expand All @@ -172,7 +172,7 @@ func LoadFromSlice(lines []string) (*Map, error) {

for lineNum, line := range lines {
if err := properties.parseLine(line); err != nil {
return nil, fmt.Errorf("Error reading from slice (index:%d): %s", lineNum, err)
return nil, fmt.Errorf("error reading from slice (index:%d): %s", lineNum, err)
}
}

Expand All @@ -189,7 +189,7 @@ func (m *Map) parseLine(line string) error {

lineParts := strings.SplitN(line, "=", 2)
if len(lineParts) != 2 {
return fmt.Errorf("Invalid line format, should be 'key=value'")
return fmt.Errorf("invalid line format, should be 'key=value'")
}
key := strings.TrimSpace(lineParts[0])
value := strings.TrimSpace(lineParts[1])
Expand Down Expand Up @@ -277,39 +277,39 @@ func (m *Map) Remove(key string) {
// FirstLevelOf generates a map-of-Maps using the first level of the hierarchy
// of the current Map. For example the following Map:
//
// properties.Map{
// "uno.name": "Arduino/Genuino Uno",
// "uno.upload.tool": "avrdude",
// "uno.upload.protocol": "arduino",
// "uno.upload.maximum_size": "32256",
// "diecimila.name": "Arduino Duemilanove or Diecimila",
// "diecimila.upload.tool": "avrdude",
// "diecimila.upload.protocol": "arduino",
// "diecimila.bootloader.tool": "avrdude",
// "diecimila.bootloader.low_fuses": "0xFF",
// }
// properties.Map{
// "uno.name": "Arduino/Genuino Uno",
// "uno.upload.tool": "avrdude",
// "uno.upload.protocol": "arduino",
// "uno.upload.maximum_size": "32256",
// "diecimila.name": "Arduino Duemilanove or Diecimila",
// "diecimila.upload.tool": "avrdude",
// "diecimila.upload.protocol": "arduino",
// "diecimila.bootloader.tool": "avrdude",
// "diecimila.bootloader.low_fuses": "0xFF",
// }
//
// is transformed into the following map-of-Maps:
//
// map[string]Map{
// "uno" : properties.Map{
// "name": "Arduino/Genuino Uno",
// "upload.tool": "avrdude",
// "upload.protocol": "arduino",
// "upload.maximum_size": "32256",
// },
// "diecimila" : properties.Map{
// "name": "Arduino Duemilanove or Diecimila",
// "upload.tool": "avrdude",
// "upload.protocol": "arduino",
// "bootloader.tool": "avrdude",
// "bootloader.low_fuses": "0xFF",
// }
// }
// map[string]Map{
// "uno" : properties.Map{
// "name": "Arduino/Genuino Uno",
// "upload.tool": "avrdude",
// "upload.protocol": "arduino",
// "upload.maximum_size": "32256",
// },
// "diecimila" : properties.Map{
// "name": "Arduino Duemilanove or Diecimila",
// "upload.tool": "avrdude",
// "upload.protocol": "arduino",
// "bootloader.tool": "avrdude",
// "bootloader.low_fuses": "0xFF",
// }
// }
func (m *Map) FirstLevelOf() map[string]*Map {
newMap := make(map[string]*Map)
for _, key := range m.o {
if strings.Index(key, ".") == -1 {
if !strings.Contains(key, ".") {
continue
}
keyParts := strings.SplitN(key, ".", 2)
Expand All @@ -325,24 +325,24 @@ func (m *Map) FirstLevelOf() map[string]*Map {
// FirstLevelKeys returns the keys in the first level of the hierarchy
// of the current Map. For example the following Map:
//
// properties.Map{
// "uno.name": "Arduino/Genuino Uno",
// "uno.upload.tool": "avrdude",
// "uno.upload.protocol": "arduino",
// "uno.upload.maximum_size": "32256",
// "diecimila.name": "Arduino Duemilanove or Diecimila",
// "diecimila.upload.tool": "avrdude",
// "diecimila.upload.protocol": "arduino",
// "diecimila.bootloader.tool": "avrdude",
// "diecimila.bootloader.low_fuses": "0xFF",
// }
// properties.Map{
// "uno.name": "Arduino/Genuino Uno",
// "uno.upload.tool": "avrdude",
// "uno.upload.protocol": "arduino",
// "uno.upload.maximum_size": "32256",
// "diecimila.name": "Arduino Duemilanove or Diecimila",
// "diecimila.upload.tool": "avrdude",
// "diecimila.upload.protocol": "arduino",
// "diecimila.bootloader.tool": "avrdude",
// "diecimila.bootloader.low_fuses": "0xFF",
// }
//
// will produce the following result:
//
// []string{
// "uno",
// "diecimila",
// }
// []string{
// "uno",
// "diecimila",
// }
//
// the order of the original map is preserved
func (m *Map) FirstLevelKeys() []string {
Expand All @@ -363,26 +363,26 @@ func (m *Map) FirstLevelKeys() []string {
// of the keys hierarchy as selector.
// For example the following Map:
//
// properties.Map{
// "uno.name": "Arduino/Genuino Uno",
// "uno.upload.tool": "avrdude",
// "uno.upload.protocol": "arduino",
// "uno.upload.maximum_size": "32256",
// "diecimila.name": "Arduino Duemilanove or Diecimila",
// "diecimila.upload.tool": "avrdude",
// "diecimila.upload.protocol": "arduino",
// "diecimila.bootloader.tool": "avrdude",
// "diecimila.bootloader.low_fuses": "0xFF",
// }
// properties.Map{
// "uno.name": "Arduino/Genuino Uno",
// "uno.upload.tool": "avrdude",
// "uno.upload.protocol": "arduino",
// "uno.upload.maximum_size": "32256",
// "diecimila.name": "Arduino Duemilanove or Diecimila",
// "diecimila.upload.tool": "avrdude",
// "diecimila.upload.protocol": "arduino",
// "diecimila.bootloader.tool": "avrdude",
// "diecimila.bootloader.low_fuses": "0xFF",
// }
//
// after calling SubTree("uno") will be transformed into:
//
// properties.Map{
// "name": "Arduino/Genuino Uno",
// "upload.tool": "avrdude",
// "upload.protocol": "arduino",
// "upload.maximum_size": "32256",
// },
// properties.Map{
// "name": "Arduino/Genuino Uno",
// "upload.tool": "avrdude",
// "upload.protocol": "arduino",
// "upload.maximum_size": "32256",
// },
func (m *Map) SubTree(rootKey string) *Map {
rootKey += "."
newMap := NewMap()
Expand All @@ -399,7 +399,7 @@ func (m *Map) SubTree(rootKey string) *Map {
// ExpandPropsInString uses the Map to replace values into a format string.
// The format string should contains markers between braces, for example:
//
// "The selected upload protocol is {upload.protocol}."
// "The selected upload protocol is {upload.protocol}."
//
// Each marker is replaced by the corresponding value of the Map.
// The values in the Map may contain other markers, they are evaluated
Expand Down Expand Up @@ -509,58 +509,58 @@ func MergeMapsOfProperties(target map[string]*Map, sources ...map[string]*Map) m
// DeleteUnexpandedPropsFromString removes all the brace markers "{xxx}" that are not expanded
// into a value using the Map.ExpandPropsInString() method.
func DeleteUnexpandedPropsFromString(str string) string {
rxp := regexp.MustCompile("\\{.+?\\}")
rxp := regexp.MustCompile(`\{.+?\}`)
return rxp.ReplaceAllString(str, "")
}

// ExtractSubIndexSets works like SubTree but it considers also the numeric sub index in the form
// `root.N.xxx...` as separate subsets.
// For example the following Map:
//
// properties.Map{
// "uno.upload_port.vid": "0x1000",
// "uno.upload_port.pid": "0x2000",
// "due.upload_port.0.vid": "0x1000",
// "due.upload_port.0.pid": "0x2000",
// "due.upload_port.1.vid": "0x1001",
// "due.upload_port.1.pid": "0x2001",
// "tre.upload_port.1.vid": "0x1001",
// "tre.upload_port.1.pid": "0x2001",
// "tre.upload_port.2.vid": "0x1002",
// "tre.upload_port.2.pid": "0x2002",
// }
// properties.Map{
// "uno.upload_port.vid": "0x1000",
// "uno.upload_port.pid": "0x2000",
// "due.upload_port.0.vid": "0x1000",
// "due.upload_port.0.pid": "0x2000",
// "due.upload_port.1.vid": "0x1001",
// "due.upload_port.1.pid": "0x2001",
// "tre.upload_port.1.vid": "0x1001",
// "tre.upload_port.1.pid": "0x2001",
// "tre.upload_port.2.vid": "0x1002",
// "tre.upload_port.2.pid": "0x2002",
// }
//
// calling ExtractSubIndexSets("uno.upload_port") returns the array:
//
// [ properties.Map{
// "vid": "0x1000",
// "pid": "0x2000",
// },
// ]
// [ properties.Map{
// "vid": "0x1000",
// "pid": "0x2000",
// },
// ]
//
// calling ExtractSubIndexSets("due.upload_port") returns the array:
//
// [ properties.Map{
// "vid": "0x1000",
// "pid": "0x2000",
// },
// properties.Map{
// "vid": "0x1001",
// "pid": "0x2001",
// },
// ]
// [ properties.Map{
// "vid": "0x1000",
// "pid": "0x2000",
// },
// properties.Map{
// "vid": "0x1001",
// "pid": "0x2001",
// },
// ]
//
// the sub-index may start with .1 too, so calling ExtractSubIndexSets("tre.upload_port") returns:
//
// [ properties.Map{
// "vid": "0x1001",
// "pid": "0x2001",
// },
// properties.Map{
// "vid": "0x1002",
// "pid": "0x2002",
// },
// ]
// [ properties.Map{
// "vid": "0x1001",
// "pid": "0x2001",
// },
// properties.Map{
// "vid": "0x1002",
// "pid": "0x2002",
// },
// ]
//
// Numeric subindex cannot be mixed with non-numeric, in that case only the numeric sub
// index sets will be returned.
Expand Down Expand Up @@ -597,27 +597,27 @@ func (m *Map) ExtractSubIndexSets(root string) []*Map {
// ExtractSubIndexLists extracts a list of arguments from a root `root.N=...`.
// For example the following Map:
//
// properties.Map{
// "uno.discovery.required": "item",
// "due.discovery.required.0": "item1",
// "due.discovery.required.1": "item2",
// "due.discovery.required.2": "item3",
// "tre.discovery.required.1": "itemA",
// "tre.discovery.required.2": "itemB",
// "tre.discovery.required.3": "itemC",
// }
// properties.Map{
// "uno.discovery.required": "item",
// "due.discovery.required.0": "item1",
// "due.discovery.required.1": "item2",
// "due.discovery.required.2": "item3",
// "tre.discovery.required.1": "itemA",
// "tre.discovery.required.2": "itemB",
// "tre.discovery.required.3": "itemC",
// }
//
// calling ExtractSubIndexLists("uno.discovery.required") returns the array:
//
// [ "item" ]
// [ "item" ]
//
// calling ExtractSubIndexLists("due.discovery.required") returns the array:
//
// [ "item1", "item2", "item3" ]
// [ "item1", "item2", "item3" ]
//
// the sub-index may start with .1 too, so calling ExtractSubIndexLists("tre.discovery.required") returns:
//
// [ "itemA", "itemB", "itemC" ]
// [ "itemA", "itemB", "itemC" ]
//
// Numeric subindex cannot be mixed with non-numeric, in that case only the numeric sub
// index sets will be returned.
Expand Down