Wrong formating for custom struct names #1150

F0rzend · 2022-02-25T19:48:19Z

Wrong formating for custom struct names
When run swag fmt 2 spaces appear between @name and the name instead of one and the name is parsed as an empty string

To Reproduce
Steps to reproduce the behavior:

Write a struct, for example

type User struct {
	ID       uint   `json:"id"`
	Username string `json:"username"`
} // @name User

Run swag fmt -g filename.go
Get @name User instead of @name User in your code
Run swag init -g path/to/mani.go
In docs/swagger.yaml you will see

definitions:
  "":
    description: User information
    properties:
      id:
        type: integer
      username:
        type: string
    type: object

Expected behavior
Correct type name, "User"

Screenshots

Swag version

$ swag -v
swag version v1.8.0

Go version

$ go version
go version go1.18beta1 linux/amd64

Desktop:

OS: OS: Ubuntu 21.10 x86_64
Browser: Firefox browser 97.0 (64-bit); Mozila Firefox for Ubuntu canonical - 1.0
Version: 21.10

The text was updated successfully, but these errors were encountered:

ubogdan · 2022-03-03T18:53:54Z

This is an open-source project. Feel free to contribute with a fix and I will be more than happy to assist you with a Code Review.

@name

Fix issue swaggo#1150 To summarize of the issue, running `swag fmt` will set (at least) 2 spaces between the attribute tag and the rest of the comment. For instance: ``` type Example struct { Foobar string } // @name Example ``` However the doc generation doesn't interpret this correctly for struct (it completly ignore it). So there are 2 solutions: - fix the indent (which is feel more natural) - fix the doc generation to correctly parse 2 spaces This commit is fixing the indent part. Basically I just set the padding=1 on `tabwriter`. The cons is that it will also impacts all other godocs. For instance (taken from the readme): ``` // @title Swagger Example API // @Version 1.0 // @description This is a sample server celler server. // @termsofservice http://swagger.io/terms/ ```

@name

To summarize the issue, running `swag fmt` will set (at least) 2 spaces between the attribute tag and the rest of the comment. But this is a problem for struct with single comment: ```diff type Example struct { Foobar string -} // @name Example +} // @name Example ``` Indeed the doc generation doesn't interpret this correctly for struct (it completely ignore it). So there are 2 solutions: - fix the indent (which is feel more natural) - fix the doc generation to correctly parse 2 spaces This commit is fixing the indent part. Basically I just set the padding=1 on `tabwriter`. The cons is that it will also impacts all other godocs. For instance (taken from the readme): ```diff -// @title Swagger Example API -// @Version 1.0 -// @description This is a sample server celler server. -// @termsofservice http://swagger.io/terms/ +// @title Swagger Example API +// @Version 1.0 +// @description This is a sample server celler server. +// @termsofservice http://swagger.io/terms/ ```

@name

To summarize the issue, running `swag fmt` will set (at least) 2 spaces between the attribute tag and the rest of the comment. But this is a problem for struct with single comment: ```diff type Example struct { Foobar string -} // @name Example +} // @name Example ``` Indeed the doc generation doesn't interpret this correctly for struct (it completely ignore it). So there are 2 solutions: - fix the indent (which is feel more natural) - fix the doc generation to correctly parse 2 spaces This commit is fixing the indent part. Basically I just set the padding=1 on `tabwriter`. The cons is that it will also impacts all other godocs. For instance (taken from the readme): ```diff -// @title Swagger Example API -// @Version 1.0 -// @description This is a sample server celler server. -// @termsofservice http://swagger.io/terms/ +// @title Swagger Example API +// @Version 1.0 +// @description This is a sample server celler server. +// @termsofservice http://swagger.io/terms/ ```

@name

To summarize the issue, running `swag fmt` will set (at least) 2 spaces between the attribute tag and the rest of the comment. But this is a problem for struct with single comment: ```diff type Example struct { Foobar string -} // @name Example +} // @name Example ``` Indeed the doc generation doesn't interpret this correctly for struct (it completely ignore it). So there are 2 solutions: - fix the indent (which is feel more natural) - fix the doc generation to correctly parse 2 spaces This commit is fixing the indent part. Basically I just set the padding=1 on `tabwriter`. The cons is that it will also impacts all other godocs. For instance (taken from the readme): ```diff -// @title Swagger Example API -// @Version 1.0 -// @description This is a sample server celler server. -// @termsofservice http://swagger.io/terms/ +// @title Swagger Example API +// @Version 1.0 +// @description This is a sample server celler server. +// @termsofservice http://swagger.io/terms/ ```

MattKetmo mentioned this issue Jun 30, 2022

fix: fmt issue with struct #1248

Merged

nitram509 mentioned this issue May 29, 2023

fix using tab (\t) as separator for custom type names #1594

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Wrong formating for custom struct names #1150

Wrong formating for custom struct names #1150

F0rzend commented Feb 25, 2022 •

edited

ubogdan commented Mar 3, 2022

Wrong formating for custom struct names #1150

Wrong formating for custom struct names #1150

Comments

F0rzend commented Feb 25, 2022 • edited

ubogdan commented Mar 3, 2022

F0rzend commented Feb 25, 2022 •

edited