Skip to content

Commit

Permalink
Initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
philoserf committed Oct 11, 2021
0 parents commit bc1078c
Show file tree
Hide file tree
Showing 16 changed files with 405 additions and 0 deletions.
1 change: 1 addition & 0 deletions .github/CODEOWNERS
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
* @philoserf
13 changes: 13 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
name: Bug report
about: Create a report to help us improve
title: ""
labels: "triage"
assignees: "philoserf"
---

- [ ] describe the bug
- [ ] provide steps to reproduce the bug
- [ ] describe the expected behavior
- [ ] provide screenshots as needed
- [ ] add any more context or commentary
12 changes: 12 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
name: Feature request
about: Suggest an idea for this project
title: ""
labels: "triage"
assignees: "philoserf"
---

- [ ] describe why you want this feature
- [ ] describe proposed sulution
- [ ] describe alternatives
- [ ] add context or commentary
10 changes: 10 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
labels: "triage"
assignees: "philoserf"
---

- [ ] reference the tracking issue
- [ ] describe why this is the solution
- [ ] describe where you think we should focus our attention as we review
- [ ] add details about how the solution works
- [ ] add context or commentary
53 changes: 53 additions & 0 deletions .github/settings.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
repository:
name: go
description: go tool and libraries
homepage: https://philoserf.github.io/go
topics: go
private: false
has_issues: true
has_projects: false
has_wiki: false
has_downloads: false
default_branch: main
allow_squash_merge: true
allow_merge_commit: false
allow_rebase_merge: false
enable_automated_security_fixes: true
enable_vulnerability_alerts: true

labels:
- name: bug
description: An unexpected problem or unintended behavior
- name: documentation
description: A need for improvements or additions to documentation
- name: duplicate
description: Similar to another issues or pull requests
- name: enhancement
description: New feature requests
- name: invalid
description: An issue or pull request is no longer relevant
- name: question
description: An issue or pull request needs more information
- name: wontfix
description: Work won't continue on an issue or pull request
- name: chore
description: Work unrelated to the core purpose

branches:
- name: main
protection:
required_pull_request_reviews:
required_approving_review_count: 1
dismiss_stale_reviews: true
require_code_owner_reviews: true
dismissal_restrictions:
users:
- philoserf
required_status_checks:
strict: true
contexts: []
enforce_admins: null
restrictions:
apps: []
users: []
teams: []
11 changes: 11 additions & 0 deletions .github/workflows/actions.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
name: checks
on: push # yamllint disable-line
jobs:
checks:
name: checks
runs-on: ubuntu-latest
steps:
- name: checkout
uses: actions/checkout@v2
- name: markdownlint-cli2-action
uses: DavidAnson/[email protected]
137 changes: 137 additions & 0 deletions .golangci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,137 @@
linters:
presets:
- bugs
- error
- unused
- format
- import
- metalinter
- style
- test
enable: []
disable:
# - bodyclose # toggle on when desired
# - dupl # toggle on when desired
# - errcheck # toggle on when desired
# - errorlint # toggle on when desired
# - exhaustivestruct # toggle on when desired
# - forbidigo # not useful for cli with default config
# - forcetypeassert # toggle on when desired
# - gci # toggle on when desired
# - gochecknoglobals # toggle on when desired
# - gocritic # toggle on when desired
# - godox # toggle on when desired
# - goerr113 # toggle on when desired
- golint # deprecated
# - gomnd # toggle on when desired
# - gosec # toggle on when desired
# - ifshort # toggle on when desired
- interfacer # deprecated
# - lll # toggle on when desired
# - nlreturn # toggle on when desired
# - noctx # toggle on when desired
# - paralleltest # toggle on when desired
# - revive # toggle on when desired
- scopelint # deprecated
# - staticcheck # toggle on when desired
# - tagliatelle # toggle on when desired
# - testpackage # toggle on when desired
# - unconvert # toggle on when desired
# - unparam # toggle on when desired
# - wrapcheck # toggle on when desired
# - wsl # toggle on when desired

# Enabled by default linters:
# deadcode: Finds unused code [fast: false, auto-fix: false]
# errcheck: Errcheck is a program for checking for unchecked errors in go programs. These unchecked errors can be critical bugs in some cases [fast: false, auto-fix: false]
# gosimple (megacheck): Linter for Go source code that specializes in simplifying a code [fast: false, auto-fix: false]
# govet (vet, vetshadow): Vet examines Go source code and reports suspicious constructs, such as Printf calls whose arguments do not align with the format string [fast: false, auto-fix: false]
# ineffassign: Detects when assignments to existing variables are not used [fast: true, auto-fix: false]
# staticcheck (megacheck): Staticcheck is a go vet on steroids, applying a ton of static analysis checks [fast: false, auto-fix: false]
# structcheck: Finds unused struct fields [fast: false, auto-fix: false]
# typecheck: Like the front-end of a Go compiler, parses and type-checks Go code [fast: false, auto-fix: false]
# unused (megacheck): Checks Go code for unused constants, variables, functions and types [fast: false, auto-fix: false]
# varcheck: Finds unused global variables and constants [fast: false, auto-fix: false]

# Disabled by default linters:
# asciicheck: Simple linter to check that your code does not contain non-ASCII identifiers [fast: true, auto-fix: false]
# bodyclose: checks whether HTTP response body is closed successfully [fast: false, auto-fix: false]
# cyclop: checks function and package cyclomatic complexity [fast: false, auto-fix: false]
# depguard: Go linter that checks if package imports are in a list of acceptable packages [fast: false, auto-fix: false]
# dogsled: Checks assignments with too many blank identifiers (e.g. x, _, _, _, := f()) [fast: true, auto-fix: false]
# dupl: Tool for code clone detection [fast: true, auto-fix: false]
# durationcheck: check for two durations multiplied together [fast: false, auto-fix: false]
# errorlint: errorlint is a linter for that can be used to find code that will cause problems with the error wrapping scheme introduced in Go 1.13. [fast: false, auto-fix: false]
# exhaustive: check exhaustiveness of enum switch statements [fast: false, auto-fix: false]
# exhaustivestruct: Checks if all struct's fields are initialized [fast: false, auto-fix: false]
# exportloopref: checks for pointers to enclosing loop variables [fast: false, auto-fix: false]
# forbidigo: Forbids identifiers [fast: true, auto-fix: false]
# forcetypeassert: finds forced type assertions [fast: true, auto-fix: false]
# funlen: Tool for detection of long functions [fast: true, auto-fix: false]
# gci: Gci control golang package import order and make it always deterministic. [fast: true, auto-fix: true]
# gochecknoglobals: check that no global variables exist [fast: true, auto-fix: false]
# gochecknoinits: Checks that no init functions are present in Go code [fast: true, auto-fix: false]
# gocognit: Computes and checks the cognitive complexity of functions [fast: true, auto-fix: false]
# goconst: Finds repeated strings that could be replaced by a constant [fast: true, auto-fix: false]
# gocritic: Provides many diagnostics that check for bugs, performance and style issues. [fast: false, auto-fix: false]
# gocyclo: Computes and checks the cyclomatic complexity of functions [fast: true, auto-fix: false]
# godot: Check if comments end in a period [fast: true, auto-fix: true]
# godox: Tool for detection of FIXME, TODO and other comment keywords [fast: true, auto-fix: false]
# goerr113: Golang linter to check the errors handling expressions [fast: false, auto-fix: false]
# gofmt: Gofmt checks whether code was gofmt-ed. By default this tool runs with -s option to check for code simplification [fast: true, auto-fix: true]
# gofumpt: Gofumpt checks whether code was gofumpt-ed. [fast: true, auto-fix: true]
# goheader: Checks is file header matches to pattern [fast: true, auto-fix: false]
# goimports: Goimports does everything that gofmt does. Additionally it checks unused imports [fast: true, auto-fix: true]
# golint: Golint differs from gofmt. Gofmt reformats Go source code, whereas golint prints out style mistakes [fast: false, auto-fix: false]
# gomnd: An analyzer to detect magic numbers. [fast: true, auto-fix: false]
# gomoddirectives: Manage the use of 'replace', 'retract', and 'excludes' directives in go.mod. [fast: true, auto-fix: false]
# gomodguard: Allow and block list linter for direct Go module dependencies. This is different from depguard where there are different block types for example version constraints and module recommendations. [fast: true, auto-fix: false]
# goprintffuncname: Checks that printf-like functions are named with `f` at the end [fast: true, auto-fix: false]
# gosec (gas): Inspects source code for security problems [fast: false, auto-fix: false]
# ifshort: Checks that your code uses short syntax for if-statements whenever possible [fast: true, auto-fix: false]
# importas: Enforces consistent import aliases [fast: false, auto-fix: false]
# interfacer: Linter that suggests narrower interface types [fast: false, auto-fix: false]
# lll: Reports long lines [fast: true, auto-fix: false]
# makezero: Finds slice declarations with non-zero initial length [fast: false, auto-fix: false]
# maligned: Tool to detect Go structs that would take less memory if their fields were sorted [fast: false, auto-fix: false]
# misspell: Finds commonly misspelled English words in comments [fast: true, auto-fix: true]
# nakedret: Finds naked returns in functions greater than a specified function length [fast: true, auto-fix: false]
# nestif: Reports deeply nested if statements [fast: true, auto-fix: false]
# nilerr: Finds the code that returns nil even if it checks that the error is not nil. [fast: false, auto-fix: false]
# nlreturn: nlreturn checks for a new line before return and branch statements to increase code clarity [fast: true, auto-fix: false]
# noctx: noctx finds sending http request without context.Context [fast: false, auto-fix: false]
# nolintlint: Reports ill-formed or insufficient nolint directives [fast: true, auto-fix: false]
# paralleltest: paralleltest detects missing usage of t.Parallel() method in your Go test [fast: true, auto-fix: false]
# prealloc: Finds slice declarations that could potentially be preallocated [fast: true, auto-fix: false]
# predeclared: find code that shadows one of Go's predeclared identifiers [fast: true, auto-fix: false]
# promlinter: Check Prometheus metrics naming via promlint [fast: true, auto-fix: false]
# revive: Fast, configurable, extensible, flexible, and beautiful linter for Go. Drop-in replacement of golint. [fast: false, auto-fix: false]
# rowserrcheck: checks whether Err of rows is checked successfully [fast: false, auto-fix: false]
# scopelint: Scopelint checks for unpinned variables in go programs [fast: true, auto-fix: false]
# sqlclosecheck: Checks that sql.Rows and sql.Stmt are closed. [fast: false, auto-fix: false]
# stylecheck: Stylecheck is a replacement for golint [fast: false, auto-fix: false]
# tagliatelle: Checks the struct tags. [fast: true, auto-fix: false]
# testpackage: linter that makes you use a separate _test package [fast: true, auto-fix: false]
# thelper: thelper detects golang test helpers without t.Helper() call and checks the consistency of test helpers [fast: false, auto-fix: false]
# tparallel: tparallel detects inappropriate usage of t.Parallel() method in your Go test codes [fast: false, auto-fix: false]
# unconvert: Remove unnecessary type conversions [fast: false, auto-fix: false]
# unparam: Reports unused function parameters [fast: false, auto-fix: false]
# wastedassign: wastedassign finds wasted assignment statements. [fast: false, auto-fix: false]
# whitespace: Tool for detection of leading and trailing whitespace [fast: true, auto-fix: true]
# wrapcheck: Checks that errors returned from external packages are wrapped [fast: false, auto-fix: false]
# wsl: Whitespace Linter - Forces you to use empty lines! [fast: true, auto-fix: false]

# Linters presets:
# bugs: asciicheck, bodyclose, durationcheck, errcheck, errorlint, exhaustive, exportloopref, gosec, govet, makezero, nilerr, noctx, rowserrcheck, scopelint, sqlclosecheck, staticcheck, typecheck
# comment: godot, godox, misspell
# complexity: cyclop, funlen, gocognit, gocyclo, nestif
# error: errcheck, errorlint, goerr113, wrapcheck
# format: gci, gofmt, gofumpt, goimports
# import: depguard, gci, goimports, gomodguard
# metalinter: gocritic, govet, revive, staticcheck
# module: depguard, gomoddirectives, gomodguard
# performance: bodyclose, maligned, noctx, prealloc
# sql: rowserrcheck, sqlclosecheck
# style: asciicheck, depguard, dogsled, dupl, exhaustivestruct, forbidigo, forcetypeassert, gochecknoglobals, gochecknoinits, goconst, gocritic, godot, godox, goerr113, goheader, golint, gomnd, gomoddirectives, gomodguard, goprintffuncname, gosimple, ifshort, importas, interfacer, lll, makezero, misspell, nakedret, nlreturn, nolintlint, paralleltest, predeclared, promlinter, revive, stylecheck, tagliatelle, testpackage, thelper, tparallel, unconvert, wastedassign, whitespace, wrapcheck, wsl
# test: exhaustivestruct, paralleltest, testpackage, tparallel
# unused: deadcode, ineffassign, structcheck, unparam, unused, varcheck
2 changes: 2 additions & 0 deletions .markdownlint.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
MD013: false
MD033: false
14 changes: 14 additions & 0 deletions .yamllint
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
extends: default

yaml-files:
- '*.yaml'
- '*.yml'
- '.yamllint'

rules:
line-length: disable
braces:
max-spaces-inside: 1
indentation:
spaces: consistent
document-start: disable
26 changes: 26 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
Copyright 2021 Mark Ayers

This is free and unencumbered software released into the public domain.

Anyone is free to copy, modify, publish, use, compile, sell, or
distribute this software, either in source code form or as a compiled
binary, for any purpose, commercial or non-commercial, and by any
means.

In jurisdictions that recognize copyright laws, the author or authors
of this software dedicate any and all copyright interest in the
software to the public domain. We make this dedication for the benefit
of the public at large and to the detriment of our heirs and
successors. We intend this dedication to be an overt act of
relinquishment in perpetuity of all present and future rights to this
software under copyright law.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.

For more information, please refer to <http://unlicense.org/>
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Go tools, toys, & libraries

## Contents

- [dice][dice]: Dice library
- [aria][aria]: Aria worlds generation toy
- [traveller][traveller]: Traveller generation toy

<hr>
| [home] | [philoserf.com] | [source] |

<!-- ref -->
[home]: https://philoserf.github.io/
[philoserf.com]: https://philoserf.com/
[source]: https://github.com/philoserf/go
[dice]: https://pkg.go.dev/github.com/philoserf/go/dice
[aria]: aria/
[traveller]: traveller/
19 changes: 19 additions & 0 deletions aria/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Aria

> Based on the [Aria Worlds][aw] supplement to the tabletop role-playing game, [Aria: Canticle of the Monomyth][aria], designed by [Christian Moore][cm] and [Owen Seyler][os] and published by [Last Unicorn Games][lu].


<hr>
| [home] | [philoserf.com] | [source] |

<!-- ref -->
[home]: https://philoserf.github.io/
[philoserf.com]: https://philoserf.com/
[source]: https://github.com/philoserf/go
[aria]: https://en.wikipedia.org/wiki/Aria:_Canticle_of_the_Monomyth
[aw]: https://en.wikipedia.org/wiki/Aria_Worlds
[lu]: https://en.wikipedia.org/wiki/Last_Unicorn_Games
[cm]: https://en.wikipedia.org/wiki/Christian_Moore
[bc]: https://en.wikipedia.org/wiki/Bernie_Cahill
[os]: https://en.wikipedia.org/wiki/Owen_Seyler
38 changes: 38 additions & 0 deletions dice/dice.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
// Package dice provides a few simple functions to return dice-like results
package dice

import (
crand "crypto/rand"
"math/rand"
)

func init() { //nolint
bits := 64
seed, _ := crand.Prime(crand.Reader, bits)
rand.Seed(seed.Int64())
}

// D returns a random integer, either 0 or 1.
func D(sides int) int {
return rand.Intn(sides) + 1 //nolint
}

// D2 returns a random integer either 0 or 1.
func D2() int {
return D(2) //nolint
}

// D6 returns a random integer between 1 and 6.
func D6() int {
return D(6) //nolint
}

// D10 returns a random integer between 1 and 10.
func D10() int {
return D(10) //nolint
}

// D100 returns a random integer between 1 and 100.
func D100() int {
return D(100) //nolint
}
Loading

0 comments on commit bc1078c

Please sign in to comment.