https://github.com/omissis/goarkitect

Describe and check architectural constraints of a Go project using a composable set of rules described in one or multiple yaml files.
https://github.com/omissis/goarkitect

architecture go golang hacktoberfest

Last synced: 7 months ago
JSON representation

Describe and check architectural constraints of a Go project using a composable set of rules described in one or multiple yaml files.

• Host: GitHub
• URL: https://github.com/omissis/goarkitect
• Owner: omissis
• License: apache-2.0
• Created: 2022-02-08T23:19:46.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-10-14T03:15:18.000Z (about 1 year ago)
• Last Synced: 2024-10-15T03:29:23.049Z (12 months ago)
• Topics: architecture, go, golang, hacktoberfest
• Language: Go
• Homepage:
• Size: 4.6 MB
• Stars: 19
• Watchers: 2
• Forks: 0
• Open Issues: 14
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.md

Awesome Lists containing this project

README

          
# GoArkitect







This project gives developers the ability to describe and check  architectural constraints of a project using a composable set of rules described in one or multiple yaml files.

## Badges

[![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/omissis/goarkitect?style=for-the-badge)](https://github.com/omissis/goarkitect/releases/latest)

[![GitHub Workflow Status (event)](https://img.shields.io/github/workflow/status/omissis/goarkitect/development?style=for-the-badge)](https://github.com/omissis/goarkitect/actions?workflow=development)

[![License](https://img.shields.io/github/license/omissis/goarkitect?style=for-the-badge)](/LICENSE.md)

[![GitHub go.mod Go version](https://img.shields.io/github/go-mod/go-version/omissis/goarkitect?style=for-the-badge)](https://tip.golang.org/doc/go1.19)

[![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/omissis/goarkitect?style=for-the-badge)](https://github.com/omissis/goarkitect)

[![GitHub repo file count (file type)](https://img.shields.io/github/directory-file-count/omissis/goarkitect?style=for-the-badge)](https://github.com/omissis/goarkitect)

[![GitHub all releases](https://img.shields.io/github/downloads/omissis/goarkitect/total?style=for-the-badge)](https://github.com/omissis/goarkitect)

[![GitHub commit activity](https://img.shields.io/github/commit-activity/y/omissis/goarkitect?style=for-the-badge)](https://github.com/omissis/goarkitect/commits)

[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg?style=for-the-badge)](https://conventionalcommits.org)

[![Codecov branch](https://img.shields.io/codecov/c/github/omissis/goarkitect/main.svg?style=for-the-badge)](https://codecov.io/gh/omissis/goarkitect)

[![Code Climate maintainability](https://img.shields.io/codeclimate/maintainability/omissis/goarkitect?style=for-the-badge)](https://codeclimate.com/github/omissis/goarkitect)

## Installation

### homebrew tap

```bash

brew tap omissis/goarkitect

brew install goarkitect

```

### docker

```bash

docker pull omissis/goarkitect:latest

```

### manually

Download the pre-compiled binaries from the [releases page](https://github.com/omissis/goarkitect/releases) and copy them to the desired location.

## Example configuration

```yaml

---

rules:

  - name: all inner asdf manifests contain golang, possibly in its 1.23.2 version  # name of the rule, it should tell what the rule is about

    kind: file # name of the matcher to use, which tells what objects it will operate on

    matcher:

      kind: all # the all kind sets the matcher to match all possible files, which will be narrowed down below

    thats: # 'thats' apply filtering to the selected matchers to narrow down the files to operate on

      - kind: end_with # matcher filter that selects only files whose name ends with .tool-versions"

        suffix: .tool-versions

    excepts: # 'excepts' allow to pull some special cases out of the set of file determined by the 'thats' filters

      - kind: this # excepts the one in the root directory

        filePath: ./.tool-versions

    musts: # 'musts' will trigger errors in case the expectation is not respected, which in turn will have goarkitect to exit with status code 1

      - kind: contain_value

        value: golang

    shoulds: # 'shoulds' will trigger warnings, which won't cause error status codes on exit

      - kind: contain_value

        value: golang 1.23.2

    coulds: # 'coulds' will trigger info-level notices, and they can be seen as suggestions

      - kind: contain_value

        value: golangci-lint

    because: "it is needed for the project to compile the source code" # reason for the rule to exists

```

See the [examples folder](./examples/) for more complete information on how to configure goarkitect rules.

## Example usage

```sh

# validate the default config file (.goarkitect.yaml) and outputs the result in json

goarkitect validate --output=json

# validate the custom .ark.yaml config file

goarkitect validate .ark.yaml

# validate the custom .ark.yaml config file and all the config files found in the .ark/ folder

goarkitect validate .ark.yaml .ark/

# verify that the current folder follows the rules specified in the default config file (.goarkitect.yaml)

goarkitect verify

# verify that the current folder follows the rules specified in the .ark/ folder and outputs the result in json

goarkitect verify .ark/ --output=json

```

## Acknowledgements

Goarkitect draws inspiration from [Alessandro Minoccheri](https://alessandrominoccheri.github.io)'s [PHPArkitect](https://github.com/phparkitect/arkitect), a tool that helps you to keep your PHP codebase coherent and solid.