feat(init): initialize the config file

cmd/init.go

@@ -0,0 +1,34 @@
+/*
+Copyright © 2023 Simon Emms <[email protected]>
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+	http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+package cmd
+
+import (
+	"github.com/mrsimonemms/toodaloo/pkg/config"
+	"github.com/spf13/cobra"
+)
+
+// initCmd represents the init command
+var initCmd = &cobra.Command{
+	Use:   "init",
+	Short: "Initialize a config file",
+	RunE: func(cmd *cobra.Command, args []string) error {
+		return config.Init(rootCfg.WorkingDirectory, rootCfg.CfgFile)
+	},
+}
+
+func init() {
+	rootCmd.AddCommand(initCmd)
+}

go.mod

@@ -6,6 +6,8 @@ require (
 	github.com/mrsimonemms/golang-helpers v0.1.0
 	github.com/sirupsen/logrus v1.9.3
 	github.com/spf13/cobra v1.7.0
+	gopkg.in/yaml.v2 v2.4.0
+	sigs.k8s.io/yaml v1.3.0
 )
 
 require (

go.sum

@@ -18,5 +18,9 @@ github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/
 golang.org/x/sys v0.0.0-20220715151400-c0bba94af5f8 h1:0A+M6Uqn+Eje4kHMK80dtF3JCXC4ykBgQG4Fe06QRhQ=
 golang.org/x/sys v0.0.0-20220715151400-c0bba94af5f8/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
+gopkg.in/yaml.v2 v2.4.0 h1:D8xgwECY7CYvx+Y2n4sBz93Jn9JRvxdiyyo8CTfuKaY=
+gopkg.in/yaml.v2 v2.4.0/go.mod h1:RDklbk79AGWmwhnvt/jBztapEOGDOx6ZbXqjP6csGnQ=
 gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
 gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
+sigs.k8s.io/yaml v1.3.0 h1:a2VclLzOGrwOHDiV8EfBGhvjHvP46CtW5j6POvhYGGo=
+sigs.k8s.io/yaml v1.3.0/go.mod h1:GeOyir5tyXNByN85N/dRIT9es5UQNerPYEKK56eTBm8=

pkg/config/config.go

@@ -0,0 +1,45 @@
+/*
+ * Copyright 2023 Simon Emms <[email protected]>
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package config
+
+import (
+	"os"
+	"path/filepath"
+
+	"github.com/mrsimonemms/golang-helpers/logger"
+	"sigs.k8s.io/yaml"
+)
+
+func Init(directory, filename string) error {
+	file := filepath.Join(directory, filename)
+	l := logger.Log().WithField("filename", file)
+
+	c, err := yaml.Marshal(defaultConfig)
+	if err != nil {
+		l.Error("Failed to generate default config")
+		return err
+	}
+
+	l.Info("Saving config to file")
+
+	if err := os.WriteFile(file, c, 0o644); err != nil {
+		l.WithError(err).Error("Failed to save file")
+		return err
+	}
+
+	return nil
+}

pkg/config/types.go

@@ -0,0 +1,33 @@
+/*
+ * Copyright 2023 Simon Emms <[email protected]>
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package config
+
+type Config struct {
+	IgnorePaths []string `json:"ignore_paths,omitempty"`
+	Output      string   `json:"output"`
+	Tags        []string `json:"tags"`
+}
+
+var defaultConfig = Config{
+	IgnorePaths: []string{},
+	Output:      "toodaloo.yaml",
+	Tags: []string{
+		"fixme",
+		"todo",
+		"@todo",
+	},
+}