https://github.com/jesserc/package-headers-go
Generate consistent Go package headers every time.
https://github.com/jesserc/package-headers-go
go golang script
Last synced: 19 days ago
JSON representation
Generate consistent Go package headers every time.
- Host: GitHub
- URL: https://github.com/jesserc/package-headers-go
- Owner: Jesserc
- Created: 2024-07-29T18:11:01.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-07-29T18:16:20.000Z (over 1 year ago)
- Last Synced: 2025-02-01T20:03:52.116Z (12 months ago)
- Topics: go, golang, script
- Language: Go
- Homepage:
- Size: 4.88 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# package-headers-go
Generate consistent _Go_ package headers every time.
## Build
You need Go installed on your machine. See the installation guide
[here](https://go.dev/doc/install).
Install the CLI globally like this:
```sh
git clone github.com/Jesserc/package-headers-go
cd package-headers-go/cmd/package-headers-go
go install .
```
Run: `source ~/.zshrc` or `source ~/.bashrc` to reload zsh/bash config.
## Usage
Generate a Go package header and copy it to your clipboard:
```sh
package-headers-go -package reverser -description "Utility function for reversing strings." -example "import \"github.com/example/reverser\"\n\nstr := \"hello\"\nreversedStr := reverser.ReverseString(str)\nfmt.Println(reversedStr) // Output: \"olleh\""
```
This will generate a header like:
```go
/*
Package reverser provides Utility function for reversing strings.
import "github.com/example/reverser"
str := "hello"
reversedStr := reverser.ReverseString(str)
fmt.Println(reversedStr) // Output: "olleh"
*/
package reverser
```
And it will automatically copy the header to your clipboard.
## Credits
Inspired by t11's [`headers`](https://github.com/transmissions11/headers).