Code Monkey home page Code Monkey logo

gosplash's Introduction

GoSplash

Library to show log lines at the start of a program

Build status

Last release GitHub last release date Commits since release

GitHub last commit GitHub commit activity GitHub closed PRs GitHub issues GitHub closed issues

Lines of code Code size GitHub repo size Go version

MIT Visitors count

==================================================
==================================================
==================== gosplash ====================
==================================================
================ Made with โค๏ธ by =================
============ https://github.com/qdm12 ============
==================================================
==================================================

Running version v1.1.1 built on 2021-07-14 (commit c892ef2)

๐Ÿ“ฃ hello world

๐Ÿ”ง Need help? https://github.com/qdm12/gosplash/discussions/new
๐Ÿ› Bug? https://github.com/qdm12/gosplash/issues/new
โœจ New feature? https://github.com/qdm12/gosplash/issues/new
โ˜• Discussion? https://github.com/qdm12/gosplash/discussions/new
๐Ÿ’ป Email? [email protected]
๐Ÿ’ฐ Help me? https://www.paypal.me/qmcgaw https://github.com/sponsors/qdm12

Features

  • Tailored towards Github repositories for now, create an issue if you need something

  • Wide range of optional settings available:

    type Settings struct {
      // Formatting settings
      Format       Format // defaults to DefaultFormat
      LineLength   int    // defaults to 40
      Separator    rune   // defaults to '='
      MadeByPrefix string // defaults to "Made with โค๏ธ  by "
    
      // Project information
      RootURL    string // defaults to https://github.com
      User       string
      Repository string
      Authors    []string // defaults to [RootURL + "/" + User]
      Emails     []string
    
      // Program information
      Version      string // defaults to "unknown"
      Commit       string // defaults to "unknown"
      BuildDate    string // defaults to "unknown date"
      Announcement string
      AnnounceExp  time.Time // leave to zero value to disable expiration
    
      // Sponsor information
      PaypalUser    string
      GithubSponsor string
    }
  • Support for emojis

  • 100% test coverage

Setup

go get github.com/qdm12/gosplash

From the example:

package main

import (
    "fmt"
    "strings"

    "github.com/qdm12/gosplash"
)

var (
    // should be set by your CI using -ldflags
    version   = "v0.1.0"
    commit    = "c892ef2"
    buildDate = "2021-07-14"
)

func main() {
    lines := gosplash.MakeLines(gosplash.Settings{
        User:          "qdm12",
        Repository:    "gosplash",
        Version:       version,
        Commit:        commit,
        BuildDate:     buildDate,
        Announcement:  "new feature ๐ŸŽ‰",
        PaypalUser:    "qmcgaw",
        GithubSponsor: "qdm12",
    })

    fmt.Println(strings.Join(lines, "\n"))
}

Quick links

Ports

gosplash's People

Contributors

qdm12 avatar codetheweb avatar

Stargazers

Gabriel Vanca avatar Evgeniy Letenkov avatar Sam Sheffres avatar Alex Safatli avatar  avatar

Watchers

James Cloos avatar  avatar  avatar

gosplash's Issues

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.