go-fsck: Update docs to not output unexported receiver funcs

Author: Tit Petric

cmd/go-fsck/Taskfile.yml

@@ -21,6 +21,7 @@ tasks:
     desc: "Build example"
     cmds:
       - go-fsck extract --verbose --include-tests --include-sources -i example/ -o example/go-fsck.json --pretty-json
+      - cd example && go-fsck docs > README.md && cd ..
 
   restore:
     desc: "Restore from model"

cmd/go-fsck/example/README.md

@@ -0,0 +1,85 @@
+# Package example
+
+```go
+import (
+	"github.com/TykTechnologies/exp/cmd/go-fsck/example"
+}
+```
+
+Example package doc.
+
+## Types
+
+```go
+// Allocator holds a sync.Pool of objects of type T.
+type Allocator[T Reseter] struct {
+	pool sync.Pool
+}
+```
+
+```go
+// Body represends a decoded body
+type Body struct {
+	Name string
+}
+```
+
+```go
+// File represents a filename
+type File string
+```
+
+```go
+// Reseter is the interface that types must implement to be managed by Allocator.
+type Reseter interface {
+	Reset()
+}
+```
+
+## Consts
+
+```go
+// Const comment
+const E_WARNING = "warning"	// const line comment
+```
+
+## Function symbols
+
+- `func GlobalFunc () error`
+- `func New (newFunc func() T) *Allocator[T]`
+- `func (*Allocator[T]) Get () T`
+- `func (*Allocator[T]) Put (t T)`
+
+### GlobalFunc
+
+Global func comment
+
+```go
+func GlobalFunc () error
+```
+
+### New
+
+New creates an Allocator for type T using the provided constructor.
+
+```go
+func New (newFunc func() T) *Allocator[T]
+```
+
+### Get
+
+Get retrieves an object from the internal pool.
+
+```go
+func (*Allocator[T]) Get () T
+```
+
+### Put
+
+Put returns an object to the pool after resetting it.
+
+```go
+func (*Allocator[T]) Put (t T)
+```
+
+

cmd/go-fsck/example/go-fsck.json

@@ -46,6 +46,13 @@
         "Doc": "Reseter is the interface that types must implement to be managed by Allocator.",
         "Name": "Reseter",
         "Source": "// Reseter is the interface that types must implement to be managed by Allocator.\ntype Reseter interface {\n\tReset()\n}"
+      },
+      {
+        "Kind": "type",
+        "File": "internal.go",
+        "SelfContained": true,
+        "Name": "logger",
+        "Source": "type logger struct {\n\tout []string\n}"
       }
     ],
     "Consts": [
@@ -136,6 +143,18 @@
         ],
         "Signature": "Put (t T)",
         "Source": "// Put returns an object to the pool after resetting it.\nfunc (a *Allocator[T]) Put(t T) {\n\tt.Reset()\n\ta.pool.Put(t)\n}"
+      },
+      {
+        "Kind": "func",
+        "File": "internal.go",
+        "SelfContained": false,
+        "Name": "Log",
+        "Receiver": "*logger",
+        "Arguments": [
+          "string"
+        ],
+        "Signature": "Log (s string)",
+        "Source": "func (l *logger) Log(s string) {\n\tl.out = append(l.out, s)\n}"
       }
     ]
   },

cmd/go-fsck/example/internal.go

@@ -0,0 +1,9 @@
+package example
+
+type logger struct {
+	out []string
+}
+
+func (l *logger) Log(s string) {
+	l.out = append(l.out, s)
+}

cmd/go-fsck/model/declaration.go

@@ -38,6 +38,10 @@ func (d *Declaration) HasName(find string) bool {
 }
 
 func (d *Declaration) IsExported() bool {
+	if d.Receiver != "" && !ast.IsExported(strings.TrimLeft(d.Receiver, "*")) {
+		return false
+	}
+
 	for _, name := range d.Names {
 		if ast.IsExported(name) {
 			return true

cmd/go-fsck/model/restored/declaration.go

@@ -45,6 +45,10 @@ func (d *Declaration) HasName(find string) bool {
 }
 
 func (d *Declaration) IsExported() bool {
+	if d.Receiver != "" && !ast.IsExported(strings.TrimLeft(d.Receiver, "*")) {
+		return false
+	}
+
 	for _, name := range d.Names {
 		if ast.IsExported(name) {
 			return true

cmd/go-fsck/model/restored/go-fsck.json

@@ -131,6 +131,9 @@
         "References": {
           "ast": [
             "IsExported"
+          ],
+          "strings": [
+            "TrimLeft"
           ]
         },
         "Name": "IsExported",
@@ -139,7 +142,7 @@
           "bool"
         ],
         "Signature": "IsExported () bool",
-        "Source": "func (d *Declaration) IsExported() bool {\n\tfor _, name := range d.Names {\n\t\tif ast.IsExported(name) {\n\t\t\treturn true\n\t\t}\n\t}\n\treturn ast.IsExported(d.Name)\n}"
+        "Source": "func (d *Declaration) IsExported() bool {\n\tif d.Receiver != \"\" \u0026\u0026 !ast.IsExported(strings.TrimLeft(d.Receiver, \"*\")) {\n\t\treturn false\n\t}\n\n\tfor _, name := range d.Names {\n\t\tif ast.IsExported(name) {\n\t\t\treturn true\n\t\t}\n\t}\n\treturn ast.IsExported(d.Name)\n}"
       },
       {
         "Kind": "func",