Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

Proposal for handling additional file inclusions/exclusions

Đang mở
  • Có gì không ổn?
#369 0 bình luận 1 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 2 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
5/5
Thời gian dự kiến
Hơn một tuần
Mức phù hợp với người mới
25/100
Loại issue
Tính năng
Độ rõ ràng
Cần làm rõ
Mức độ hoạt động
Ít trao đổi
Công nghệ
rails, ruby
Lĩnh vực
backend

Hướng nghiên cứu

Start by reading the existing model discovery and related-file expansion code, plus the configuration and tests for the exclusion options discussed in PRs #267 and #300. The issue proposes two alternative designs but does not choose one or identify files to change. Done means a chosen design is implemented and tested for model filtering and related-file exclusions.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

I have been thinking through this and the other issues. In the end, it would be great to move away from option flags towards an explicit structure for controlling what does and does not get annotated. Do let me know what you think. Note: I used AI to create the proposals. (Moved this from #300)

How I think the ideal pipeline could be:

The Pipeline

1. Model discovery    →  scan model_dir globs, find candidate .rb files
2. Model filter       →  whitelist OR exclusion (mutually exclusive) — PRs #267 and #300
                         ↓  surviving models
3. Related file       →  per model, expand to related files via patterns
   expansion             (additional_file_patterns, test/fixture/factory patterns, etc.)
                         ↓  combined set: models + related files
4. Related file       →  additional exclusions for step 3, for example if you want to exclude annotating tests for a specific model
   filtering
                         ↓  final set to annotate

These are two options for handling exclusion

Option A — Unified Exclusion

A single exclude_patterns option operates on the combined set (models + related files) after expansion. (This would happen at step 4)

# .annotaterb.yml

exclude_patterns:
  - "**/*.spec.rb"       # prevents spec files from being treated as models
  - "spec/billing/**/*"  # prevents billing-related specs from being annotated

How it works:

  1. Model discovery finds all candidate files
  2. Model-level whitelist or exclusion is applied (PRs #267/#300)
  3. Related files are expanded per model
  4. exclude_patterns is applied to the combined set — any file matching a pattern is dropped

Pros:

  • Single concept and single config key — easy to explain and document
  • Consistent: the same mechanism handles both model-level and related-file-level exclusion
  • Familiar — similar to .gitignore semantics

Cons:

  • Loses the distinction between "don't treat this as a model" and "don't annotate this related file" — both collapse into "don't touch this file"
  • A pattern intended to exclude related files could unintentionally also exclude model files if written broadly
  • Less explicit about which layer is being targeted

Option B — Separate Exclusion Options

Two distinct options target different layers of the pipeline explicitly.

# .annotaterb.yml

# Affects model discovery only — prevents files from being loaded as models
exclude_model_patterns:
  - "**/*.spec.rb"

# Affects related file annotation only — models are still processed, but
# matching related files are skipped
exclude_related_file_patterns:
  - "spec/billing/**/*"

How it works:

  1. Model discovery finds all candidate files
  2. exclude_model_patterns is applied — matching files are dropped before any model loading
  3. Related files are expanded per surviving model
  4. exclude_related_file_patterns is applied to the related file set only

Pros:

  • Explicit — the user knows exactly which layer they are targeting
  • exclude_model_patterns cleanly handles PR #267 (.spec.rb files in model directories)
  • exclude_related_file_patterns cleanly complements the existing exclude_* boolean flags with pattern-based control
  • No risk of a related-file pattern accidentally excluding a model file

Cons:

  • Two options to learn and document instead of one
  • User must understand the distinction between model discovery and related file annotation to use correctly
  • Slightly more config verbosity
Ngôn ngữ chính
Ruby
Star
624
Fork
95
Merge trung bình
1 ngày 21 giờ
Pull request đã merge (30 ngày)
10

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của drwl/annotaterb

Tất cả issue của drwl/annotaterb

Issue tương tự

Thêm issue về Ruby

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.