# guarding

**Repository Path**: thoughtworks/guarding

## Basic Information

- **Project Name**: guarding
- **Description**: Guarding 是一个用于 Java、JavaScript、Rust、Golang 等语言的架构守护工具。借助于易于理解的 DSL，来编写守护规则。
- **Primary Language**: Rust
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 6
- **Forks**: 1
- **Created**: 2021-06-04
- **Last Updated**: 2025-05-14

## Categories & Tags

**Categories**: nms

**Tags**: None

## README

# Guarding

[![Build](https://github.com/inherd/guarding/actions/workflows/build.yml/badge.svg)](https://github.com/inherd/guarding/actions/workflows/build.yml)
[![crates.io](https://img.shields.io/badge/crates.io-v0.2.1-orange.svg)](https://crates.io/crates/guarding)
[![docs.rs](https://docs.rs/guarding/badge.svg)](https://docs.rs/guarding/)
[![license](https://img.shields.io/crates/l/guarding)](https://github.com/inherd/guarding/blob/master/LICENSE)

> Guarding is a guardians for code, architecture, layered. Using git hooks and DSL for design guard rules.

![Guarding Process](docs/guarding-process.svg)

## Usage

1. install

```
cargo install guarding
```

2. create `guarding.guarding` file

```
package(".")::file.len should < 200;
package(".")::file.len should > 50;
```

3. run 

```
guarding .
```

## Development

workflow:

1. parsing guarding rules
2. parsing source code to models
3. capture rule with models

DSL capture logic:

1. filter models from `rule_level` with `rule_scope`
2. run expression
3. run assert

Queries Samples: [https://github.com/nvim-treesitter/nvim-treesitter/tree/master/queries](https://github.com/nvim-treesitter/nvim-treesitter/tree/master/queries)

### Guarding - Class or Struct function-name

for Java, JavaScript

```
# 类::名 包含 "Controller";
# 中文分词：("..myapp..") 类名称中包含 "Controller"
class("..myapp..")::function.name should contains("Model");
# or
class("..myapp..")::function.name contains("");
```

for Rust and Golang

```
struct("..myapp..")::function.name should contains("Model");
# or
struct("..myapp..")::function.name contains("");
```

## Todos


todo:

- [x] filter
  - [x] filter by package identifier
  - [ ] filter by regex
  - [x] filter by implementation
  - [x] filter by extends
  - [ ] filter by trait
- [x] limit impl naming
- [x] limit files num
- [ ] limit package's sub-package size (for example, Clean Architecture).
- [x] assert
  - [x] comparison for size / len
  - [x] string comparison
    - [x] contains
    - [x] startsWith
    - [x] endsWith
  - [ ] package ops
    - [x] accessed
    - [x] resideIn
    - [ ] dependBy
- [ ] languages
  - [x] Java
  - [ ] JavaScript (on Going)
  - [ ] TypeScript
  - [ ] Rust (on Going)
    - [x] class & functions
    - [ ] imports
      - [ ] basic import
      - [ ] mods import restructure
    - [ ] package convert

License
---

This code is distributed under the MIT license. See `LICENSE` in this directory.