README.md

cmtstringer - Comment to String

cmtstringer is a tool that help to generate method func (t T) String() string, which satisfy the fmt.Stringer interface, for given type name of a constant. Returned value is the comment text of the constant.

Install

To install command cmtstringer, run command

go get github.com/lazada/cmtstringer

Usage

For example, given this file

package http

//go:generate cmtstringer -type StatusCode

type StatusCode int

const (
    // StatusBadRequest Bad Request
    StatusBadRequest StatusCode = 400
    // StatusNotFound Not Found
    StatusNotFound StatusCode = 404
)

run command

go generate

then you will get file statuscode_string_gen.go

package http

// This file is generated by command cmtstringer.
// DO NOT EDIT IT.

// String returns comment of const type StatusCode
func (s StatusCode) String() string {
    switch s {
    case StatusBadRequest:
        return "Bad Request"
    case StatusNotFound:
        return "Not Found"
    default:
        return "Unknown"
    }
}

License

Licensed under the Apache License, Version 2.0 (the "License").