diff --git a/.markdownlint.yaml b/.markdownlint.yaml new file mode 100644 index 0000000..7878275 --- /dev/null +++ b/.markdownlint.yaml @@ -0,0 +1,4 @@ +--- + +# Default state for all rules +default: true diff --git a/00-empty/.golangci.yml b/00-empty/.golangci.yml index 7f25495..2fb0fc5 100644 --- a/00-empty/.golangci.yml +++ b/00-empty/.golangci.yml @@ -1,7 +1,10 @@ --- # golangci-lint configuration file made by @ccoVeille -# Source: https://github.com/ccoVeille/golangci-lint-config-examples/tree/main/00-empty +# Source: https://github.com/ccoVeille/golangci-lint-config-examples/ +# Author: @ccoVeille # License: MIT +# Variant: 01-defaults +# Version: v1.0.0 # # empty file to force using the default settings # otherwise golangci-lint looks for .golangci.yaml files diff --git a/00-empty/README.md b/00-empty/README.md index c279a3f..8ca3697 100644 --- a/00-empty/README.md +++ b/00-empty/README.md @@ -4,11 +4,11 @@ One way to use the default settings is to use `--no-config` parameter. Another is to create an empty YAML file -See [.golangci.yaml](.golangci.yaml) +See [.golangci.yml](.golangci.yml) ## License License: MIT -golangci-lint configuration file made by @ccoVeille -Source: https://github.com/ccoVeille/golangci-lint-config-examples/tree/main/00-empty +Source: [@ccoVeille](https://github.com/ccoVeille/golangci-lint-config-examples) + diff --git a/01-defaults/.golangci.yml b/01-defaults/.golangci.yml index 534eab8..4ac56e3 100644 --- a/01-defaults/.golangci.yml +++ b/01-defaults/.golangci.yml @@ -1,7 +1,10 @@ --- # golangci-lint configuration file made by @ccoVeille -# Source: https://github.com/ccoVeille/golangci-lint-config-examples/tree/main/01-defaults +# Source: https://github.com/ccoVeille/golangci-lint-config-examples/ +# Author: @ccoVeille # License: MIT +# Variant: 01-defaults +# Version: v1.0.0 # linters: # some linters are enabled by default diff --git a/01-defaults/README.md b/01-defaults/README.md index 3931986..0035e97 100644 --- a/01-defaults/README.md +++ b/01-defaults/README.md @@ -2,14 +2,13 @@ These are the currently available linter that are enabled in the current last `golangci-lint` version available today (1.59.1) -See [.golangci.yaml](.golangci.yaml) +See [.golangci.yml](.golangci.yml) ## License License: MIT -golangci-lint configuration file made by @ccoVeille -Source: https://github.com/ccoVeille/golangci-lint-config-examples/tree/main/01-defaults +Source: [@ccoVeille](https://github.com/ccoVeille/golangci-lint-config-examples) ## Enabled linters @@ -28,9 +27,4 @@ Source: https://github.com/ccoVeille/golangci-lint-config-examples/tree/main/01- ### staticcheck It's a set of rules from staticcheck. See https://staticcheck.io/ -## Changelog - -- 2024-06-28 - golangci-lint:1.59.1 - - initial version diff --git a/02-basic/.golangci.yml b/02-basic/.golangci.yml index 18a6f1e..d519af3 100644 --- a/02-basic/.golangci.yml +++ b/02-basic/.golangci.yml @@ -1,7 +1,10 @@ --- # golangci-lint configuration file made by @ccoVeille -# Source: https://github.com/ccoVeille/golangci-lint-config-examples/tree/main/02-basic +# Source: https://github.com/ccoVeille/golangci-lint-config-examples/ +# Author: @ccoVeille # License: MIT +# Variant: 02-basic +# Version: v1.0.0 # linters: # some linters are enabled by default diff --git a/02-basic/README.md b/02-basic/README.md index 0cdf0f7..0eda0de 100644 --- a/02-basic/README.md +++ b/02-basic/README.md @@ -1,6 +1,6 @@ # Basic Settings -See [.golangci.yaml](.golangci.yaml) +See [.golangci.yml](.golangci.yml) It's [01-defaults](../01-defaults) plus : - [revive](#revive) @@ -96,9 +96,3 @@ report when a variable declaration can be simplified #### var-naming warns when initialism, variable or package naming conventions are not followed. - -## Changelog - -- 2024-06-28 - golangci-lint:1.59.1 - - initial version diff --git a/03-safe/.golangci.yml b/03-safe/.golangci.yml index 4c75197..e895eb7 100644 --- a/03-safe/.golangci.yml +++ b/03-safe/.golangci.yml @@ -1,7 +1,10 @@ --- # golangci-lint configuration file made by @ccoVeille -# Source: https://github.com/ccoVeille/golangci-lint-config-examples/tree/main/03-safe +# Source: https://github.com/ccoVeille/golangci-lint-config-examples/ +# Author: @ccoVeille # License: MIT +# Variant: 03-safe +# Version: v1.0.0 # linters: # some linters are enabled by default diff --git a/03-safe/README.md b/03-safe/README.md index c395cee..bcb174b 100644 --- a/03-safe/README.md +++ b/03-safe/README.md @@ -1,6 +1,6 @@ # Safe Settings -See [.golangci.yaml](.golangci.yaml) +See [.golangci.yml](.golangci.yml) It's [02-basic](../02-basic) plus : - [gci](#gci) @@ -14,8 +14,7 @@ It's [02-basic](../02-basic) plus : License: MIT -golangci-lint configuration file made by @ccoVeille -Source: https://github.com/ccoVeille/golangci-lint-config-examples/tree/main/03-safe +Source: [@ccoVeille](https://github.com/ccoVeille/golangci-lint-config-examples) ## Enabled linters @@ -118,9 +117,3 @@ report when a variable declaration can be simplified #### var-naming warns when initialism, variable or package naming conventions are not followed. - -## Changelog - -- 2024-06-28 - golangci-lint:1.59.1 - - initial version diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..9d293ca --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,14 @@ +# Changelog + + + + +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +## [Unreleased] +### Added +- initial version +- LICENSE diff --git a/README.md b/README.md index 04d633e..906a105 100644 --- a/README.md +++ b/README.md @@ -17,11 +17,6 @@ Each variant adds rules to the earlier one. License: MIT -golangci-lint configuration file made by @ccoVeille -Source: https://github.com/ccoVeille/golangci-lint-config-examples +Author: [@ccoVeille](https://github.com/ccoVeille) -## Changelog - -- 2024-06-28 - golangci-lint:1.59.1 - - initial version +Source: [ccoVeille/golangci-lint-config-examples](https://github.com/ccoVeille/golangci-lint-config-examples)