Skip to content

Latest commit

 

History

History
37 lines (28 loc) · 677 Bytes

README.md

File metadata and controls

37 lines (28 loc) · 677 Bytes

ProLayout

Pro(ject) layout is a static analysis tool that allow you to lint the project structure of your go project.

Development

Either use make or task:

Task

TASK_X_REMOTE_TASKFILES=1 task test-all --yes

Why

Since Go does not enforce any real project structure, we wanted to have a static analysis tool, to help us to ensure projects are structured in a similar fashion.

Example configuration file

module: "github.com/wimspaargaren/prolayout"
root:
  - name: "cmd"
    dirs:
      - name: ".*"
        files:
          - "main.go"
  - name: "internal"
  - name: "pkg"
  - name: "tests"
    files:
      - name: ".*_test.go"