Guarding
Guarding is a guardians for code, architecture, layered. Using git hooks and DSL for design guard rules.
Usage
- install
cargo install guarding
- create
guarding.guardingfile
package(".")::file.len should < 200;
package(".")::file.len should > 50;
- run
guarding .
Development
workflow:
- parsing guarding rules
- parsing source code to models
- capture rule with models
DSL capture logic:
- filter models from
rule_levelwithrule_scope - run expression
- run assert
Queries Samples: 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:
- filter
- filter by package identifier
- filter by regex
- filter by implementation
- filter by extends
- filter by trait
- limit impl naming
- limit files num
- limit package's sub-package size (for example, Clean Architecture).
- assert
- comparison for size / len
- string comparison
- contains
- startsWith
- endsWith
- package ops
- accessed
- resideIn
- dependBy
- languages
- Java
- JavaScript (on Going)
- TypeScript
- Rust (on Going)
- class & functions
- imports
- basic import
- mods import restructure
- package convert
License
This code is distributed under the MIT license. See LICENSE in this directory.
5.9k Jan 8, 2023
32 Jun 16, 2021
14 Jun 16, 2022
1k Jan 5, 2023
4 Aug 30, 2021
1 May 10, 2022
7 Oct 7, 2022
7.3k Jan 8, 2023
59 Dec 19, 2022
318 Jan 1, 2023
11 Feb 13, 2022
355 Dec 28, 2022
768 Dec 30, 2022
122 Dec 15, 2022
15 Nov 28, 2022
2 Nov 27, 2021
25.4k Dec 31, 2022
1 Mar 2, 2022
8 Jan 13, 2023