Change the directory of the configuration files

.gitignore

@@ -3,5 +3,5 @@
 /main
 /.vscode/settings.json
 /cmd/formatter/debug.test
-/.cli-config.yml
+/arduino-cli.yaml
 /wiki

README.md

@@ -162,7 +162,7 @@ Great! Now we have the Board FQBN (Fully Qualified Board Name) `arduino:samd:mkr
 and the Board Name look good, we are ready to compile and upload the sketch
 
 #### Adding 3rd party cores
-To add 3rd party core packages add  a link of the additional package to the file  `.cli-config.yml`
+To add 3rd party core packages add  a link of the additional package to the file  `arduino-cli.yaml`
 
 If you want to add the ESP8266 core, for example:
 
@@ -295,7 +295,7 @@ Flags:
   -h, --help   help for core
 
 Global Flags:
-      --config-file string   The custom config file (if not specified ./.cli-config.yml will be used). (default "/home/megabug/Workspace/go/src/github.com/arduino/arduino-cli/.cli-config.yml")
+      --config-file string   The custom config file (if not specified the default one will be used). (example  "/home/megabug/.config/arduino/arduino-cli/arduino-cli.yaml")
       --debug                Enables debug output (super verbose, used to debug the CLI).
       --format string        The output format, can be [text|json]. (default "text")
 

commands/config/init.go

@@ -42,7 +42,7 @@ func initInitCommand() *cobra.Command {
 	initCommand.Flags().BoolVar(&initFlags._default, "default", false,
 		"If omitted, ask questions to the user about setting configuration properties, otherwise use default configuration.")
 	initCommand.Flags().StringVar(&initFlags.location, "save-as", "",
-		"Sets where to save the configuration file [default is ./.cli-config.yml].")
+		"Sets where to save the configuration file [default is ./arduino-cli.yaml].")
 	return initCommand
 }
 
@@ -65,7 +65,14 @@ func runInitCommand(cmd *cobra.Command, args []string) {
 	if filepath == "" {
 		filepath = commands.Config.ConfigFile.String()
 	}
-	err := commands.Config.SaveToYAML(filepath)
+
+	err := commands.Config.ConfigFile.Parent().MkdirAll()
+	if err != nil {
+		formatter.PrintError(err, "Cannot create config file.")
+		os.Exit(commands.ErrGeneric)
+	}
+
+	err = commands.Config.SaveToYAML(filepath)
 	if err != nil {
 		formatter.PrintError(err, "Cannot create config file.")
 		os.Exit(commands.ErrGeneric)

commands/root/root.go

@@ -20,6 +20,7 @@ package root
 import (
 	"io/ioutil"
 	"os"
+	"path/filepath"
 
 	"github.com/arduino/arduino-cli/output"
 
@@ -56,7 +57,7 @@ func Init() *cobra.Command {
 	}
 	command.PersistentFlags().BoolVar(&commands.GlobalFlags.Debug, "debug", false, "Enables debug output (super verbose, used to debug the CLI).")
 	command.PersistentFlags().StringVar(&commands.GlobalFlags.Format, "format", "text", "The output format, can be [text|json].")
-	command.PersistentFlags().StringVar(&yamlConfigFile, "config-file", "", "The custom config file (if not specified ./.cli-config.yml will be used).")
+	command.PersistentFlags().StringVar(&yamlConfigFile, "config-file", "", "The custom config file (if not specified the default will be used).")
 	command.AddCommand(board.InitCommand())
 	command.AddCommand(compile.InitCommand())
 	command.AddCommand(config.InitCommand())
@@ -115,6 +116,7 @@ func preRun(cmd *cobra.Command, args []string) {
 
 // initConfigs initializes the configuration from the specified file.
 func initConfigs() {
+	// Start with default configuration
 	if conf, err := configs.NewConfiguration(); err != nil {
 		logrus.WithError(err).Error("Error creating default configuration")
 		formatter.PrintError(err, "Error creating default configuration")
@@ -123,14 +125,24 @@ func initConfigs() {
 		commands.Config = conf
 	}
 
+	// Navigate through folders
+	pwd, err := filepath.Abs(".")
+	if err != nil {
+		logrus.WithError(err).Warn("Did not manage to find current path")
+	}
+
+	commands.Config.Navigate("/", pwd)
+	commands.Config.LoadFromYAML(commands.Config.ConfigFile)
+
 	if yamlConfigFile != "" {
 		commands.Config.ConfigFile = paths.New(yamlConfigFile)
+		if err := commands.Config.LoadFromYAML(commands.Config.ConfigFile); err != nil {
+			logrus.WithError(err).Warn("Did not manage to get config file, using default configuration")
+		}
 	}
 
 	logrus.Info("Initiating configuration")
-	if err := commands.Config.LoadFromYAML(commands.Config.ConfigFile); err != nil {
-		logrus.WithError(err).Warn("Did not manage to get config file, using default configuration")
-	}
+
 	if commands.Config.IsBundledInDesktopIDE() {
 		logrus.Info("CLI is bundled into the IDE")
 		err := commands.Config.LoadFromDesktopIDEPreferences()

configs/directories.go

@@ -19,23 +19,37 @@ package configs
 
 import (
 	"fmt"
-	"os"
 	"os/user"
 	"runtime"
 
 	"github.com/arduino/go-paths-helper"
-
 	"github.com/arduino/go-win32-utils"
 )
 
-// getDefaultConfigFilePath returns the default path for .cli-config.yml,
-// this is the directory where the arduino-cli executable resides.
+// getDefaultConfigFilePath returns the default path for arduino-cli.yaml
 func getDefaultConfigFilePath() *paths.Path {
-	executablePath, err := os.Executable()
+	usr, err := user.Current()
 	if err != nil {
-		executablePath = "."
+		panic(fmt.Errorf("retrieving user home dir: %s", err))
 	}
-	return paths.New(executablePath).Parent().Join(".cli-config.yml")
+	arduinoDataDir := paths.New(usr.HomeDir)
+
+	switch runtime.GOOS {
+	case "linux":
+		arduinoDataDir = arduinoDataDir.Join(".arduino15")
+	case "darwin":
+		arduinoDataDir = arduinoDataDir.Join("Library", "arduino15")
+	case "windows":
+		localAppDataPath, err := win32.GetLocalAppDataFolder()
+		if err != nil {
+			panic(err)
+		}
+		arduinoDataDir = paths.New(localAppDataPath).Join("Arduino15")
+	default:
+		panic(fmt.Errorf("unsupported OS: %s", runtime.GOOS))
+	}
+
+	return arduinoDataDir
 }
 
 func getDefaultArduinoDataDir() (*paths.Path, error) {

configs/navigate.go

@@ -0,0 +1,40 @@
+/*
+ * This file is part of arduino-cli.
+ *
+ * Copyright 2018 ARDUINO SA (http://www.arduino.cc/)
+ *
+ * This software is released under the GNU General Public License version 3,
+ * which covers the main part of arduino-cli.
+ * The terms of this license can be found at:
+ * https://www.gnu.org/licenses/gpl-3.0.en.html
+ *
+ * You can be released from the requirements of the above licenses by purchasing
+ * a commercial license. Buying such a license is mandatory if you want to modify or
+ * otherwise use the software for commercial activities involving the Arduino
+ * software without disclosing the source code of your own applications. To purchase
+ * a commercial license, send an email to [email protected].
+ */
+package configs
+
+import (
+	"path/filepath"
+	"strings"
+
+	paths "github.com/arduino/go-paths-helper"
+)
+
+func (c *Configuration) Navigate(root, pwd string) {
+	relativePath, err := filepath.Rel(root, pwd)
+	if err != nil {
+		return
+	}
+
+	// From the root to the current folder, search for arduino-cli.yaml files
+	parts := strings.Split(relativePath, string(filepath.Separator))
+	for i := range parts {
+		path := paths.New(root)
+		path = path.Join(parts[:i+1]...)
+		path = path.Join("arduino-cli.yaml")
+		_ = c.LoadFromYAML(path)
+	}
+}

configs/navigate_test.go

@@ -0,0 +1,71 @@
+/*
+ * This file is part of arduino-cli.
+ *
+ * Copyright 2018 ARDUINO SA (http://www.arduino.cc/)
+ *
+ * This software is released under the GNU General Public License version 3,
+ * which covers the main part of arduino-cli.
+ * The terms of this license can be found at:
+ * https://www.gnu.org/licenses/gpl-3.0.en.html
+ *
+ * You can be released from the requirements of the above licenses by purchasing
+ * a commercial license. Buying such a license is mandatory if you want to modify or
+ * otherwise use the software for commercial activities involving the Arduino
+ * software without disclosing the source code of your own applications. To purchase
+ * a commercial license, send an email to [email protected].
+ */
+package configs_test
+
+import (
+	"io/ioutil"
+	"path/filepath"
+	"strings"
+	"testing"
+
+	"github.com/arduino/arduino-cli/configs"
+	homedir "github.com/mitchellh/go-homedir"
+	"github.com/sergi/go-diff/diffmatchpatch"
+)
+
+func TestNavigate(t *testing.T) {
+	tests := []string{
+		"noconfig",
+		"local",
+		"inheritance",
+	}
+	for _, tt := range tests {
+		t.Run(tt, func(t *testing.T) {
+			root := filepath.Join("testdata", "navigate", tt)
+			pwd := filepath.Join("testdata", "navigate", tt, "first", "second")
+			golden := filepath.Join("testdata", "navigate", tt, "golden.yaml")
+
+			config, _ := configs.NewConfiguration()
+
+			config.Navigate(root, pwd)
+			data, _ := config.SerializeToYAML()
+
+			diff(t, data, golden)
+		})
+	}
+}
+
+func diff(t *testing.T, data []byte, goldenFile string) {
+	golden, err := ioutil.ReadFile(goldenFile)
+	if err != nil {
+		t.Error(err)
+		return
+	}
+
+	dataStr := strings.TrimSpace(string(data))
+	goldenStr := strings.TrimSpace(string(golden))
+
+	// Substitute home folder
+	homedir, _ := homedir.Dir()
+	dataStr = strings.Replace(dataStr, homedir, "$HOME", -1)
+
+	if dataStr != goldenStr {
+		dmp := diffmatchpatch.New()
+		diffs := dmp.DiffMain(goldenStr, dataStr, false)
+		t.Errorf(dmp.DiffPrettyText(diffs))
+	}
+}

configs/testdata/navigate/inheritance/first/arduino-cli.yaml

@@ -0,0 +1,5 @@
+sketchbook_path: /tmp
+board_manager:
+  additional_urls:
+    - https://downloads.arduino.cc/package_index_mraa.json
+

configs/testdata/navigate/inheritance/first/second/arduino-cli.yaml

@@ -0,0 +1,4 @@
+board_manager:
+  additional_urls:
+    - https://downloads.arduino.cc/package_index_mraa.json
+

configs/testdata/navigate/inheritance/golden.yaml

@@ -0,0 +1,7 @@
+proxy_type: auto
+sketchbook_path: /tmp
+arduino_data: $HOME/.arduino15
+board_manager:
+  additional_urls:
+  - https://downloads.arduino.cc/packages/package_index.json
+  - https://downloads.arduino.cc/package_index_mraa.json

configs/testdata/navigate/local/first/second/arduino-cli.yaml

@@ -0,0 +1,4 @@
+board_manager:
+  additional_urls:
+    - https://downloads.arduino.cc/package_index_mraa.json
+

configs/testdata/navigate/local/golden.yaml

@@ -0,0 +1,7 @@
+proxy_type: auto
+sketchbook_path: $HOME/Arduino
+arduino_data: $HOME/.arduino15
+board_manager:
+  additional_urls:
+  - https://downloads.arduino.cc/packages/package_index.json
+  - https://downloads.arduino.cc/package_index_mraa.json

configs/testdata/navigate/noconfig/golden.yaml

@@ -0,0 +1,6 @@
+proxy_type: auto
+sketchbook_path: $HOME/Arduino
+arduino_data: $HOME/.arduino15
+board_manager:
+  additional_urls:
+  - https://downloads.arduino.cc/packages/package_index.json

configs/yaml_serializer.go

@@ -23,7 +23,6 @@ import (
 	"net/url"
 
 	paths "github.com/arduino/go-paths-helper"
-	"github.com/sirupsen/logrus"
 	yaml "gopkg.in/yaml.v2"
 )
 
@@ -48,16 +47,13 @@ type yamlProxyConfig struct {
 
 // LoadFromYAML loads the configs from a yaml file.
 func (config *Configuration) LoadFromYAML(path *paths.Path) error {
-	logrus.Info("Unserializing configurations from ", path)
 	content, err := path.ReadFile()
 	if err != nil {
-		logrus.WithError(err).Warn("Error reading config, using default configuration")
 		return err
 	}
 	var ret yamlConfig
 	err = yaml.Unmarshal(content, &ret)
 	if err != nil {
-		logrus.WithError(err).Warn("Error parsing config, using default configuration")
 		return err
 	}
 
@@ -84,12 +80,12 @@ func (config *Configuration) LoadFromYAML(path *paths.Path) error {
 		for _, rawurl := range ret.BoardsManager.AdditionalURLS {
 			url, err := url.Parse(rawurl)
 			if err != nil {
-				logrus.WithError(err).Warn("Error parsing config")
 				continue
 			}
 			config.BoardManagerAdditionalUrls = append(config.BoardManagerAdditionalUrls, url)
 		}
 	}
+
 	return nil
 }
 
@@ -113,10 +109,10 @@ func (config *Configuration) SerializeToYAML() ([]byte, error) {
 			Password: config.ProxyPassword,
 		}
 	}
+	c.BoardsManager = &yamlBoardsManagerConfig{AdditionalURLS: []string{}}
 	if len(config.BoardManagerAdditionalUrls) > 1 {
-		c.BoardsManager = &yamlBoardsManagerConfig{AdditionalURLS: []string{}}
 		for _, URL := range config.BoardManagerAdditionalUrls[1:] {
-			c.BoardsManager.AdditionalURLS = append(c.BoardsManager.AdditionalURLS, URL.String())
+			c.BoardsManager.AdditionalURLS = appendIfMissing(c.BoardsManager.AdditionalURLS, URL.String())
 		}
 	}
 	return yaml.Marshal(c)
@@ -134,3 +130,12 @@ func (config *Configuration) SaveToYAML(path string) error {
 	}
 	return nil
 }
+
+func appendIfMissing(slice []string, i string) []string {
+	for _, ele := range slice {
+		if ele == i {
+			return slice
+		}
+	}
+	return append(slice, i)
+}