feat(comment): add support for: interface methods, struct fields, variables (#123)

* refactor(comment): dont use unnecessary function

* chore: quick way to open vim in dev mode

* feat(comment): add comment on on interface method

* feat(comment): add comment on a struct field

* feat(comment): add comment on a variable

* docs: add note about the generate function

* docs: gopher.TsResult

* fix(utils): handle case when indentation is wrong

spec/fixtures/comment/interface_many_method_input.go

@@ -0,0 +1,6 @@
+package main
+
+type Testinger interface {
+	Get(id string) int
+	Set(id string, val int)
+}

spec/fixtures/comment/interface_many_method_output.go

@@ -0,0 +1,7 @@
+package main
+
+type Testinger interface {
+	Get(id string) int
+	// Set 
+	Set(id string, val int)
+}

spec/fixtures/comment/interface_method_input.go

@@ -0,0 +1,5 @@
+package main
+
+type Testinger interface {
+	Method(input string) error
+}

spec/fixtures/comment/interface_method_output.go

@@ -0,0 +1,6 @@
+package main
+
+type Testinger interface {
+	// Method 
+	Method(input string) error
+}

spec/fixtures/comment/many_structs_fields_input.go

@@ -0,0 +1,18 @@
+package main
+
+type (
+	TestOne struct {
+		Asdf string
+		ID   int
+	}
+
+	TestTwo struct {
+		Fesa int
+		A    bool
+	}
+
+	TestThree struct {
+		Asufj int
+		Fs    string
+	}
+)

spec/fixtures/comment/many_structs_fields_output.go

@@ -0,0 +1,19 @@
+package main
+
+type (
+	TestOne struct {
+		Asdf string
+		ID   int
+	}
+
+	TestTwo struct {
+		// Fesa 
+		Fesa int
+		A    bool
+	}
+
+	TestThree struct {
+		Asufj int
+		Fs    string
+	}
+)

spec/fixtures/comment/struct_fields_input.go

@@ -0,0 +1,7 @@
+package main
+
+type CommentStruct struct {
+	Name    string
+	Address string
+	Aliases []string
+}

spec/fixtures/comment/struct_fields_output.go

@@ -0,0 +1,8 @@
+package main
+
+type CommentStruct struct {
+	Name    string
+	// Address 
+	Address string
+	Aliases []string
+}

spec/fixtures/comment/svar_input.go

@@ -0,0 +1,5 @@
+package main
+
+func varTest() {
+	s := "something"
+}

spec/fixtures/comment/svar_output.go

@@ -0,0 +1,6 @@
+package main
+
+func varTest() {
+	// s 
+	s := "something"
+}

spec/fixtures/comment/var_input.go

@@ -0,0 +1,5 @@
+package main
+
+func test() {
+	var imAVar string
+}

spec/fixtures/comment/var_output.go

@@ -0,0 +1,6 @@
+package main
+
+func test() {
+	// imAVar 
+	var imAVar string
+}

spec/fixtures/comment/var_struct_fields_input.go

@@ -0,0 +1,8 @@
+package main
+
+func main() {
+	var s struct {
+		API string
+		Key string
+	}
+}

spec/fixtures/comment/var_struct_fields_output.go

@@ -0,0 +1,9 @@
+package main
+
+func main() {
+	var s struct {
+		API string
+		// Key 
+		Key string
+	}
+}