rubocounsel 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3839fdb133937bd743490942d358cadb5ec5b03380b20755150f1e06ffdc8cf3
+  data.tar.gz: 618b43fadb08f8896de3f9b70e4638eaac8169c981614f3dc474007db314e44c
+SHA512:
+  metadata.gz: 563a253cd41f2ab816aed6a7241ebb68ab3c4ac12df4fa12c804e6f5b415f228d54004710289201a065cd09c7b6fc74dd313af8de45162b5d9a08a7fc605912f
+  data.tar.gz: 8c9be74c4d2c0bf342e05e4dfb9cc8aad6c26ab7899e31aef24c7600d5901dcca0dcd7d4b8f5c9a5e5f7e762593bb3e35ce27319dfd232ed25fe48e223073cb8

data/.claude/CLAUDE.md

@@ -0,0 +1,11 @@
+# RuboCounsel Project Guidelines
+
+## Code Style
+
+- Never use blank `puts` for empty lines. Use a heredoc or include `\n` in the previous string instead.
+
+## Testing
+
+- Consolidate simple accessor/property tests into a single test when they're straightforward
+- Avoid creating multiple tests for trivial variations of the same behavior (e.g., testing `#type` for each possible value type)
+- Group related assertions in one test to reduce noise while still maintaining clear test intent

data/.claude/settings.json

@@ -0,0 +1,22 @@
+{
+  "permissions": {
+    "ask": [
+      "Bash(gh api -X:*)"
+    ],
+    "allow": [
+      "Bash(bin/test:*)",
+      "Bash(bin/style:*)",
+      "Bash(bin/console:*)",
+      "Bash(bundle install:*)",
+      "Bash(gh api :*)",
+      "Bash(gh pr create:*)",
+      "Bash(gh pr list:*)",
+      "Bash(gh pr view:*)",
+      "Bash(gh pr close:*)",
+      "Bash(git add:*)",
+      "Bash(git commit:*)",
+      "Bash(git checkout -b:*)",
+      "Bash(git push -u:*)"
+    ]
+  }
+}

data/.rubocounsel.yml

@@ -0,0 +1,3 @@
+---
+Style/StringLiterals:
+  EnforcedStyle: double_quotes

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-10-26
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/FEEDBACK.md

@@ -0,0 +1,67 @@
+# User Feedback
+
+## From initial testing (2026-02-03)
+
+### 1. Show default value in choice options
+When presenting choice options (e.g., `EnforcedStyle`), mark which one is the default so users know the recommended value.
+
+Example: Instead of showing:
+```
+> single_quotes
+  double_quotes
+```
+
+Show:
+```
+> single_quotes (default)
+  double_quotes
+```
+
+### 2. "Show examples" option for attributes
+Add a "Show examples" option when prompting for attribute values. When selected, display the examples and then return to the choice prompt.
+
+Current flow:
+1. Show examples automatically
+2. Prompt for choice
+
+Requested flow:
+1. Prompt for choice with "Show examples" as an option
+2. If "Show examples" selected, display examples and return to step 1
+3. Otherwise, use the selected value
+
+This gives users control over when to see examples rather than always showing them upfront.
+
+**Context:** Tested on `Bundler/OrderedGems` with `ConsiderPunctuation` attribute.
+
+### 3. Skip non-style attributes like Include/Exclude
+Attributes like `Include` and `Exclude` are file glob patterns, not style decisions. Prompting for them:
+- Slows down the process
+- Isn't the core value prop (helping decide on code style)
+- Users would typically configure these separately if needed
+
+**Suggestion:** Filter out certain attributes from interactive prompts. Candidates:
+- `Include`
+- `Exclude`
+- Possibly others that are "configuration" rather than "style"
+
+**Open question:** Should there be a way to access these if users want them? Maybe an "advanced" mode or separate command?
+
+### 4. Progress is lost if you quit early
+Config is only written at the very end. If you quit partway through (or hit a bug), all your choices are lost.
+
+**Options:**
+- Write after each cop decision (incremental) ✓ DONE
+- Save progress to a temp file and resume
+- At minimum, warn users that quitting will lose progress
+
+### 5. Some examples aren't visually distinct
+Example: `TreatCommentsAsGroupSeparators` shows nearly identical code for `true` and `false` - the only difference is the `# good` vs `# bad` comment label. This is how RuboCop writes their documentation, so not much we can control, but it can be confusing.
+
+**Possible mitigation:** Add explanatory text above examples describing what the setting does, not just showing code.
+
+### 6. Some attributes have no examples at all
+Example: `ConsiderPunctuation` for `Bundler/OrderedGems` has no "Show examples" option because RuboCop's source doesn't include `@example` tags for it.
+
+**Possible mitigations:**
+- Show a message like "No examples available" instead of hiding the option
+- Link to RuboCop documentation URL for the cop

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 John DeWyze
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/PLAN.md

@@ -0,0 +1,346 @@
+# RuboCounsel Implementation Plan
+
+## Vision
+
+RuboCounsel is an interactive CLI tool that transforms the RuboCop experience from "fix these errors" to "let's decide on your team's style together." Instead of dumping a wall of offenses, it walks developers through each failing cop, explains what it does, shows real code examples, and helps them make informed decisions that get written to `.rubocop.yml`.
+
+The end result: a rubocop configuration that reflects conscious choices, not cargo-culted defaults.
+
+---
+
+## The Problem with the Current Approach
+
+The `first_attempt` branch uses YARD to discover cops by parsing all RuboCop source files, then filtering for classes that inherit from `RuboCop::Cop::Base`. This works, but it's solving a problem that RuboCop already solved.
+
+### Issues
+
+1. **Reinventing the Registry**: RuboCop maintains `RuboCop::Cop::Registry.global` specifically for programmatic access to all cops. Using YARD to discover cops is like scraping a website when there's a perfectly good API.
+
+2. **Fragile Gem Path Resolution**: The current code does `Gem::Specification.find_by_name("rubocop").gem_dir` and then globs for Ruby files. This is indirect—we're finding the gem just to parse its source, when we could just ask RuboCop directly what cops exist.
+
+3. **Mixing Concerns**: The `Store` class does cop discovery AND example loading in the same pass through YARD. These are separate concerns—cop discovery is structural (what cops exist?), while example loading is documentary (what do the docs say about them?).
+
+4. **Duplicate Code**: `rubocop_config` is defined twice in `store.rb` (lines 39-40 and 68-69). Small symptom of rushed exploration.
+
+5. **Incomplete Interactive Flow**: The `Runner` has empty option handlers and a leftover `debugger` call. The flow from "cop fired" to "config generated" isn't complete.
+
+### What's Actually Good
+
+- **The YARD example parsing works**: The `Example` class correctly parses `@example EnforcedStyle: single_quotes (default)` into structured data (attribute, value, default flag).
+
+- **The Runner hook is clever**: Subclassing `RuboCop::Runner` and overriding `file_finished` to collect offending cops is a clean integration point.
+
+- **The attribute detection logic is sound**: Recognizing that `EnforcedStyle` maps to `SupportedStyles` is correct.
+
+---
+
+## The Hybrid Approach
+
+Use RuboCop's Registry for cop discovery (it's authoritative and stable), but keep YARD for extracting documentation examples (there's no other way to get them).
+
+### Why This Split Makes Sense
+
+**Cop Discovery via Registry**
+
+The Registry is RuboCop's official answer to "what cops exist?" It's:
+- Stable across versions (public API)
+- Complete (includes all registered cops)
+- Provides cop classes directly (no string-to-class conversion needed)
+- Includes metadata like `cop_name`, `department`, `support_autocorrect?`
+
+Using it is one line: `RuboCop::Cop::Registry.global.each { |cop| ... }`
+
+**Examples via YARD**
+
+There's no runtime API in RuboCop to get example code. The examples live in YARD `@example` tags in the source comments. YARD is the only way to extract them, so we keep it—but scoped to just example loading, not cop discovery.
+
+This separation means:
+- If YARD parsing fails for some cop, we still have the cop (just without examples)
+- We can cache/lazy-load examples separately from cops
+- The code is easier to test in isolation
+
+---
+
+## Architecture
+
+### Data Flow
+
+```
+┌─────────────────────────────────────────────────────────────────┐
+│                         RuboCop Gem                             │
+├─────────────────────────────────────────────────────────────────┤
+│  Registry.global          default.yml           YARD @example   │
+│  (cop classes)            (config values)       (documentation) │
+└────────┬─────────────────────────┬─────────────────────┬────────┘
+         │                         │                     │
+         ▼                         ▼                     ▼
+┌─────────────────┐    ┌─────────────────────┐   ┌──────────────┐
+│   Cop Classes   │    │   Configuration     │   │   Examples   │
+│   (from Reg.)   │    │   (from Config)     │   │  (from YARD) │
+└────────┬────────┘    └──────────┬──────────┘   └──────┬───────┘
+         │                        │                     │
+         └────────────┬───────────┴─────────────────────┘
+                      ▼
+              ┌───────────────┐
+              │  CopCatalog   │
+              │  (unified)    │
+              └───────┬───────┘
+                      │
+         ┌────────────┴────────────┐
+         ▼                         ▼
+┌─────────────────┐       ┌─────────────────────┐
+│     Runner      │       │   Counselor (CLI)   │
+│  (runs rubocop, │──────▶│   (interactive      │
+│   tracks cops)  │       │    walkthrough)     │
+└─────────────────┘       └──────────┬──────────┘
+                                     │
+                                     ▼
+                          ┌─────────────────────┐
+                          │  ConfigWriter       │
+                          │  (generates YAML)   │
+                          └─────────────────────┘
+```
+
+### Component Responsibilities
+
+**CopCatalog** (replaces `Store`)
+
+The central repository of cop information. Responsibilities:
+- Load all cops from Registry
+- Load examples from YARD (via ExampleLoader)
+- Associate examples with cops
+- Provide lookup by cop name
+
+Why "Catalog" instead of "Store"? A store implies persistence/mutation. This is more like a catalog—a comprehensive listing you can browse and query.
+
+**ExampleLoader**
+
+Focused concern: extract `@example` tags from YARD and parse them into structured data.
+
+Why separate from CopCatalog?
+- Single responsibility: YARD parsing is finicky and worth isolating
+- Testability: can test example parsing without loading the full catalog
+- Fallback: if YARD fails, cops still load (just without examples)
+
+**CopEntry** (replaces `CopStore`)
+
+Represents a single cop with its configuration and examples. Contains:
+- The cop class (from Registry)
+- Its configuration (from ConfigLoader)
+- Its examples (from ExampleLoader)
+- Computed configurable attributes
+
+Why "Entry" instead of "CopStore"? Each cop isn't a store—it's an entry in the catalog. The name should reflect its role as a data object, not a container.
+
+**ConfigurableAttribute** (keep, mostly unchanged)
+
+Represents one configurable aspect of a cop (e.g., `EnforcedStyle`). Computes:
+- Default value
+- Available options (for choice-type attributes)
+- Value type (boolean, integer, string, array, choice)
+
+**Example** (simplify to hash or keep as lightweight class)
+
+Parsed `@example` tag data:
+- Attribute name (e.g., "EnforcedStyle")
+- Value (e.g., "single_quotes")
+- Whether it's the default
+- The code text
+
+The current `Example` class is fine. Could be a plain hash, but the class provides clarity.
+
+**Runner** (keep, complete the implementation)
+
+Subclass of `RuboCop::Runner` that:
+- Runs RuboCop normally
+- Hooks `file_finished` to track which cops fired
+- Provides the list of offending cops to the Counselor
+
+**Counselor** (new, replaces the inline CLI code in Runner)
+
+The interactive CLI experience. Responsibilities:
+- Walk through each offending cop
+- Display cop information and examples
+- Collect user choices via cli-ui prompts
+- Pass choices to ConfigWriter
+
+Why separate from Runner? The Runner is about RuboCop integration. The Counselor is about user interaction. Different concerns, different classes.
+
+**ConfigWriter** (new)
+
+Generates `.rubocop.yml` content from user choices. Responsibilities:
+- Convert choices to YAML structure
+- Handle merging with existing config (future)
+- Write to file or output to stdout
+
+Why separate? Config generation is its own concern. Keeping it separate makes it testable and allows different output strategies (write file, print to stdout, return string).
+
+---
+
+## Key Decisions
+
+### Decision: Use Registry, Keep YARD
+
+**Alternative considered**: Parse everything from YARD (current approach)
+
+**Why Registry wins**: It's the authoritative source. RuboCop uses it internally. It's a stable API. Using YARD for cop discovery is indirect—we're parsing documentation to learn structure, when structure is already exposed programmatically.
+
+**Why keep YARD for examples**: There's no alternative. Examples are documentation, not structure. They exist only in source comments. YARD is the right tool for extracting documentation.
+
+### Decision: Subclass RuboCop::Runner
+
+**Alternative considered**: Run `rubocop` as subprocess, parse output
+
+**Why subclassing wins**:
+- Direct access to offense objects (not parsed strings)
+- Can hook multiple points in the execution lifecycle
+- Stays in-process (faster, no serialization)
+- Can reuse RuboCop's configuration loading
+
+**Risk**: Coupling to RuboCop internals. The `file_finished` callback is documented behavior, but internals can change.
+
+**Mitigation**: Stick to documented hooks. If RuboCop changes significantly, we adapt—but this is true of any integration.
+
+### Decision: Separate Counselor from Runner
+
+**Alternative considered**: Keep CLI code in Runner (current approach)
+
+**Why separation wins**:
+- Runner is about "run RuboCop, track offenses"
+- Counselor is about "guide user through choices"
+- Mixing them makes both harder to test
+- Different change frequencies: CLI UX will evolve faster than RuboCop integration
+
+### Decision: Generate Config Per-Cop (Incremental Saves)
+
+**Alternative considered**: Batch all choices and write at the end
+
+**Why per-cop wins**:
+- User doesn't lose progress if they quit mid-session
+- Immediate feedback: config file reflects each choice as it's made
+- No need for a separate "save progress" feature
+
+### Decision: Focus on Offending Cops Only
+
+**Alternative considered**: Walk through ALL cops (full configuration wizard)
+
+**Why offending-only wins**:
+- Immediate value: address what's actually failing
+- Manageable scope: 5-10 cops vs 500+
+- Progressive disclosure: deal with issues as they arise
+- User already knows they have these offenses (ran RuboCop)
+
+**Future extension**: Could add a "full audit" mode that walks through all cops, but that's a different workflow.
+
+---
+
+## What Changes
+
+| Current File | Action | Notes |
+|--------------|--------|-------|
+| `store.rb` | Rewrite | Becomes CopCatalog, uses Registry |
+| `cop_store.rb` | Rewrite | Becomes CopEntry, simpler |
+| `configurable_attribute.rb` | Modify | Add `example_for(value)` method |
+| `configurable_option.rb` | Keep or Remove | May not be needed if attributes handle options |
+| `example.rb` | Keep | Works correctly |
+| `runner.rb` | Clean up | Remove debugger, fix empty handlers |
+| `util.rb` | Evaluate | May not be needed |
+| `rubocounsel.rb` | Update | Wire up new components |
+| (new) `example_loader.rb` | Create | Focused YARD parsing |
+| (new) `counselor.rb` | Create | Interactive CLI flow |
+| (new) `config_writer.rb` | Create | YAML generation |
+
+---
+
+## Testing Strategy
+
+### Unit Tests
+
+- **ExampleLoader**: Given YARD source, extracts examples correctly
+- **CopEntry**: Given cop class + config + examples, computes attributes correctly
+- **ConfigurableAttribute**: Given config hash, determines type and options correctly
+- **ConfigWriter**: Given choices hash, generates correct YAML
+
+### Integration Tests
+
+- **CopCatalog**: Loads real cops from RuboCop, count is reasonable (500+)
+- **Runner**: Running on a file with known offenses captures those cop names
+
+### Manual Testing
+
+- **Full flow**: Run on a real project, walk through prompts, verify generated config
+
+---
+
+## Resolved Questions
+
+1. **Merging with existing .rubocop.yml**: Deep merge. Implemented — doesn't clobber existing cop keys.
+
+2. **Cops without configurable attributes**: Enable/Disable/Skip is sufficient. Working as implemented.
+
+3. **Cops with many attributes**: Walk through each. Works fine in practice.
+
+4. **Saving progress**: Moot — we save after each cop decision (incremental writes).
+
+5. **Non-interactive mode**: Dropped. Accepting all defaults is equivalent to not configuring, since RuboCop already uses its defaults. `rubocop --auto-gen-config` covers the "just suppress everything" use case.
+
+---
+
+## Implementation Order (Phase 1 — Complete)
+
+All 7 steps implemented. 66 tests passing. Installable as a gem via `rake install`.
+
+1. ~~ExampleLoader~~
+2. ~~CopCatalog~~
+3. ~~CopEntry~~
+4. ~~ConfigWriter~~
+5. ~~Counselor~~
+6. ~~Runner cleanup~~
+7. ~~CLI entry point~~
+
+---
+
+## Backlog
+
+### ~~1. "No examples available" message~~
+
+~~When an attribute has no YARD `@example` tags, the "Show examples" option is silently hidden. Instead, show a message like "No examples available for this attribute" so the user knows it's not a bug.~~
+
+Done in PR #9. Message displayed before the prompt for choice/boolean attributes when no examples exist.
+
+### ~~2. Sort cops alphabetically~~
+
+~~Currently cops are walked through in file-discovery order. Default to alphabetical (or by department).~~
+
+Done in PR #10. Cops are now sorted alphabetically by default (within their department grouping).
+
+### ~~3. Array attribute awareness~~
+
+~~Currently all array-type attributes (Include, Exclude, AllowedMethods, AllowedPatterns, etc.) are silently skipped. Improve this:~~
+
+~~- **Include/Exclude**: Continue to skip silently (file-targeting config, not style choices)~~
+~~- **Other array attributes** (AllowedMethods, AllowedPatterns, CountAsOne, etc.): Show an informational message listing them and suggesting the user configure these directly in `.rubocop.yml`~~
+
+~~These attributes are "list the specific things in your codebase to exempt" — not a good fit for interactive prompts.~~
+
+Done in PR #11. Non-file-targeting array attributes now display a green informational message suggesting users configure them directly in .rubocop.yml.
+
+### ~~4. Verify extension gem support~~
+
+~~Quick investigation: if rubocop-rails, rubocop-rspec, etc. are in the project's bundle, their cops should appear in `Registry.global`. Verify that rubocounsel already handles these correctly (Runner catches offenses, CopCatalog finds them, ExampleLoader finds their YARD docs). May already work with no changes.~~
+
+Done in PR #12. Investigation found that cop discovery (Registry), offense collection (Runner), and configuration data (CopEntry) all worked out of the box. ExampleLoader needed a fix — it was hardcoded to only parse the core rubocop gem's source files. Updated to discover all loaded `rubocop-*` gems so extension cops get YARD examples and docstrings too.
+
+### ~~5. Clean up README.md~~
+
+~~Replace template TODO placeholders with real content: gem description, installation instructions, usage examples.~~
+
+Done. Replaced bundler template boilerplate with real gem description, installation instructions, usage walkthrough, and extension gem note.
+
+---
+
+## Non-Goals
+
+- Full configuration wizard for all cops (500+ cops is not a useful walkthrough)
+- Custom cop support (uses Registry, so custom cops would need to register themselves)
+- GUI or web interface