attractor 2.6.0 → 2.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 31bd7aa261b4e29b98a2a0af93e653d6dac08d0187505b57ff6df1dc60ad37c4
-  data.tar.gz: 602324b18e247c6410f9d6206b089c0ae11cfe2d6a99feb5d0a0cf3d9a77f88e
+  metadata.gz: f92fa88c85c572827d8a18feba00fcbd156c70a4642bbb9544beb90d7242af8f
+  data.tar.gz: d146f48f098cfb0e12ea135ed05279e1accf7ad44be1dbdd7009f8a1441efe60
 SHA512:
-  metadata.gz: 04a0fb63d5f198b8a5f412615e0fcc48ccb3cf6ee89edc1448ce0213cd9bc5f224bd4d435bf1c114c19789461cc6d4ccea13f55dc7cd39a6132bc0fe3d388342
-  data.tar.gz: bb2aa36a13ca5a1615853e6eb29bc13e2f5b49e46e18242fc10ef78ea4d57cd5dbbd5ed2c9bd01e5139c191a36d61ff5d7ca5f1645bcdce98783c194740425a1
+  metadata.gz: 379f288757d88603c45617ffc626c14498bcefc6e14c6442b1b95adf85afef07bb8b064833b2ceed36ebd582f6b0fafe2799fe972593f56f8755a757c330cf90
+  data.tar.gz: c89dcdb9f88391c072bec3af06f2efa2c962b70e95e04bbcc7899ba5dc61473d0461c7d23d9ebf59479c60a99d5c3d2e5dac6394cc427a352c96f4881ac56a25

data/README.md

@@ -54,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)
@@ -182,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:
@@ -193,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:
@@ -205,6 +233,33 @@ 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
+```
+
+Calculate the complexity delta between two git refs:
+
+```sh
+attractor diff
+  --base main
+  --head HEAD
+  --file_prefix|-p app/models
+  --type|-t rb|js
+  --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 -
+  --format|-f table|markdown|json
+  --config path/to/.attractor.yml
+```
+
+The `markdown` format produces a PR/MR-ready summary with Stats, Trends, and To-dos sections, followed by the full per-file table wrapped in a collapsible `<details>` block. Pipe it into a GitHub or GitLab comment:
+
+```sh
+attractor diff --base main --head HEAD --format markdown | gh pr comment 123 --body-file -
+attractor diff --base main --head HEAD --format markdown | glab mr note 45 --message "$(cat)"
 ```
 
 Generate a full report
@@ -218,6 +273,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`
@@ -230,6 +288,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: