docs(mailer): readable textColor in the brand example

[PierreBrisorgueil]

Summary

• What changed: the README brand example's textColor changed from #ffffff to #1a1a1a, with a note that textColor must contrast the white card the email shell renders inside. The Rocket test fixture (mailer.brand.unit.tests.js) is updated to match, so the README example stays byte-identical to the fixture it's copied from.
• Why: the README brand example was copied byte-identical from the Rocket test fixture and set textColor: '#ffffff' on the fixed white card — invisible text if copied as-is into a real project config.
• Related issues: Refs 🎯 Config-only email customization: brand, layout, per-email templates #4127

Scope

• Module(s) impacted: lib/helpers/mailer (README + test fixture only)
• Cross-module impact: none
• Risk level: low

Validation

• npm run lint
• npm test (targeted: mailer.brand unit suite)
• Manual checks done (if applicable) — verified the README example now matches the fixture byte-for-byte

Guardrails check

• No secrets or credentials introduced (.env*, secrets/**, keys, tokens)
• No risky rename/move of core stack paths
• Changes remain merge-friendly for downstream projects
• Tests added or updated when behavior changed

Notes for reviewers

• Security considerations: none, docs + test fixture only
• Mergeability considerations: none, isolated to the mailer module
• Follow-up tasks (optional): none

Summary by CodeRabbit

• Documentation
  • Updated the brand example to use dark text and clarified that brand text color must contrast with the fixed white email background.
• Tests
  • Updated the brand override test to expect the dark text color.

[coderabbitai]

Navigate logical layers of code changes, visualize relationships, and explore their blast radius.

🧰 Additional context used

📚 Code guidelines (1)

.github/copilot-instructions.md — auto-discovered

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

• Configuration used: Repository: pierreb-devkit/Node/.coderabbit.yaml
• Review profile: ASSERTIVE
• Plan: Advanced
• Run ID: a65a56c2-1c35-4d64-b99b-35bbb85a91dc

📥 Commits

Reviewing files that changed from the base of the PR and between a547a1c and 3237ecf.

📒 Files selected for processing (2)

• lib/helpers/mailer/README.md
• lib/helpers/mailer/tests/mailer.brand.unit.tests.js

Included review availability: This review used your included allowance. Your plan provides up to 1 included review per hour; 0 remain after this review.

---

Walkthrough

The mailer README uses #1a1a1a for the textColor example and describes the fixed white .email-shell background. The brand override test expects the same text color. No implementation behavior changes.

Changes

Mailer brand text color

Layer / File(s)	Summary
Update brand textColor example and test lib/helpers/mailer/README.md, lib/helpers/mailer/tests/mailer.brand.unit.tests.js	The README example and test expectation use #1a1a1a for textColor. The README states that textColor must contrast with the fixed white .email-shell background.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~4 minutes

Change: Other

Merge Risk: ⚪ Minimal · up to 3237e

This change aligns the README example and test expectation with the configured text color, which contrasts with the fixed white email shell. No actionable merge risk remains.

Architecture Summary

Architecture risk: 🔵 Low · up to 3237e

The change affects 1 system.

Changed systems: lib

Architecture concerns
No architecture-level concerns identified.

Review details

Systems and components

• observed — lib (service) was modified; 2 changed files map to changed impact.

Before / after behavior

• observed — Modified behavior in lib/helpers/mailer/README.md: The example textColor changes from #ffffff to #1a1a1a.
• observed — Modified behavior in lib/helpers/mailer/README.md: Adds guidance that textColor must contrast with the shell’s fixed white background, which is not configurable through brand settings.
• observed — Modified behavior in lib/helpers/mailer/tests/mailer.brand.unit.tests.js: The brand override test changes its expected textColor value from #ffffff to #1a1a1a.

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title clearly summarizes the primary change: making the mailer brand example’s text color readable.
Description check	✅ Passed	The description covers the required summary, scope, validation, guardrails, and reviewer notes. It identifies the change, reason, affected files, risk level, and related issue.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 1…
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

✨ Finishing Touches

📝 Generate docstrings

• Commit to this branch
• Create a new PR

🧪 Generate unit tests (beta)

• Commit to this branch
• Create a new PR

• Autopilot · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Warning

Some tools did not complete. Review the errors below.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

ESLint install failed: dependency version conflict. Check your lock file or package.json.

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands.}

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 94.55%. Comparing base (a547a1c) to head (3237ecf).

Additional details and impacted files

@@           Coverage Diff           @@
##           master    #4180   +/-   ##
=======================================
  Coverage   94.55%   94.55%           
=======================================
  Files         174      174           
  Lines        6134     6134           
  Branches     1979     1980    +1     
=======================================
  Hits         5800     5800           
  Misses        271      271           
  Partials       63       63           

Flag	Coverage Δ
integration	64.05% <ø> (ø)
unit	79.85% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

---

Continue to review full report in Codecov by Harness.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update a547a1c...3237ecf. Read the comment docs.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.