Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/nao1215/mkgoprj

mkgoprj - Golang project template generator
https://github.com/nao1215/mkgoprj

cli-app generator go golang golang-development template-project

Last synced: 7 days ago
JSON representation

mkgoprj - Golang project template generator

Host: GitHub
URL: https://github.com/nao1215/mkgoprj
Owner: nao1215
License: apache-2.0
Created: 2022-01-09T04:02:52.000Z (almost 3 years ago)
Default Branch: main
Last Pushed: 2023-11-06T20:55:20.000Z (12 months ago)
Last Synced: 2024-06-19T06:49:10.087Z (5 months ago)
Topics: cli-app, generator, go, golang, golang-development, template-project
Language: Go
Homepage:
Size: 445 KB
Stars: 19
Watchers: 2
Forks: 2
Open Issues: 5
Metadata Files:
- Readme: README.md
- Changelog: Changelog.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        [![Build](https://github.com/nao1215/mkgoprj/actions/workflows/build.yml/badge.svg?branch=main)](https://github.com/nao1215/mkgoprj/v2/actions/workflows/build.yml)

[![reviewdog](https://github.com/nao1215/mkgoprj/actions/workflows/review_dog.yml/badge.svg)](https://github.com/nao1215/mkgoprj/v2/actions/workflows/review_dog.yml)

[![Go Report Card](https://goreportcard.com/badge/github.com/nao1215/mkgoprj/v2)](https://goreportcard.com/report/github.com/nao1215/mkgoprj/v2)   

[[日本語]](./doc/README.ja.md)

# mkgoprj - Golang project template generator

![Screenshot](./doc/images/demo.gif) 

  

mkgoprj command generate golang project template at current directory. The following three projects can be created.

- Library project

- Command Line Interface project with [cobra](https://github.com/spf13/cobra)

The automatically generated files include "Makefile for easy project management" and "GitHub Actions files (build, unit test, review-dog, goreleaser, dependabot)". However, it does not run "$ git init". mkgoprj is cross-platform software that runs on Windows, Mac and Linux. [The release page](https://github.com/nao1215/mkgoprj/releases) contains packages in .deb, .rpm, and .apk formats.   

  

# How to install

## Step1. Install golang

If you don't install golang in your system, please install Golang first. Check the [Go official website](https://go.dev/doc/install) for how to install golang.

## Step2. Install mkgoprj

```

$ go install github.com/nao1215/mkgoprj/v2@latest

```

  

# How to use

## Generate application project

In the following example, the mkgoprj command will generate a sample project. The binary name will be sample, and build using Makefile.

```

$ mkgoprj cli github.com/nao1215/sample  ※ Argument is same as "$ go mod init"

mkgoprj starts creating the 'sample' application project (import path='github.com/nao1215/sample')

[START] check if mkgoprj can create the project

[START] create directories

[START] create files

        sample (your project root)

         ├─ CODE_OF_CONDUCT.md

         ├─ main.go

         ├─ Makefile

         ├─ Changelog.md

         ├─ .goreleaser.yml

         ├─ cmd

         │  ├─ version.go

         │  └─ root.go

         ├─ .github

         │  ├─ dependabot.yml

         │  ├─ ISSUE_TEMPLATE

         │  │  ├─ issue.md

         │  │  └─ bug_report.md

         │  └─ workflows

         │     ├─ reviewdog.yml

         │     ├─ build.yml

         │     ├─ unit_test.yml

         │     ├─ release.yml

         │     └─ contributors.yml

         └─ internal

            ├─ cmdinfo

            │  └─ cmdinfo.go

            ├─ completion

            │  └─ completion.go

            └─ print

               └─ print.go

[START] Execute 'go mod init github.com/nao1215/sample'

[START] Execute 'go mod tidy'

BUILD SUCCESSFUL in 2485[ms]

$ cd sample

$ make build

$ ls

CODE_OF_CONDUCT.md  Changelog.md  Makefile  cmd  go.mod  go.sum  internal  main.go  sample

```

## Generate library project

```

$ mkgoprj library github.com/nao1215/sample

mkgoprj starts creating the 'sample' library project (import path='github.com/nao1215/sample')

[START] check if mkgoprj can create the project

[START] create directories

[START] create files

        sample (your project root)

         ├─ sample_test.go

         ├─ CODE_OF_CONDUCT.md

         ├─ Makefile

         ├─ Changelog.md

         ├─ sample.go

         └─ .github

            ├─ dependabot.yml

            ├─ ISSUE_TEMPLATE

            │  ├─ issue.md

            │  └─ bug_report.md

            └─ workflows

               ├─ reviewdog.yml

               ├─ unit_test.yml

               └─ contributors.yml

               

[START] Execute 'go mod init github.com/nao1215/sample'

BUILD SUCCESSFUL in 5[ms]

$ cd sample/

$ make test

env GOOS=linux go test -v -cover ./... -coverprofile=cover.out

=== RUN   TestHelloWorld

--- PASS: TestHelloWorld (0.00s)

PASS

coverage: 100.0% of statements

ok      github.com/nao1215/sample       0.002s  coverage: 100.0% of statements

go tool cover -html=cover.out -o cover.html

```

# GitHub Actions

mkgoprj command generates the GitHub Actions listed in the table below when creating a project.

| Action name |Description|

|:--|:--|

|build| Build the project|

|unit test| Run unit test|

|reviewdog|Static Analysis |

| release|Release projects in units of git tags |

|contributors | Generate Contributors.md|

# Self-documented Makefile

The Makefile generated by the mkgoprj command is [self-documenting](https://marmelab.com/blog/2016/02/29/auto-documented-makefile.html). When you run the make command, you will see the target list that exists in the Makefile. A help message is showed next to the target name.

```

$ make

build           Build binary 

clean           Clean project

fmt             Format go source code 

test            Start test

vet             Start go vet

```

If you want to add a new target, please comment with **"##"** next to the target. The string after "##" is extracted and used as a help message. An example is shown below.

```

build:  ## Build binary 

	env GO111MODULE=on GOOS=$(GOOS) $(GO_BUILD) $(GO_LDFLAGS) -o $(APP) cmd/sample/main.go

clean: ## Clean project

	-rm -rf $(APP) cover.out cover.html

```

# Auto-generate shell completion file (for bash, zsh, fish)

mkgoprj command automatically generates shell completion files for bash, zsh, and fish. After the user executes mkgoprj, if the shell completion file does not exist in the system, the auto-generation process will begin. To activate the completion feature, restart the shell.

```

$ mkgoprj 

mkgoprj:INFO : append bash-completion file: /home/nao/.bash_completion

mkgoprj:INFO : create fish-completion file: /home/nao/.config/fish/completions/mkgoprj.fish

mkgoprj:INFO : create zsh-completion file: /home/nao/.zsh/completion/_mkgoprj

```

# Contributing

First off, thanks for taking the time to contribute! ❤️  See [CONTRIBUTING.md](./CONTRIBUTING.md) for more information.

Contributions are not only related to development. For example, GitHub Star motivates me to develop!

[![Star History Chart](https://api.star-history.com/svg?repos=nao1215/mkgoprj&type=Date)](https://star-history.com/#nao1215/mkgoprj&Date)

# Contact

If you would like to send comments such as "find a bug" or "request for additional features" to the developer, please use one of the following contacts.

- [GitHub Issue](https://github.com/nao1215/mkgoprj/v2/issues)

# LICENSE

The mkgoprj project is licensed under the terms of [the Apache License 2.0](./LICENSE).