Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore #15

Merged
merged 3 commits into from
Jun 29, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .markdownlint.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---

# Default state for all rules
default: true
5 changes: 4 additions & 1 deletion 00-empty/.golangci.yml
Original file line number Diff line number Diff line change
@@ -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
Expand Down
6 changes: 3 additions & 3 deletions 00-empty/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

5 changes: 4 additions & 1 deletion 01-defaults/.golangci.yml
Original file line number Diff line number Diff line change
@@ -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
Expand Down
10 changes: 2 additions & 8 deletions 01-defaults/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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

5 changes: 4 additions & 1 deletion 02-basic/.golangci.yml
Original file line number Diff line number Diff line change
@@ -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
Expand Down
8 changes: 1 addition & 7 deletions 02-basic/README.md
Original file line number Diff line number Diff line change
@@ -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)
Expand Down Expand Up @@ -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
5 changes: 4 additions & 1 deletion 03-safe/.golangci.yml
Original file line number Diff line number Diff line change
@@ -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
Expand Down
11 changes: 2 additions & 9 deletions 03-safe/README.md
Original file line number Diff line number Diff line change
@@ -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)
Expand All @@ -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

Expand Down Expand Up @@ -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
14 changes: 14 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Changelog

<!-- markdownlint-disable MD022 MD032 -->
<!-- markdownlint-enable siblings_only -->

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
9 changes: 2 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Loading