Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gobuffalo/shoulders
SHOULDERS.md generator
https://github.com/gobuffalo/shoulders
generator go golang
Last synced: 2 days ago
JSON representation
SHOULDERS.md generator
- Host: GitHub
- URL: https://github.com/gobuffalo/shoulders
- Owner: gobuffalo
- License: mit
- Created: 2018-08-09T19:08:01.000Z (over 6 years ago)
- Default Branch: main
- Last Pushed: 2022-09-26T04:21:56.000Z (about 2 years ago)
- Last Synced: 2024-06-19T05:54:46.239Z (5 months ago)
- Topics: generator, go, golang
- Language: Go
- Homepage:
- Size: 39.1 KB
- Stars: 20
- Watchers: 10
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Shoulders
Inspired by the [SHOULDERS.md](https://github.com/gobuffalo/buffalo/blob/master/SHOULDERS.md) several projects have started to create their own implementations. This tool will create a custom SHOULDERS.md file for any given Go project allowing OSS maintainers to recognize those who's OSS contributions helped them.
## Installation
```console
$ go install github.com/gobuffalo/shoulders@latest
```
## Usage
When run without any flags the `shoulders` command will print the `SHOULDERS.md` to the `STDOUT`.
```console
$ shoulders
# github.com/gobuffalo/shoulders Stands on the Shoulders of Giants
github.com/gobuffalo/shoulders does not try to reinvent the wheel! Instead, it uses the already great wheels developed by the Go community and puts them all together in the best way possible. Without these giants, this project would not be possible. Please make sure to check them out and thank them for all of their hard work.
Thank you to the following **GIANTS**:
* [github.com/yuin/goldmark](https://godoc.org/github.com/yuin/goldmark)
* [golang.org/x/crypto](https://godoc.org/golang.org/x/crypto)
* [golang.org/x/mod](https://godoc.org/golang.org/x/mod)
* [golang.org/x/net](https://godoc.org/golang.org/x/net)
* [golang.org/x/sync](https://godoc.org/golang.org/x/sync)
* [golang.org/x/sys](https://godoc.org/golang.org/x/sys)
* [golang.org/x/text](https://godoc.org/golang.org/x/text)
* [golang.org/x/tools](https://godoc.org/golang.org/x/tools)
* [golang.org/x/xerrors](https://godoc.org/golang.org/x/xerrors)
```
### The `-w` (Write) Flag
To write the `SHOULDERS.md` file to disk use the `-w` flag.
```console
$ shoulders -w
```
### The `-n` (Name) Flag
By default the "name" of the project is the current package name. To change that use the `-n` flag.
```console
$ shoulders -n shoulders
# shoulders Stands on the Shoulders of Giants
shoulder does not try to reinvent the wheel! Instead, it uses the already great wheels developed by the Go community and puts them all together in the best way possible. Without these giants, this project would not be possible. Please make sure to check them out and thank them for all of their hard work.
<...>
```
### The `-j` (JSON) Flag
To get a JSON array of the dependencies of the project use the `-j` flag.
```console
$ shoulders -j
["github.com/yuin/goldmark","golang.org/x/crypto","golang.org/x/mod","golang.org/x/net","golang.org/x/sync","golang.org/x/sys","golang.org/x/text","golang.org/x/tools","golang.org/x/xerrors"]
```