attractor 2.5.0 → 2.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1eef3d6e8104428fdc8240ae5161654990b53d5351962bc474f11e450db9cbc2
-  data.tar.gz: 6ec7109f7c6aa6e4b5b594863e5bfeff08652f2fdf6c8c2a86a208357c084713
+  metadata.gz: 00c69c27486cc5730d2524b7c25c69a3aecc58b6ba1bf516e34390e802deea2b
+  data.tar.gz: c5056b6a4046b02d10702d33a4dd38c5b4de6c5c87f92e04e9c96c9eecf07fc5
 SHA512:
-  metadata.gz: 244a2d549ba546424c7a4c25aaa59c17b4bd1a8fed73cbdd09851c4296631c4b42d907d4b31a76a8a4f6c584143d8f086764299e00e690bce1f0f19cc69d8bcb
-  data.tar.gz: d508623821df269d803f3fdb0440fbd76f14a5d24cbd169c23cfabf01e1423171b201b1c3ee2c92a986ada20700c790c67ff75d3928bfbf9e4e1d2419e60be65
+  metadata.gz: 4cb863d6c362c6a9e98c2ca968bcd7fee4d565d1cc843c461ed0572a20d30c6e684e350138692bb632f285ce671fbe6a9ed3bffa85936426b3b80a1006f841ff
+  data.tar.gz: e8202453d0bdee8e9f009b229c834656d5aa00014c47de97c4c258735be51974b2be76195070d23a8737ab2d6b82adc68bb97bb02715091eebb2d8915c3094e9

data/README.md

@@ -10,7 +10,6 @@
 [license-url]: https://github.com/julianrubisch/attractor/blob/master/LICENSE
 [twitter-url]: https://twitter.com/AttractorGem
 [twitter-shield]: https://img.shields.io/twitter/follow/AttractorGem?style=social
-[build-status]: https://travis-ci.org/julianrubisch/attractor.svg?branch=master
 [twitter-shield]: https://img.shields.io/twitter/follow/AttractorGem?style=social
 [ruby-tests-action-shield]: https://github.com/julianrubisch/attractor/workflows/Ruby%20Tests/badge.svg
 <!-- Media -->
@@ -39,7 +38,6 @@
 ---
 
 <!-- PROJECT SHIELDS -->
-![Build Status][build-status]
 ![Ruby Tests Action Status][ruby-tests-action-shield]
 [![Forks][forks-shield]][forks-url]
 [![Stargazers][stars-shield]][stars-url]
@@ -56,6 +54,8 @@
 <!-- GIF -->
 ![attractor_v0 6 1][demo-gif]
 
+**If you are looking for a managed solution to observe your code's quality, check out [UseAttractor](https://useattr.actor)**
+
 ## Table of Contents
 
 - [Table of Contents](#table-of-contents)
@@ -184,6 +184,31 @@ attractor:
       - attractor_output
 ```
 
+## Configuration File
+
+Attractor can read defaults from an `.attractor.yml` file in the repository root. This keeps project-specific settings in version control and avoids repeating flags on every command.
+
+```yml
+report:
+  app_root: app              # maps to --file_prefix
+  minimum_churn: 3
+  ignore: "vendor,node_modules"
+  start_ago: 2y
+skip:
+  includes: ["wip"]          # CI-only for now
+branches:
+  only: [main]               # CI-only for now
+  except: [gh-pages]         # CI-only for now
+```
+
+Values under `report` are picked up by all CLI commands. Explicit CLI flags always override the config file. The `skip` and `branches` keys are reserved for CI/SaaS usage and are currently ignored by the CLI.
+
+You can also point to a custom config path:
+
+```sh
+attractor report --config path/to/attractor.yml
+```
+
 ## CLI Commands and Options
 
 Initialize the local cache:
@@ -195,6 +220,7 @@ attractor init
   --start_ago|-s  (e.g. 5y, 3m, 7w)
   --minimum_churn|-c (minimum times a file must have changed to be processed)
   --ignore|-i 'spec/*_spec.rb,db/schema.rb,tmp'
+  --config path/to/.attractor.yml
 ``` 
 
 Print a simple output to console:
@@ -207,6 +233,9 @@ attractor calc
   --start_ago|-s  (e.g. 5y, 3m, 7w)
   --minimum_churn|-c (minimum times a file must have changed to be processed)
   --ignore|-i 'spec/*_spec.rb,db/schema.rb,tmp'
+  --files 'app/models/user.rb,app/models/post.rb'  # restrict to an explicit list of paths
+  --files -                                         # read newline-separated paths from stdin
+  --config path/to/.attractor.yml
 ```
 
 Generate a full report
@@ -220,6 +249,9 @@ attractor report
   --start_ago|-s  (e.g. 5y, 3m, 7w)
   --minimum_churn|-c (minimum times a file must have changed to be processed)
   --ignore|-i 'spec/*_spec.rb,db/schema.rb,tmp'
+  --files 'app/models/user.rb,app/models/post.rb'
+  --files -
+  --config path/to/.attractor.yml
 ```
 
 Serve the output on `http://localhost:7890`
@@ -232,6 +264,7 @@ attractor serve
   --start_ago|-s  (e.g. 5y, 3m, 7w)
   --minimum_churn|-c (minimum times a file must have changed to be processed)
   --ignore|-i 'spec/*_spec.rb,db/schema.rb,tmp'
+  --config path/to/.attractor.yml
 ```
 
 Clear the local cache: