feat!: remove global level configuration file (#252)

* feat: remove global level configuration file

* update readme

Author: j178

README.md

@@ -200,8 +200,8 @@ author: Bob
 # Language of the question description: zh or en
 language: zh
 code:
-  # Language of code generated for questions: go, python, ... 
-  # (will be override by project config and flag --lang)
+  # Language of code generated for questions: go, cpp, python, java... 
+  # (will be overridden by command line flag -l/--lang)
   lang: go
   # The default template to generate filename (without extension), e.g. {{.Id}}.{{.Slug}}
   # Available attributes: Id, Slug, Title, Difficulty, Lang, SlugIsMeaningful

README_zh.md

@@ -193,8 +193,8 @@ author: Bob
 # Language of the question description: zh or en
 language: zh
 code:
-  # Language of code generated for questions: go, python, ... 
-  # (will be override by project config and flag --lang)
+  # Language of code generated for questions: go, cpp, python, java... 
+  # (will be overridden by command line flag -l/--lang)
   lang: go
   # The default template to generate filename (without extension), e.g. {{.Id}}.{{.Slug}}
   # Available attributes: Id, Slug, Title, Difficulty, Lang, SlugIsMeaningful

cmd/debug.go

@@ -55,19 +55,18 @@ var debugCmd = &cobra.Command{
 	Run: func(cmd *cobra.Command, args []string) {
 		cfg := config.Get()
 		cwd, _ := os.Getwd()
-		projectConfig, err := os.ReadFile(cfg.ProjectConfigFile())
+		projectConfig, err := os.ReadFile(cfg.ConfigFile())
 		if err != nil {
 			projectConfig = []byte("No project config file found")
 		}
 		cmd.Println("Leetgo version info  :")
 		cmd.Println("```")
 		cmd.Println(buildVersion())
 		cmd.Println("```")
-		cmd.Println("Global config dir    :", cfg.ConfigDir())
-		cmd.Println("Global config file   :", cfg.GlobalConfigFile())
+		cmd.Println("Home dir             :", cfg.HomeDir())
 		cmd.Println("Project root         :", cfg.ProjectRoot())
 		cmd.Println("Working dir          :", cwd)
-		cmd.Println("Project config file  :", cfg.ProjectConfigFile())
+		cmd.Println("Project config file  :", cfg.ConfigFile())
 		cmd.Println("Project configuration:")
 		cmd.Println("```yaml")
 		cmd.Println(string(projectConfig))

cmd/init.go

@@ -44,7 +44,7 @@ var initCmd = &cobra.Command{
 		if err != nil {
 			return err
 		}
-		err = createConfigFiles(dir)
+		err = createConfigFile(dir)
 		if err != nil {
 			return err
 		}
@@ -61,7 +61,7 @@ var initCmd = &cobra.Command{
 
 func init() {
 	initCmd.Flags().StringVarP(&initTemplate, "template", "t", "", "template to use, cn or us")
-	initCmd.Flags().BoolVarP(&force, "force", "f", false, "overwrite global config file if exists")
+	initCmd.Flags().BoolVarP(&force, "force", "f", false, "overwrite config file if exists")
 
 	_ = initCmd.RegisterFlagCompletionFunc(
 		"template", func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective) {
@@ -71,7 +71,7 @@ func init() {
 }
 
 func createConfigDir() error {
-	dir := config.Get().ConfigDir()
+	dir := config.Get().HomeDir()
 	if utils.IsExist(dir) {
 		return nil
 	}
@@ -83,7 +83,7 @@ func createConfigDir() error {
 	return nil
 }
 
-func createConfigFiles(dir string) error {
+func createConfigFile(dir string) error {
 	cfg := config.Get()
 	site := cfg.LeetCode.Site
 	language := cfg.Language
@@ -95,53 +95,25 @@ func createConfigFiles(dir string) error {
 		language = config.ZH
 	}
 
-	globalFile := cfg.GlobalConfigFile()
-	if force || !utils.IsExist(globalFile) {
-		f, err := os.Create(globalFile)
-		if err != nil {
-			return err
-		}
-
-		author := defaultUser()
-		cfg.LeetCode.Site = site
-		cfg.Language = language
-		cfg.Author = author
+	author := defaultUser()
+	cfg.LeetCode.Site = site
+	cfg.Language = language
+	cfg.Author = author
 
-		err = cfg.Write(f, true)
-		if err != nil {
-			return err
-		}
-		log.Info("global config file created", "file", globalFile)
+	projectFile := filepath.Join(dir, constants.ConfigFilename)
+	if utils.IsExist(projectFile) && !force {
+		return fmt.Errorf("config file %s already exists, use -f to overwrite", utils.RelToCwd(projectFile))
 	}
 
-	projectFile := filepath.Join(dir, constants.ProjectConfigFilename)
 	f, err := os.Create(projectFile)
 	if err != nil {
 		return err
 	}
+	defer func() { _ = f.Close() }()
 
-	tmpl := `# This is the leetgo project level config, global config is at %s
-# For more details, please refer to https://github.com/j178/leetgo
-language: %s
-code:
-  lang: %s
-leetcode:
-  site: %s
-#  credentials:
-#    from: browser
-#editor:
-#  use: none
-`
-	_, _ = f.WriteString(
-		fmt.Sprintf(
-			tmpl,
-			globalFile,
-			language,
-			cfg.Code.Lang,
-			site,
-		),
-	)
-	log.Info("project config file created", "file", utils.RelToCwd(projectFile))
+	_, _ = f.WriteString("# Leetgo configuration file, see more at https://github.com/j178/leetgo\n\n")
+	_ = cfg.Write(f, true)
+	log.Info("config file created", "file", utils.RelToCwd(projectFile))
 
 	return nil
 }

config/config.go

@@ -1,14 +1,14 @@
 package config
 
 import (
+	"bytes"
 	"errors"
 	"fmt"
 	"io"
 	"os"
 	"path/filepath"
 	"strings"
 
-	"github.com/charmbracelet/log"
 	"github.com/google/shlex"
 	"github.com/mitchellh/go-homedir"
 	"github.com/spf13/viper"
@@ -70,7 +70,7 @@ type Modifier struct {
 }
 
 type CodeConfig struct {
-	Lang                    string         `yaml:"lang" mapstructure:"lang" comment:"Language of code generated for questions: go, python, ... \n(will be override by project config and flag --lang)"`
+	Lang                    string         `yaml:"lang" mapstructure:"lang" comment:"Language of code generated for questions: go, cpp, python, java... \n(will be overridden by command line flag -l/--lang)"`
 	FilenameTemplate        string         `yaml:"filename_template" mapstructure:"filename_template" comment:"The default template to generate filename (without extension), e.g. {{.Id}}.{{.Slug}}\nAvailable attributes: Id, Slug, Title, Difficulty, Lang, SlugIsMeaningful\nAvailable functions: lower, upper, trim, padWithZero, toUnderscore, group"`
 	SeparateDescriptionFile bool           `yaml:"separate_description_file" mapstructure:"separate_description_file" comment:"Generate question description into a separate question.md file"`
 	Blocks                  []Block        `yaml:"blocks,omitempty" mapstructure:"blocks" comment:"Default block definitions for all languages"`
@@ -120,7 +120,7 @@ type LeetCodeConfig struct {
 	Credentials Credentials  `yaml:"credentials" mapstructure:"credentials" comment:"Credentials to access LeetCode"`
 }
 
-func (c *Config) ConfigDir() string {
+func (c *Config) HomeDir() string {
 	if c.dir != "" {
 		return c.dir
 	}
@@ -135,23 +135,19 @@ func (c *Config) ConfigDir() string {
 }
 
 func (c *Config) CacheDir() string {
-	return filepath.Join(c.ConfigDir(), "cache")
+	return filepath.Join(c.HomeDir(), "cache")
 }
 
 func (c *Config) TempDir() string {
 	return filepath.Join(os.TempDir(), constants.CmdName)
 }
 
-func (c *Config) GlobalConfigFile() string {
-	return filepath.Join(c.ConfigDir(), constants.GlobalConfigFilename)
-}
-
 func (c *Config) ProjectRoot() string {
 	if c.projectRoot == "" {
 		dir, _ := os.Getwd()
 		c.projectRoot = dir
 		for {
-			if utils.IsExist(filepath.Join(dir, constants.ProjectConfigFilename)) {
+			if utils.IsExist(filepath.Join(dir, constants.ConfigFilename)) {
 				c.projectRoot = dir
 				break
 			}
@@ -166,8 +162,8 @@ func (c *Config) ProjectRoot() string {
 	return c.projectRoot
 }
 
-func (c *Config) ProjectConfigFile() string {
-	return filepath.Join(c.ProjectRoot(), constants.ProjectConfigFilename)
+func (c *Config) ConfigFile() string {
+	return filepath.Join(c.ProjectRoot(), constants.ConfigFilename)
 }
 
 func (c *Config) StateFile() string {
@@ -301,45 +297,28 @@ func Load(init bool) error {
 		return nil
 	}
 
-	// load global configuration
+	// load default configuration
 	cfg := defaultConfig()
-	viper.SetDefault("code.lang", cfg.Code.Lang)
-	viper.SetDefault("leetcode.site", cfg.LeetCode.Site)
 
-	viper.SetConfigFile(cfg.GlobalConfigFile())
-	err := viper.ReadInConfig()
+	viper.SetConfigType("yaml")
+	cfgBytes, err := yaml.Marshal(cfg)
 	if err != nil {
-		notExist := os.IsNotExist(err)
-		if init && notExist {
-			// During `init`, if global config file does not exist, we will create one.
-			err = nil
-			_ = err
-		} else {
-			if notExist {
-				return fmt.Errorf(
-					"global config file %s not found, run `leetgo init` to create one",
-					cfg.GlobalConfigFile(),
-				)
-			}
-			return fmt.Errorf("load global config file %s failed: %w", cfg.GlobalConfigFile(), err)
-		}
+		return fmt.Errorf("marshal default config failed: %w", err)
+	}
+	err = viper.ReadConfig(bytes.NewBuffer(cfgBytes))
+	if err != nil {
+		return fmt.Errorf("read default config failed: %w", err)
 	}
 
-	// Don't read project config if we are running `init` command
+	// load project configuration
 	if !init {
-		// load project configuration
-		viper.SetConfigFile(cfg.ProjectConfigFile())
+		viper.SetConfigFile(cfg.ConfigFile())
 		err = viper.MergeInConfig()
 		if err != nil {
 			if os.IsNotExist(err) {
-				log.Warn(
-					fmt.Sprintf("%s not found, use global config only", constants.ProjectConfigFilename),
-					"file",
-					cfg.GlobalConfigFile(),
-				)
-			} else {
-				return fmt.Errorf("load config file %s failed: %w", cfg.ProjectConfigFile(), err)
+				return fmt.Errorf("%s not found, run `leetgo init` first", constants.ConfigFilename)
 			}
+			return fmt.Errorf("load config file %s failed: %w", cfg.ConfigFile(), err)
 		}
 	}
 

constants/constants.go

@@ -8,8 +8,7 @@ var (
 
 const (
 	CmdName               = "leetgo"
-	GlobalConfigFilename  = "config.yaml"
-	ProjectConfigFilename = "leetgo.yaml"
+	ConfigFilename        = "leetgo.yaml"
 	QuestionCacheBaseName = "leetcode-questions"
 	StateFilename         = "state.json"
 	CodeBeginMarker       = "@lc code=begin"