prolayout

command module

v0.0.1 Latest Latest Go to latest Published: Apr 9, 2024 License: MIT Imports: 6 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/wimspaargaren/prolayout

Links

Open Source Insights

README ¶

ProLayout

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

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"

Documentation ¶

Overview ¶

Package main bootstrap the analyzer to validate the project structure.

Source Files ¶

View all Source files

main.go

Directories ¶

Path	Synopsis
internal
analyzer Package analyzer contains the logic to validate the project structure.	Package analyzer contains the logic to validate the project structure.
errors Package errors contains the error types that can be returned by the analyzer.	Package errors contains the error types that can be returned by the analyzer.
model Package model contains the project structure definitions.	Package model contains the project structure definitions.

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL