keela 0.2.0 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 920e953982643da9bb58171ea626a130d27a3cc41f6ccfb3511eabefbb0b41c8
-  data.tar.gz: 8c7e5d91900e962efca4d08f242e9582ad9192c1d07401e45ce545df5af68d2a
+  metadata.gz: bb2b0270567d3a141ba56fe243a94c64a7adc2fde674d4e851f195158aadeda6
+  data.tar.gz: ee7ded87e34b526e74cde698c7fe69dd543ea89cc342a87d36b7466832ce8d82
 SHA512:
-  metadata.gz: 01efcb8620dd29060d5758ef41def0dd450f62d59d46cb6de8873a18b1a69014895bd64bd68aa263731cb6edbc8640dc6b24f3a9281a865ff650b9717693dd1f
-  data.tar.gz: d9e8650985b2ca2a618201ecc2ecc8ced5e275564c37e84658207b498ba70b2279d281486d2bd1127cf9696bc278cff5121a411b42ef27287bf94f5b5d157da6
+  metadata.gz: 717ddbcd2b0b44085189f081d4c332e9535200b20b7fec7e0592373371db3efa765076a27d962e30165fcc4c73603692f00232948396a4c75c83de5656f146e8
+  data.tar.gz: f47ba3b39c51b56aca08346d542f1bf9f0ec3697fef64196a467d784148a2d8f12bb3c4be189cc70e0966bee4967cc52da9a6beb69841e20ab459b1bd3e707b5

data/CHANGELOG.md

@@ -7,22 +7,42 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.2.2] - 2026-07-27
+
+### Changed
+
+- Config file lookup now includes `.keela/config.yml` as the first option ([#30](https://github.com/kerrizor/keela/pull/30))
+  - Lookup order: `.keela/config.yml` → `keela.yml` → `.keela.yml`
+
+## [0.2.1] - 2026-07-27
+
+### Added
+
+- **Quiet mode** via `--quiet` / `-q` CLI flag to suppress progress bar output ([#26](https://github.com/kerrizor/keela/issues/26))
+
+### Changed
+
+- Default suggested excluded filename changed from `excluded.yml` to `keela_excluded.yml` for consistency with `keela_baseline.yml` ([#28](https://github.com/kerrizor/keela/pull/28))
+- Default file locations now support `.keela/` directory with fallback to root ([#29](https://github.com/kerrizor/keela/pull/29))
+  - Excluded: `.keela/excluded.yml` → `keela_excluded.yml`
+  - Baseline: `.keela/baseline.yml` → `keela_baseline.yml`
+
 ## [0.2.0] - 2026-07-17
 
 ### Added
 
 - `Baseline` class for managing multi-strategy baseline files ([#1](https://github.com/kerrizor/keela/pull/1))
 - Single baseline file now supports multiple strategy sections (methods, scopes)
-- **Constants strategy** for detecting unused constant definitions (`SCREAMING_SNAKE_CASE = value`)
-- **Delegations strategy** for detecting unused `delegate :method, to: :target` declarations
-- **Attributes strategy** for detecting unused `attr_accessor`, `attr_reader`, `attr_writer` declarations
-- **Config file support** (`keela.yml` or `.keela.yml`) for project-specific settings
-- **Exclude patterns** via `--exclude` CLI flag or `exclude_patterns` in config file
-- **Include patterns** via `--include` CLI flag or `include_patterns` in config file (adds to default directory patterns)
-- **Configuration validation** - raises `ConfigurationError` if `directory_patterns` is customized while also using `include_patterns` or `exclude_patterns`
-- **I18n keys strategy (beta)** for detecting unused translation keys in locale files (`--type i18n_keys`)
-- **Multiple types** can now be specified with `--type methods,scopes,constants`
-- **JSON output** via `--format json` for machine-readable results (useful for CI integrations)
+- **Constants strategy** for detecting unused constant definitions ([#2](https://github.com/kerrizor/keela/pull/2))
+- **Delegations strategy** for detecting unused `delegate :method, to: :target` declarations ([#4](https://github.com/kerrizor/keela/pull/4))
+- **Attributes strategy** for detecting unused `attr_accessor`, `attr_reader`, `attr_writer` declarations ([#5](https://github.com/kerrizor/keela/pull/5))
+- **Config file support** (`keela.yml` or `.keela.yml`) for project-specific settings ([#11](https://github.com/kerrizor/keela/pull/11))
+- **Exclude patterns** via `--exclude` CLI flag or `exclude_patterns` in config file ([#12](https://github.com/kerrizor/keela/pull/12))
+- **Include patterns** via `--include` CLI flag or `include_patterns` in config file ([#14](https://github.com/kerrizor/keela/pull/14))
+- **Configuration validation** - raises `ConfigurationError` if `directory_patterns` is customized while also using `include_patterns` or `exclude_patterns` ([#15](https://github.com/kerrizor/keela/pull/15))
+- **I18n keys strategy (beta)** for detecting unused translation keys in locale files ([#16](https://github.com/kerrizor/keela/pull/16))
+- **Multiple types** can now be specified with `--type methods,scopes,constants` ([#18](https://github.com/kerrizor/keela/pull/18))
+- **JSON output** via `--format json` for machine-readable results ([#19](https://github.com/kerrizor/keela/pull/19))
 
 ### Fixed
 

data/README.md

@@ -1,6 +1,14 @@
 # Keela 🐕
 
-Like the famous CSI dog who found what others missed, Keela sniffs out unused code in your Ruby codebase.
+**Your Ruby codebase's forensic investigator.**
+
+Like her namesake — the famous springer spaniel who helped solve cases by finding microscopic traces that eluded forensic teams — Keela sniffs out the dead code that `grep` missed.
+
+```
+🔍 6 strategies: methods, scopes, constants, delegates, attrs, i18n
+🎯 Baseline mode — only bark at NEW dead code  
+📊 JSON output for CI pipelines
+```
 
 ## Why Remove Unused Code?
 
@@ -106,6 +114,10 @@ keela --config path/to/keela.yml
 # Output as JSON (for CI integrations)
 keela --format json
 
+# Suppress progress bar (useful for CI and scripting)
+keela --quiet
+keela -q
+
 # Show version
 keela --version
 ```
@@ -339,7 +351,11 @@ scanner.run(force_report: true)
 
 ## About the Name
 
-Keela was a famous English Springer Spaniel known as the "CSI dog." She could detect microscopic traces of blood that other forensic methods missed, and worked on many high-profile cases. Like her namesake, this gem finds the unused code that other tools miss.
+Keela was a famous English Springer Spaniel known as the "CSI dog." She could detect microscopic traces of blood that other forensic methods missed, helping solve cases that had gone cold for decades. Her nose was so sensitive she found evidence that luminol and DNA testing couldn't.
+
+Like her namesake, this gem finds the dead code that `grep` and your IDE missed.
+
+*Good girl, Keela.* 🦴
 
 ## License
 

data/exe/keela

@@ -9,7 +9,8 @@ options = {
   force_report: false,
   update_baseline: false,
   config_path: nil,
-  format: :text
+  format: :text,
+  quiet: false
 }
 
 OptionParser.new do |opts|
@@ -72,6 +73,10 @@ OptionParser.new do |opts|
     exit
   end
 
+  opts.on("--quiet", "-q", "Suppress progress bar output (useful for CI and scripting)") do
+    options[:quiet] = true
+  end
+
   opts.on("-h", "--help", "Show this help") do
     puts opts
     exit
@@ -82,6 +87,9 @@ end.parse!
 # CLI options override config file settings
 Keela::ConfigFile.load(path: options[:config_path])
 
+# Apply quiet mode if requested
+Keela.configuration.show_progress = false if options[:quiet]
+
 # Set default baseline path if not specified
 Keela.configuration.baseline_path ||= ".keela_baseline.yml"
 

data/lib/keela/config_file.rb

@@ -3,11 +3,12 @@
 require "yaml"
 
 module Keela
-  # Loads configuration from a YAML file.
-  #
-  # Looks for config files in this order:
-  #   1. keela.yml
-  #   2. .keela.yml
+# Loads configuration from a YAML file.
+#
+# Looks for config files in this order:
+#   1. .keela/config.yml
+#   2. keela.yml
+#   3. .keela.yml
   #
   # Supported keys:
   #   - extensions: Array of file extensions to scan
@@ -30,7 +31,7 @@ module Keela
   #     - erb
   #
   module ConfigFile
-    CONFIG_FILENAMES = %w[keela.yml .keela.yml].freeze
+    CONFIG_FILENAMES = %w[.keela/config.yml keela.yml .keela.yml].freeze
 
     ALLOWED_KEYS = %w[
       extensions

data/lib/keela/scanner.rb

@@ -7,10 +7,13 @@ module Keela
   class Scanner
     attr_reader :strategy, :configuration, :baseline, :source_files, :unused_collection, :new_unused, :removed
 
+    DEFAULT_EXCLUDED_PATHS = [".keela/excluded.yml", "keela_excluded.yml"].freeze
+    DEFAULT_BASELINE_PATHS = [".keela/baseline.yml", "keela_baseline.yml"].freeze
+
     def initialize(strategy:, configuration: Keela.configuration, baseline: nil)
       @strategy = strategy
       @configuration = configuration
-      @baseline = baseline || Baseline.new(configuration.baseline_path)
+      @baseline = baseline || Baseline.new(resolve_baseline_path)
       @source_files = {}
       @unused_collection = Hash.new { |hash, key| hash[key] = [] }
       @new_unused = []
@@ -31,7 +34,7 @@ module Keela
       # Determine mode: report if forced, updating baseline, or no baseline exists
       report_mode = force_report || update_baseline || !baseline.exists?
 
-      find_unused(definitions, show_progress: report_mode && !silent)
+      find_unused(definitions, show_progress: report_mode && !silent && configuration.show_progress)
 
       if report_mode
         elapsed = Process.clock_gettime(Process::CLOCK_MONOTONIC) - start
@@ -49,7 +52,7 @@ module Keela
         reporter.print_diff_report(
           new_unused,
           removed,
-          excluded_path: configuration.excluded_path || "excluded.yml",
+          excluded_path: resolve_excluded_path || ".keela/excluded.yml",
           baseline_path: baseline.path
         )
       end
@@ -128,10 +131,10 @@ module Keela
     end
 
     def filter_excluded(definitions)
-      return definitions unless configuration.excluded_path
-      return definitions unless File.exist?(configuration.excluded_path)
+      path = resolve_excluded_path
+      return definitions unless path
 
-      excluded = YAML.load_file(configuration.excluded_path, symbolize_names: true) || {}
+      excluded = YAML.load_file(path, symbolize_names: true) || {}
 
       definitions.reject do |h|
         excluded_for_file = excluded[h[:file].to_sym]
@@ -139,6 +142,20 @@ module Keela
       end
     end
 
+    def resolve_excluded_path
+      return configuration.excluded_path if configuration.excluded_path && File.exist?(configuration.excluded_path)
+
+      # Check default locations in order of preference
+      DEFAULT_EXCLUDED_PATHS.find { |path| File.exist?(path) }
+    end
+
+    def resolve_baseline_path
+      return configuration.baseline_path if configuration.baseline_path && File.exist?(configuration.baseline_path)
+
+      # Check default locations in order of preference
+      DEFAULT_BASELINE_PATHS.find { |path| File.exist?(path) }
+    end
+
     def find_unused(definitions, show_progress: false)
       source_code = source_files.values.flatten.join
 

data/lib/keela/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Keela
-  VERSION = "0.2.0"
+  VERSION = "0.2.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: keela
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.2
 platform: ruby
 authors:
 - Kerri Miller