✨ Add -l flag Option

Author: UltiRequiem

README.md

@@ -10,12 +10,15 @@ A simple and extensible [yaml](https://yaml.org) formatter.
 
 ## Installation
 
-With `go Install`:
+With `go install`:
 
 ```bash
 go install github.com/UltiRequiem/yamlfmt@latest
 ```
 
+You can also use the binaries from
+[releases](https://github.com/UltiRequiem/yamlfmt/releases).
+
 ## Usage
 
 - To format one or more files and write to stdout:
@@ -30,6 +33,8 @@ go install github.com/UltiRequiem/yamlfmt@latest
   yamlfmt -w a.yaml b.yaml c.yaml
   ```
 
+  If you want to log the files that have been formatted, you can use the `-l` flag also.
+
 - To format stdin and write to stdout:
 
   ```bash

cmd/root.go

@@ -1,13 +1,19 @@
 package cmd
 
-import "os"
+import (
+	"fmt"
+	"os"
+)
 
 func Init() {
-	overwrite, indent, multipleArgs, files := getParams()
+	overwrite, indent, log, multipleArgs, files := getParams()
 
 	if multipleArgs {
 		for _, file := range files {
 			formatFile(file, *indent, *overwrite)
+			if log {
+				fmt.Printf("%s formatted!\n", file)
+			}
 		}
 	} else {
 		formatStream(os.Stdin, os.Stdout, *indent)

cmd/utils.go

@@ -11,13 +11,14 @@ import (
 	"gopkg.in/yaml.v3"
 )
 
-func getParams() (*bool, *int, bool, []string) {
+func getParams() (*bool, *int, bool, bool, []string) {
 	overwrite := flag.Bool("w", false, "Overwrite the input file")
 	indent := flag.Int("indent", 2, "Default indent")
+	log := flag.Bool("l", false, "Log when a file is formatted")
 
 	flag.Parse()
 
-	return overwrite, indent, flag.NArg() > 0, flag.Args()
+	return overwrite, indent, *log, flag.NArg() > 0, flag.Args()
 
 }