Merge pull request #57 from rshyamsu/add-comment-directives

fix: Include parsed comments between arguments only when ParseComment is true

Author: rshyamsu

.golangci.yml

@@ -24,11 +24,13 @@ linters:
     - golint
     - maligned
     - scopelint
+    - exhaustruct
     # deprecated
     - deadcode
     - varcheck
     - structcheck
     - nosnakecase
+    - exhaustivestruct
 
 
 # Run options

parse.go

@@ -252,10 +252,10 @@ func (p *parser) parse(parsing *Config, tokens <-chan NgxToken, ctx blockCtx, co
 			}
 		}
 		for t.IsQuoted || (t.Value != "{" && t.Value != ";" && t.Value != "}") {
-			if strings.HasPrefix(t.Value, "#") && !t.IsQuoted {
-				commentsInArgs = append(commentsInArgs, t.Value[1:])
-			} else {
+			if !strings.HasPrefix(t.Value, "#") || t.IsQuoted {
 				stmt.Args = append(stmt.Args, t.Value)
+			} else if p.options.ParseComments {
+				commentsInArgs = append(commentsInArgs, t.Value[1:])
 			}
 			t, tokenOk = <-tokens
 			if !tokenOk {

parse_test.go

@@ -881,6 +881,29 @@ var parseFixtures = []parseFixture{
 			},
 		},
 	}},
+	{"comments-between-args-disable-parse", "", ParseOptions{ParseComments: false}, Payload{
+		Status: "ok",
+		Config: []Config{
+			{
+				File:   getTestConfigPath("comments-between-args-disable-parse", "nginx.conf"),
+				Status: "ok",
+				Parsed: Directives{
+					{
+						Directive: "http",
+						Args:      []string{},
+						Line:      1,
+						Block: Directives{
+							{
+								Directive: "log_format",
+								Args:      []string{"\\#arg\\ 1", "#arg 2"},
+								Line:      2,
+							},
+						},
+					},
+				},
+			},
+		},
+	}},
 	{"premature-eof", "", ParseOptions{}, Payload{
 		Status: "failed",
 		Errors: []PayloadError{

testdata/configs/comments-between-args-disable-parse/nginx.conf

@@ -0,0 +1,7 @@
+http { #comment 1
+    log_format #comment 2
+        \#arg\ 1 #comment 3
+        '#arg 2' #comment 4
+        #comment 5
+        ;
+}