Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 42 additions & 0 deletions .github/workflows/lint-rust.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
name: Lint Rust

on:
push:
branches:
- dev
- main
paths:
- '**/*.rs'
- '**/Cargo.toml'
- '**/Cargo.lock'

pull_request:
branches:
- dev
- main

concurrency:
group: ${{ github.ref }}-${{ github.workflow }}
cancel-in-progress: true

jobs:
lint:
runs-on: ubuntu-latest
permissions:
contents: read
steps:
- uses: actions/checkout@v6
with:
persist-credentials: false

- uses: dtolnay/rust-toolchain@stable
with:
components: rustfmt, clippy

- uses: Swatinem/rust-cache@v2

- name: Rustfmt
run: cargo fmt --all -- --check

- name: Clippy
run: cargo clippy --all-targets --all-features -- -D warnings
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
node_modules/
dist/
/target

*.secret

Expand Down
1 change: 1 addition & 0 deletions .n-rules.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
"ci4",
"feedback",
"ga",
"rust",
"security",
"text"
],
Expand Down
60 changes: 60 additions & 0 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

11 changes: 11 additions & 0 deletions Cargo.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
[package]
name = "mt-protocol"
version = "0.1.0"
edition = "2021"
description = "Специфікація протоколу MT, вбудована як Rust-крейт — docs/ корпус доступний без ручного копіювання"
license = "ISC"
repository = "https://github.com/nitra/mt"
keywords = ["mt", "protocol", "spec", "docs", "agent"]

[dependencies]
include_dir = { version = "0.7.4", features = ["glob"] }
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,3 +31,7 @@ npm i @7n/mt
## Генерація шарів

`docs/layers.json` — конфіг і CRC-маркери (`<!-- layers:... -->`) для рушія шарової документації (подвійний CRC суть/файл, LLM-генерація верхніх шарів, derived-переклади). Сам рушій живе в [nitra/mt-rust](https://github.com/nitra/mt-rust) і запускається звідти проти цього репозиторію.

## Крейт `mt-protocol` (Rust)

Поряд із `docs/` у цьому репозиторії живе невеликий Rust-крейт **`mt-protocol`** ([`Cargo.toml`](Cargo.toml), [`src/lib.rs`](src/lib.rs)): він вшиває каталог `docs/` у бінарник через [`include_dir`](https://docs.rs/include_dir) й дає доступ до вмісту специфікації без ручного копіювання файлів. Споживається як git-залежність у [nitra/mt-rust](https://github.com/nitra/mt-rust) — крейт наразі **не публікується в crates.io**, лише через `git`-dependency. npm-пакет `@7n/mt` лишається суто docs-only — Rust-файли в його публікований архів не входять.
46 changes: 46 additions & 0 deletions src/lib.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
//! Специфікація протоколу MT, вбудована в бінарник як Rust-крейт.
//!
//! Каталог `docs/` цього репозиторію (`nitra/mt`) вшивається на етапі
//! компіляції через [`include_dir`], тож споживачі (наприклад,
//! `nitra/mt-rust`) отримують корпус специфікації без ручного копіювання
//! чи мережевого доступу під час білду.

use include_dir::{include_dir, Dir};

/// Вшитий у бінарник каталог `docs/` — корпус специфікації протоколу MT.
pub static DOCS: Dir<'_> = include_dir!("$CARGO_MANIFEST_DIR/docs");

/// Повертає вміст файлу специфікації за відносним шляхом (наприклад,
/// `"index.md"` або `"architecture/overview.md"`), якщо він існує у
/// вшитому корпусі `docs/` і є коректним UTF-8.
pub fn get(path: &str) -> Option<&'static str> {
DOCS.get_file(path)?.contents_utf8()
}

#[cfg(test)]
mod tests {
use super::*;

#[test]
fn index_md_is_present_and_non_empty() {
let content = get("index.md").expect("index.md має бути у вшитому docs/ корпусі");
assert!(!content.is_empty(), "index.md не має бути порожнім");
}

#[test]
fn missing_file_returns_none() {
assert!(get("no-such-file.md").is_none());
}

#[test]
fn corpus_contains_more_than_a_handful_of_files() {
let count = DOCS
.find("**/*.md")
.expect("glob має бути валідним")
.count();
assert!(
count > 5,
"очікували більше 5 md-файлів у docs/, знайдено {count}"
);
}
}
Loading