Add --space-redirects flag

Author: reteps

.pre-commit-hooks.yaml

@@ -7,6 +7,7 @@
     - --write
     - --newline
     - --indent
+    - --space-redirects
   description: Format Dockerfile files
   entry: dockerfmt
   files: ^.*Dockerfile.*$

README.md

@@ -21,11 +21,12 @@ Available Commands:
   version     Print the version number of dockerfmt
 
 Flags:
-  -c, --check         Check if the file(s) are formatted
-  -h, --help          help for dockerfmt
-  -i, --indent uint   Number of spaces to use for indentation (default 4)
-  -n, --newline       End the file with a trailing newline
-  -w, --write         Write the formatted output back to the file(s)
+  -c, --check             Check if the file(s) are formatted
+  -h, --help              help for dockerfmt
+  -i, --indent uint       Number of spaces to use for indentation (default 4)
+  -n, --newline           End the file with a trailing newline
+  -s, --space-redirects   Redirect operators will be followed by a space
+  -w, --write             Write the formatted output back to the file(s)
 
 Use "dockerfmt [command] --help" for more information about a command.
 ```

cmd/root.go

@@ -11,10 +11,11 @@ import (
 )
 
 var (
-	writeFlag   bool
-	checkFlag   bool
-	newlineFlag bool
-	indentSize  uint
+	writeFlag      bool
+	checkFlag      bool
+	newlineFlag    bool
+	indentSize     uint
+	spaceRedirects bool
 )
 
 var rootCmd = &cobra.Command{
@@ -31,7 +32,12 @@ func Run(cmd *cobra.Command, args []string) {
 		if err != nil {
 			log.Fatalf("Failed to read file %s: %v", fileName, err)
 		}
-		formattedLines := lib.FormatFileLines(originalLines, indentSize, newlineFlag)
+		c := &lib.Config{
+			IndentSize:      indentSize,
+			TrailingNewline: newlineFlag,
+			SpaceRedirects:  spaceRedirects,
+		}
+		formattedLines := lib.FormatFileLines(originalLines, c)
 
 		if checkFlag {
 			// Check if the file is already formatted
@@ -58,6 +64,7 @@ func init() {
 	rootCmd.Flags().BoolVarP(&checkFlag, "check", "c", false, "Check if the file(s) are formatted")
 	rootCmd.Flags().BoolVarP(&newlineFlag, "newline", "n", false, "End the file with a trailing newline")
 	rootCmd.Flags().UintVarP(&indentSize, "indent", "i", 4, "Number of spaces to use for indentation")
+	rootCmd.Flags().BoolVarP(&spaceRedirects, "space-redirects", "s", false, "Redirect operators will be followed by a space")
 }
 
 func Execute() {

cmd/version.go

@@ -14,6 +14,6 @@ var versionCmd = &cobra.Command{
 	Use:   "version",
 	Short: "Print the version number of dockerfmt",
 	Run: func(cmd *cobra.Command, args []string) {
-		fmt.Println("dockerfmt 0.2.8")
+		fmt.Println("dockerfmt 0.3.0")
 	},
 }

js/format.go

@@ -10,9 +10,14 @@ import (
 )
 
 //export formatBytes
-func formatBytes(contents []byte, indentSize uint, newlineFlag bool) *byte {
+func formatBytes(contents []byte, indentSize uint, newlineFlag bool, spaceRedirects bool) *byte {
 	originalLines := strings.SplitAfter(string(contents), "\n")
-	result := lib.FormatFileLines(originalLines, indentSize, newlineFlag)
+	c := &lib.Config{
+		IndentSize:      indentSize,
+		TrailingNewline: newlineFlag,
+		SpaceRedirects:  spaceRedirects,
+	}
+	result := lib.FormatFileLines(originalLines, c)
 	bytes := []byte(result)
 	return &bytes[0]
 }

js/format.ts

@@ -3,6 +3,7 @@ import './wasm_exec.js'
 export interface FormatOptions {
     indent: number
     trailingNewline: boolean
+    spaceRedirects: boolean
 }
 
 export const formatDockerfileContents = async (
@@ -34,6 +35,7 @@ export const formatDockerfileContents = async (
             length: number,
             indent: number,
             trailingNewline: boolean,
+            spaceRedirects: boolean,
         ) => number
     }
 
@@ -48,6 +50,7 @@ export const formatDockerfileContents = async (
         fileBufferBytes.byteLength,
         options.indent,
         options.trailingNewline,
+        options.spaceRedirects,
     )
 
     // Decode the result

js/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@reteps/dockerfmt",
-  "version": "0.2.8",
+  "version": "0.3.0",
   "type": "module",
   "description": "",
   "repository": "git+https://github.com/reteps/dockerfmt/tree/main/js",

lib/format.go

@@ -34,6 +34,7 @@ type ParseState struct {
 type Config struct {
 	IndentSize      uint
 	TrailingNewline bool
+	SpaceRedirects  bool
 }
 
 func FormatNode(ast *ExtendedNode, c *Config) (string, bool) {
@@ -120,10 +121,7 @@ func FormatOnBuild(n *ExtendedNode, c *Config) string {
 	return n.OriginalMultiline
 }
 
-func FormatFileLines(fileLines []string, indentSize uint, trailingNewline bool) string {
-	// Top level library function that formats file contents given the lines and the config.
-	// Since we want this to work exposed to WASM, each config flag should be passed in separately
-	// and not as a struct.
+func FormatFileLines(fileLines []string, c *Config) string {
 	result, err := parser.Parse(strings.NewReader(strings.Join(fileLines, "")))
 	if err != nil {
 		log.Printf("%s\n", strings.Join(fileLines, ""))
@@ -136,10 +134,7 @@ func FormatFileLines(fileLines []string, indentSize uint, trailingNewline bool)
 		AllOriginalLines: fileLines,
 	}
 	rootNode := BuildExtendedNode(result.AST, fileLines)
-	parseState.Config = &Config{
-		IndentSize:      indentSize,
-		TrailingNewline: trailingNewline,
-	}
+	parseState.Config = c
 	parseState.processNode(rootNode)
 
 	// After all directives are processed, we need to check if we have any trailing comments to add.
@@ -150,7 +145,7 @@ func FormatFileLines(fileLines []string, indentSize uint, trailingNewline bool)
 
 	parseState.Output = strings.TrimRight(parseState.Output, "\n")
 	// Ensure the output ends with a newline if requested
-	if trailingNewline {
+	if c.TrailingNewline {
 		parseState.Output += "\n"
 	}
 	return parseState.Output
@@ -243,7 +238,7 @@ func formatShell(content string, hereDoc bool, c *Config) string {
 
 	// Now that we have a valid bash-style command, we can format it with shfmt
 	// log.Printf("Content1: %s\n", content)
-	content = formatBash(content, c.IndentSize)
+	content = formatBash(content, c)
 	// log.Printf("Content2: %s\n", content)
 
 	if !hereDoc {
@@ -468,7 +463,7 @@ func IndentFollowingLines(lines string, indentSize uint) string {
 	return result
 }
 
-func formatBash(s string, indentSize uint) string {
+func formatBash(s string, c *Config) string {
 	r := strings.NewReader(s)
 	f, err := syntax.NewParser(syntax.KeepComments(true)).Parse(r, "")
 	if err != nil {
@@ -479,7 +474,8 @@ func formatBash(s string, indentSize uint) string {
 	syntax.NewPrinter(
 		syntax.Minify(false),
 		syntax.SingleLine(false),
-		syntax.Indent(indentSize),
+		syntax.SpaceRedirects(c.SpaceRedirects),
+		syntax.Indent(c.IndentSize),
 		syntax.BinaryNextLine(true),
 	).Print(buf, f)
 	return buf.String()

tests/run.dockerfile

@@ -1 +1,3 @@
-RUN ["ls"   , "-la"]
+RUN ["ls"   , "-la"]
+
+RUN echo foo >> bar