nomos 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b54115ded4fd9b060a08616a09c235b10fc9f061edcb9e3b6053f873c532b0fc
+  data.tar.gz: 5496082b49731cf351dc56f758889311cd252461da0cdfdf22a4a958aac3ca82
+SHA512:
+  metadata.gz: 36368f5ef5a456e90711881f774a57cf4c3550524c7a3d3cb263aebbb235af0624bf7a3c68c19b21156ab37310cbd197bbf2b54b40d2901a70a4983e442b0468
+  data.tar.gz: 86312a088c48e3191d649388dbb6a6aa963ea4d64e23bfdd2edd5d47acb921cac080e5360108812cbac5558fd4d885f8a2eef15baa0a812e160672dee03cb030

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# Changelog
+
+## Unreleased
+
+## 0.1.0 - 2026-01-17
+
+- Initial release.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2026 Yudai Takada
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,346 @@
+<p align="center">
+  <img src="docs/logo-header.svg" alt="nomos header logo">
+  <strong>Bring harmony to your pull requests.</strong>
+</p>
+<p align="center">
+  <img src="https://img.shields.io/badge/ruby-%3E%3D%203.2-ruby.svg" alt="Ruby Version">
+  <img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="License">
+  <a href="https://github.com/ydah/nomos/actions/workflows/main.yml">
+    <img src="https://github.com/ydah/nomos/actions/workflows/main.yml/badge.svg" alt="CI Status">
+  </a>
+</p>
+
+<p align="center">
+  <a href="#features">Features</a> ·
+  <a href="#installation">Installation</a> ·
+  <a href="#quick-start">Quick Start</a> ·
+  <a href="#configuration">Configuration</a> ·
+  <a href="#rules">Rules</a> ·
+  <a href="#reporters">Reporters</a> ·
+  <a href="#how-it-works">How It Works</a>
+</p>
+
+---
+
+Nomos evaluates PR metadata and diffs, then reports findings as `message`, `warn`, or `fail`.
+It is designed for fast startup, minimal API calls, and clear configuration.
+
+## Features
+
+<a name="features"></a>
+
+- Diff-driven by default with optional lazy diff fetching
+- Built-in cache to avoid redundant GitHub API calls
+- Parallel rule execution
+- Built-in rules plus Ruby DSL for custom checks
+- Multiple reporters: GitHub comment, console, JSON
+- Strict mode for CI gating
+
+## Installation
+
+<a name="installation"></a>
+
+Add to your Gemfile:
+
+```ruby
+gem "nomos"
+```
+
+Then install:
+
+```bash
+bundle install
+```
+
+## Quick Start
+
+<a name="quick-start"></a>
+
+Run in CI or locally:
+
+```bash
+nomos run
+```
+
+### Required ENV
+
+- `GITHUB_TOKEN` (GitHub API token)
+- `GITHUB_REPOSITORY` (e.g. `owner/repo`)
+- `GITHUB_EVENT_PATH` (path to GitHub event JSON)
+
+Local override:
+
+- `NOMOS_REPOSITORY` and `NOMOS_PR_NUMBER` if `GITHUB_EVENT_PATH` is not available
+
+### GitHub Actions
+
+```yaml
+- name: Nomos
+  run: nomos run
+  env:
+    GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+```
+
+## Configuration
+
+<a name="configuration"></a>
+
+Create `nomos.yml`:
+
+```yml
+version: 1
+
+reporter:
+  github: true
+  console: true
+
+performance:
+  concurrency: 4
+  cache: true
+  lazy_diff: true
+  timing: false
+
+rules:
+  - name: no_large_pr
+    type: builtin.no_large_pr
+    params:
+      max_changed_lines: 800
+
+  - name: require_changelog
+    type: builtin.require_file_change
+    params:
+      patterns:
+        - CHANGELOG.md
+
+  - name: custom_rules
+    type: ruby.file
+    params:
+      path: .nomos/rules.rb
+```
+
+Performance notes:
+
+- Cache file defaults to `.nomos/cache.json` (override with `performance.cache_path`)
+- Use `--no-cache` to disable cache and lazy diff for a single run
+
+### CLI
+
+```
+nomos run [--config PATH] [--strict] [--debug] [--no-cache] [--reporter github,console,json]
+nomos init
+nomos doctor
+```
+
+## Rules
+
+<a name="rules"></a>
+
+### Built-in rules
+
+- `builtin.no_large_pr`
+- `builtin.require_file_change`
+- `builtin.forbid_paths`
+- `builtin.require_labels`
+- `builtin.todo_guard`
+
+### Ruby DSL (`.nomos/rules.rb`)
+
+```rb
+rule "no_debugger" do
+  changed_files.grep(/\.rb$/).each do |file|
+    if diff(file).include?("binding.pry")
+      fail "binding.pry detected", file: file
+    end
+  end
+end
+```
+
+Available DSL API:
+
+#### changed_files
+
+Array of changed file paths.
+
+```rb
+rule "example_changed_files" do
+  changed_files.grep(/\.md$/).each do |file|
+    message "Docs updated", file: file
+  end
+end
+```
+
+#### diff(file)
+
+Unified diff for a file (string; empty if unavailable).
+
+```rb
+rule "example_diff" do
+  if diff("lib/app.rb").include?("binding.pry")
+    fail "Debug hook found", file: "lib/app.rb"
+  end
+end
+```
+
+#### pr_title
+
+PR title string.
+
+```rb
+rule "example_pr_title" do
+  warn "Title should start with [chore]", file: "PR" unless pr_title.start_with?("[chore]")
+end
+```
+
+#### pr_body
+
+PR body string.
+
+```rb
+rule "example_pr_body" do
+  fail "PR body must include a checklist", file: "PR" unless pr_body.to_s.include?("- [ ]")
+end
+```
+
+#### pr_number
+
+PR number.
+
+```rb
+rule "example_pr_number" do
+  message "Reviewing PR ##{pr_number}"
+end
+```
+
+#### pr_author
+
+PR author login.
+
+```rb
+rule "example_pr_author" do
+  warn "First-time contributor", file: "PR" if pr_author == "new-contributor"
+end
+```
+
+#### pr_labels
+
+Array of label names.
+
+```rb
+rule "example_pr_labels" do
+  fail "Missing security label", file: "PR" unless pr_labels.include?("security")
+end
+```
+
+#### repo
+
+Repository identifier (`owner/repo`).
+
+```rb
+rule "example_repo" do
+  message "Running in #{repo}"
+end
+```
+
+#### base_branch
+
+Base branch name.
+
+```rb
+rule "example_base_branch" do
+  warn "Target branch should be main", file: "PR" unless base_branch == "main"
+end
+```
+
+#### ci
+
+CI context hash.
+
+```rb
+rule "example_ci" do
+  fail "Missing CI provider info", file: "CI" unless ci["provider"]
+end
+```
+
+#### message(text, **opts)
+
+Add informational finding.
+
+```rb
+rule "example_message" do
+  message "Heads up", file: "README.md", line: 1, code: "docs"
+end
+```
+
+#### warn(text, **opts)
+
+Add warning finding.
+
+```rb
+rule "example_warn" do
+  warn "Large change set", file: "PR", code: "size"
+end
+```
+
+#### fail(text, **opts)
+
+Add failure finding.
+
+```rb
+rule "example_fail" do
+  fail "Missing CHANGELOG entry", file: "CHANGELOG.md", code: "changelog"
+end
+```
+
+### Adding custom rules
+
+1. Create `.nomos/rules.rb` and define one or more `rule "name"` blocks.
+2. Register the file in `nomos.yml` under `rules` with `type: ruby.file` and `params.path: .nomos/rules.rb`.
+3. Run `nomos run` (or your CI job) to verify the rule executes.
+
+Example:
+
+```rb
+# .nomos/rules.rb
+rule "require_docs_change" do
+  unless changed_files.any? { |file| file.start_with?("docs/") }
+    fail "Docs must be updated for this change", file: "docs/"
+  end
+end
+```
+
+```yml
+# nomos.yml
+rules:
+  - name: require_docs_change
+    type: ruby.file
+    params:
+      path: .nomos/rules.rb
+```
+
+## Reporters
+
+<a name="reporters"></a>
+
+- GitHub comment reporter
+- Console reporter
+- JSON reporter (for post-processing)
+
+## How It Works
+
+<a name="how-it-works"></a>
+
+1. Load PR context from GitHub API or event payload
+2. Fetch changed files and patches (lazy diff optional)
+3. Run rules in parallel where safe
+4. Report findings to configured outputs
+5. Exit with CI-friendly status
+
+## Development
+
+```bash
+bundle exec rspec
+```
+
+## License
+
+MIT License. See `LICENSE` file for details.

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec