make2usage

package module
v1.0.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 4, 2018 License: MIT Imports: 7 Imported by: 0

README

make2usage

Easily install only a binary command.

Single binary file:make2usage download into the current directory.
If you want to get a single binary simply, it just enough.

curl https://gitlab.com/tyabuta/go-make2usage/raw/master/install.sh | bash

Use go command.

go get
go get -v gitlab.com/tyabuta/go-make2usage
go install
go get -v -u gitlab.com/tyabuta/go-make2usage/cmd/make2usage

Usage

make2usage --help
NAME:
   make2usage - Generate usage from Makefiles.

USAGE:
   make2usage [options] <Makefile, ...>

VERSION:
   0.1.0

AUTHOR:
   tyabuta <[email protected]>

OPTIONS:
   --all-variable, -V  show all variable
   --all-command, -C   show all command
   --help, -h          show help
   --version, -v       print the version

Output example

USAGE
    make <commands> [variables]

VARIABLES
    PWD       -- pwd
    CFLAGS    -- CFLAGS

COMMANDS
    task3     -- task3 desu
                 multi line
    task1     -- task1 desu
    test      -- Run tests
    deps      -- Install dependencies
    lint      -- Lint
    cover     -- Take coverage
    release   -- Release the binaries
    log-less  -- Show log with `less`
    log-tail  -- Show log with `tail`
    help      -- Show help

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	ShowAllVariable bool
	ShowAllCommand  bool
)
View Source
var App *cli.App
View Source
var HelpTemplate = `` /* 672-byte string literal not displayed */

Functions

This section is empty.

Types

type HintInfo

type HintInfo struct {
	Type     HintType
	Name     string
	Comments []string
}

func FindHints

func FindHints(hints []HintInfo, hintType HintType, isAll bool) []HintInfo

func ReadHints

func ReadHints(fileName string) ([]HintInfo, error)

type HintType

type HintType int
const (
	HintTypeCommand  HintType = 0
	HintTypeVariable HintType = 1
)

Directories

Path Synopsis
cmd

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL