Skip to content

Commit

Permalink
feat: introduce .goarkitect.yaml file for the project
Browse files Browse the repository at this point in the history
  • Loading branch information
omissis committed Aug 16, 2022
1 parent 57bfb5d commit 4d61984
Showing 1 changed file with 44 additions and 0 deletions.
44 changes: 44 additions & 0 deletions .goarkitect.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
---
rules:
- name: mandatory files should exist
kind: file
matcher:
kind: "set"
filePaths:
- .envrc.dist
- .goarkitect.yaml
- .tool-versions.dist
- go.mod
- go.sum
- main.go
- README.md
shoulds:
- kind: exist
because: "they are mandatory for the project to work"
- name: all files in "cmd/" folder are go files
kind: file
matcher:
kind: all
thats:
- kind: are_in_folder
folder: ./cmd
recursive: false
excepts:
- kind: this
filePath: .DS_Store
shoulds:
- kind: end_with
suffix: .go
because: "only go files are allowed by the project layout"
- name: some dev files and folders are git ignored
kind: file
matcher:
kind: set
filePaths:
- .envrc
- .idea
- .tool-versions
- .vscode
shoulds:
- kind: be_gitignored
because: "every developer should be able to choose what behaviors and configurations run on their machine"

0 comments on commit 4d61984

Please sign in to comment.