stellwerk 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f5bc717030b6f075aebb0615a37ee45cf32aafe5cc7d5e9e7d5bbf50350f6cfa
-  data.tar.gz: 6d03317e06b5d44b174b734424a72543943f5f62a39ff4d3cba9a6b1a64a9b0d
+  metadata.gz: f7ad132ec4853899869bcbcee2b1986cc727a68ee2c7c9195ac671dd867f446f
+  data.tar.gz: b277558ce497fe36c8e7d376b0a43e60a7e4ad370bed2969d6fc39c28d9e83bb
 SHA512:
-  metadata.gz: a87d9aa67acfa4a3c5df1119d6c8aaa1e1f4ea98c8a923445cd970c1b783e3a25db0bae5f5b12950d61fc975ed75c6a1423ecf62ff5b31c3a81d16e9ce76428e
-  data.tar.gz: 11a17aa329b2194b587e66d5e316e978c026dd2114795ce7dda1c95434e9bb037b981972625db420679de2df5eff66f6ccc26186891fb0b48d9facecdf7857b9
+  metadata.gz: 779e20d8e08352b85bce1abea1bed9e498889d88e2ed7776eded60e5708d7a53693bd13d0da52f31241e49813b6864802b4d4f2b2646c525851917568f8ea9f1
+  data.tar.gz: e6091b2d39561c3a10f8a13f883139450d8bc457a8b33e1349206183705067f86f595e4a6f5b500084e01e2bb02207f38f435e314c7602988a80a1a4d497360d

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## [Unreleased]
 
+## [0.0.3] - 2026-02-15
+
+- exit with non-zero exit code if any violations are found
+
 ## [0.0.2] - 2026-02-15
 
 - MVP: Basic architecture enforcement with layered architecture support

data/README.md

@@ -22,6 +22,8 @@ gem install stellwerk
 
 ## Usage
 
+Create a `stellwerk.yml` in the root of your Rails application that defines at least one [rule](#rules).
+
 Run the check task in your Rails app:
 
 ```bash
@@ -34,6 +36,24 @@ Run a simpler check without booting `:environment` (uses statically defined Zeit
 bin/rails stellwerk:check_simple
 ```
 
+### Rules
+
+Rules are defined in the `stellwerk.yml` file.
+
+#### Layered Architecture
+
+The Layered Architecture rule enforces that files in one layer do not reference files in a layer that is "above" it.
+
+Example configuration with three layers:
+
+```yaml
+rules:
+  layers:
+    - app/controllers
+    - [ app/jobs, app/models ]
+    - lib
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/stellwerk/commands/check.rb

@@ -42,6 +42,8 @@ module Stellwerk
         end
 
         Stellwerk::Printer.new(violations).print
+
+        violations
       end
 
       private

data/lib/stellwerk/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Stellwerk
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/lib/tasks/stellwerk.rake

@@ -4,10 +4,14 @@ namespace :stellwerk do
   task check: :environment do
     autoloaders = [Rails.autoloaders.main, Rails.autoloaders.once].compact
 
-    Stellwerk::Commands::Check.new(Rails.root, autoloaders: autoloaders).run
+    violations = Stellwerk::Commands::Check.new(Rails.root, autoloaders: autoloaders).run
+
+    exit 1 if violations.any?
   end
 
   task :check_simple do
-    Stellwerk::Commands::Check.new(Dir.pwd).run
+    violations = Stellwerk::Commands::Check.new(Dir.pwd).run
+
+    exit 1 if violations.any?
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stellwerk
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Philip Theus