Git Product home page Git Product logo

package-headers-go's Introduction

package-headers-go

Generate consistent Go package headers every time.

Build

You need Go installed on your machine. See the installation guide here.

Install the CLI globally like this:

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:

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:

/*
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.

package-headers-go's People

Contributors

jesserc avatar

Stargazers

Godswill Ezihe avatar daksh avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.