{"id":20602142,"url":"https://github.com/modernizing/guarding","last_synced_at":"2025-04-15T01:54:17.448Z","repository":{"id":39335581,"uuid":"366991939","full_name":"modernizing/guarding","owner":"modernizing","description":"Guarding is a guardians for code, architecture, layered, inspired by ArchUnit. Guarding 是一个用于 Java、JavaScript、Rust、Golang 等语言的架构守护工具。借助于易于理解的 DSL，来编写守护规则。Guarding is a guardians for code, architecture, layered. ","archived":false,"fork":false,"pushed_at":"2022-02-21T01:49:40.000Z","size":763,"stargazers_count":71,"open_issues_count":0,"forks_count":13,"subscribers_count":6,"default_branch":"master","last_synced_at":"2025-04-04T17:03:07.929Z","etag":null,"topics":["architecture","architecture-tests","archunit","guardian"],"latest_commit_sha":null,"homepage":"","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/modernizing.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":".github/CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-05-13T09:00:49.000Z","updated_at":"2025-01-06T11:37:33.000Z","dependencies_parsed_at":"2022-09-16T03:50:29.654Z","dependency_job_id":null,"html_url":"https://github.com/modernizing/guarding","commit_stats":null,"previous_names":["inherd/guarding"],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/modernizing%2Fguarding","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/modernizing%2Fguarding/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/modernizing%2Fguarding/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/modernizing%2Fguarding/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/modernizing","download_url":"https://codeload.github.com/modernizing/guarding/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248442500,"owners_count":21104197,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["architecture","architecture-tests","archunit","guardian"],"created_at":"2024-11-16T09:12:55.000Z","updated_at":"2025-04-15T01:54:17.423Z","avatar_url":"https://github.com/modernizing.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Guarding\n\n[![Build](https://github.com/inherd/guarding/actions/workflows/build.yml/badge.svg)](https://github.com/inherd/guarding/actions/workflows/build.yml)\n[![crates.io](https://img.shields.io/badge/crates.io-v0.2.1-orange.svg)](https://crates.io/crates/guarding)\n[![docs.rs](https://docs.rs/guarding/badge.svg)](https://docs.rs/guarding/)\n[![license](https://img.shields.io/crates/l/guarding)](https://github.com/inherd/guarding/blob/master/LICENSE)\n\n\u003e Guarding is a guardians for code, architecture, layered. Using git hooks and DSL for design guard rules.\n\nInspired by [ArchUnit](https://github.com/TNG/ArchUnit)\n\n![Guarding Process](docs/guarding-process.svg)\n\n## Usage\n\n### use CLI\n\n1. install\n\n```\ncargo install guarding\n```\n\n2. create `guarding.guarding` file\n\n```\npackage(\".\")::file.len should \u003c 200;\npackage(\".\")::file.len should \u003e 50;\n```\n\n3. run \n\n```\nguarding .\n```\n\n### use API\n\n- `guarding_adapter`, FFI adapter, provide Guarding api,\n- `guarding_core`, core guarding model,\n- `guarding_ident`, identify different language: Java, JavaScript, Rust\n- `guarding_parser` parsing Guarding DSL\n\n## Development\n\nworkflow:\n\n1. parsing guarding rules\n2. parsing source code to models\n3. capture rule with models\n\nDSL capture logic:\n\n1. filter models from `rule_level` with `rule_scope`\n2. run expression\n3. run assert\n\nQueries Samples: [https://github.com/nvim-treesitter/nvim-treesitter/tree/master/queries](https://github.com/nvim-treesitter/nvim-treesitter/tree/master/queries)\n\n### Guarding - Class or Struct function-name\n\nfor packages:\n\n```\nclass(implementation \"BaseParser\")::name should endsWith \"Parser\";\n\nclass(\"java.util.Map\") only accessed([\"com.phodal.pepper.refactor.staticclass\"]);\nclass(implementation \"BaseParser\")::name should not contains \"Lexer\";\n```\n\nfor Java, JavaScript\n\n```\n# 类::名 包含 \"Controller\";\n# 中文分词：(\"..myapp..\") 类名称中包含 \"Controller\"\nclass(\"..myapp..\")::function.name should contains(\"Model\");\n# or\nclass(\"..myapp..\")::function.name contains(\"\");\n```\n\nfor Rust and Golang\n\n```\nstruct(\"..myapp..\")::function.name should contains(\"Model\");\n# or\nstruct(\"..myapp..\")::function.name contains(\"\");\n```\n\nLicense\n---\n\nThis code is distributed under the MIT license. See `LICENSE` in this directory.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmodernizing%2Fguarding","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmodernizing%2Fguarding","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmodernizing%2Fguarding/lists"}