Deterministic CODEOWNERS parser, matcher, and coverage auditor for MoonBit.

codeowners

monorepo

developer-tools

github

Download zip

Author

404-32

Version

0.1.0

License

Apache-2.0

Repository

github.com/404-32/byc

Last updated

4 days ago

Downloads

moonbitlang/async0.22.5

#moon-codeowners

Deterministic CODEOWNERS parsing, matching, and coverage auditing for MoonBit.

moon-codeowners is a focused developer tool for monorepos and CI. It implements GitHub's CODEOWNERS precedence model, explains which rule selected an owner, and audits changed-file lists for missing ownership. The core library is pure MoonBit and works without network access.

#Why this project

Generic glob libraries answer "does this path match this pattern?". CODEOWNERS requires more:

the last matching rule wins;
rules can assign users, teams, or email addresses;
paths are case-sensitive;
a directory rule owns all descendants;
invalid lines are skipped and should be reported;
CI needs to know whether every changed file has an owner.

The package separates those policy semantics from generic pattern matching.

#Features

Parse users, teams, and email owners.
Support *, **, and ? path patterns.
Support root-anchored and unanchored patterns.
Apply GitHub's last-match-wins rule.
Explain the effective owner, matched pattern, and source line.
Audit one or many repository paths.
Report uncovered files and invalid CODEOWNERS lines.
Emit human-readable or JSON output from the CLI.
Run on the MoonBit Wasm target with no native dependency.

#Quick start

Build and test from source:

git clone https://github.com/404-32/byc.git
cd byc
moon test --target wasm

Explain an owner:

moon run cmd/main -- explain .github/CODEOWNERS src/parser.mbt

Check a changed-file list:

moon run cmd/main -- check .github/CODEOWNERS examples/changed-files.txt

Produce JSON for CI:

moon run cmd/main -- coverage .github/CODEOWNERS examples/changed-files.txt --json

Run the standalone library example:

moon run examples/basic

#Library API

///|
let document = @codeowners.Codeowners::parse(
  (
    #|*       @global-owner
    #|/src/   @src-team
    #|*.md    docs@example.com
  ),
)

///|
let rule = document.find_rule("src/http/client.mbt")

///|
let owners = document.owners_for("src/http/client.mbt")

///|
let report = document.audit(["src/http/client.mbt", "build/tool.exe"])

owners_for returns the effective owners. find_rule additionally exposes the matched pattern and line number. audit returns one result per input path, including uncovered paths and any parser diagnostics.

#CLI

moon-codeowners check <CODEOWNERS> [paths-file] [--json]
moon-codeowners owners <CODEOWNERS> <repo-path>
moon-codeowners explain <CODEOWNERS> <repo-path>
moon-codeowners coverage <CODEOWNERS> <paths-file> [--json]

A paths file contains one repository-relative path per line. check exits with an error when parsing or coverage checks fail, making it suitable for CI.

#Supported CODEOWNERS semantics

The last matching rule takes precedence.
* and ? do not cross /.
** may cross directory boundaries.
A leading / anchors a pattern to the repository root.
A trailing / marks a directory rule and covers its descendants.
A pattern containing no / matches path segments at any depth.
Paths are compared case-sensitively.
Windows-style path separators are normalized before matching.

Following GitHub's documented limitations, these forms are rejected and reported as parse issues:

! negation;
[abc] character classes;
backslash escaping.

Owner existence, team membership, and repository permissions are intentionally outside this package. Those checks require GitHub API credentials and introduce network-dependent policy. moon-codeowners remains an offline, deterministic core that can be used by CI, review bots, and editor tooling.

#Use cases

CI gate: every changed file must resolve to an owner before a pull request is accepted.
Review routing: a bot uses the matched user or team to request reviewers.
Developer tooling: an editor command explains why a file is assigned to a particular owner.

#Development

moon check --target wasm --deny-warn
moon test --target wasm --deny-warn
moon fmt --check
moon run cmd/main -- check .github/CODEOWNERS examples/changed-files.txt

License: Apache-2.0.

AuditEntry

source

pub(all) struct AuditEntry {
  path : String
  owners : Array[Owner]
  matched_pattern : String?
  matched_line : Int?
}

The ownership result for one repository path.

AuditReport

source

pub(all) struct AuditReport {
  entries : Array[AuditEntry]
  uncovered : Array[String]
  issues : Array[ParseIssue]
  covered_count : Int
  total_count : Int
}

A complete coverage audit.

Codeowners

source

pub(all) struct Codeowners {
  rules : Array[Rule]
  issues : Array[ParseIssue]
}

A parsed CODEOWNERS document.

Codeowners::audit

source

fn Codeowners::audit(self : Codeowners, paths : Array[String]) -> AuditReport

Codeowners::find_rule

source

fn Codeowners::find_rule(self : Codeowners, path : String) -> Rule?

Return the last matching rule. CODEOWNERS deliberately gives the last matching rule precedence.

Codeowners::is_valid

source

fn Codeowners::is_valid(self : Codeowners) -> Bool

Codeowners::owners_for

source

fn Codeowners::owners_for(self : Codeowners, path : String) -> Array[Owner]

Return the effective owners for a repository path.

Codeowners::parse

source

fn Codeowners::parse(text : String) -> Codeowners

Parse CODEOWNERS text. Invalid lines are skipped and collected in issues, mirroring GitHub's behavior.

Codeowners::rule_count

source

fn Codeowners::rule_count(self : Codeowners) -> Int

Owner

source

pub(all) struct Owner {
  raw : String
  kind : OwnerKind
}

A single CODEOWNERS owner token.

OwnerKind

source

pub(all) enum OwnerKind {
  User
  Team
  Email
}

The kind of owner accepted by a CODEOWNERS file.

ParseIssue

source

pub(all) struct ParseIssue {
  line : Int
  source : String
  message : String
}

A recoverable parsing problem. GitHub skips invalid CODEOWNERS lines, so the parser keeps valid rules and reports invalid lines separately.

Rule

source

pub(all) struct Rule {
  pattern : String
  owners : Array[Owner]
  line : Int
}

A parsed CODEOWNERS rule.

normalize_path

source

fn normalize_path(path : String) -> String

Normalize repository paths accepted from Windows and Unix callers.

Source Files

Site source Report issue Packages Build queue Skills Statistics

moon-codeowners

#moon-codeowners

#Why this project

#Features

#Quick start

#Library API

#CLI

#Supported CODEOWNERS semantics

#Use cases

#Development

#AuditEntry

#AuditReport

#Codeowners

#Codeowners::audit

#Codeowners::find_rule

#Codeowners::is_valid

#Codeowners::owners_for

#Codeowners::parse

#Codeowners::rule_count

#Owner

#OwnerKind

#ParseIssue

#Rule

#normalize_path

Source Files

AuditEntry

AuditReport

Codeowners

Codeowners::audit

Codeowners::find_rule

Codeowners::is_valid

Codeowners::owners_for

Codeowners::parse

Codeowners::rule_count

Owner

OwnerKind

ParseIssue

Rule

normalize_path