fix(config): Improved doc comments & value formatting of options

[christerswahn]

• fix(config): User friendly value formatting of Dir and File options
• docs(config): Fixed doc comment warnings

Summary by CodeRabbit

• New Features

  • Directory configuration now ensures directory paths include a trailing separator for consistency.
  • File configuration preserves file path formatting for reliable handling.

• Documentation

  • Escaped special characters in date-time configuration examples for clearer documentation.

[coderabbitai]

📝 Walkthrough

Walkthrough

Adds format(Directory) and format(File) methods to file-system parsers, escapes square brackets in a DateTimeParser DartDoc example, and restricts an import to show Configuration in the options module.

Changes

Cohort / File(s)	Summary
File-system formatters packages/config/lib/src/config/file_system_options.dart	Adds String format(Directory) returning a directory path with a trailing separator when missing, and String format(File) returning the file path as-is; adds path utilities import.
Docstring escape packages/config/lib/src/config/option_types.dart	Escapes [ and ] in DateTimeParser DartDoc example ([-_/:t] -> \[-_/:t\]) — documentation-only change.
Import narrowing packages/config/lib/src/config/options.dart	Changes import of configuration.dart to show Configuration, limiting exported symbols from that module.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Suggested reviewers

• nielsenko
• Isakdl

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check	✅ Passed	The pull request title "fix(config): Improved doc comments & value formatting of options" directly aligns with the changeset content. The title covers the two primary aspects of the changes: the documentation improvements (fixing DartDoc escaping in option_types.dart) and the value formatting enhancements (adding format methods to DirParser and FileParser in file_system_options.dart). The title is concise, specific, and avoids vague terms; a teammate reviewing the commit history would clearly understand that this PR improves both documentation and file system option formatting.
Docstring Coverage	✅ Passed	No functions found in the changes. Docstring coverage check skipped.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch ces-dev

---

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 704c0ca and 0019d36.

📒 Files selected for processing (3)

• packages/config/lib/src/config/file_system_options.dart (3 hunks)
• packages/config/lib/src/config/option_types.dart (1 hunks)
• packages/config/lib/src/config/options.dart (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (3)

• packages/config/lib/src/config/options.dart
• packages/config/lib/src/config/file_system_options.dart
• packages/config/lib/src/config/option_types.dart

---

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 and usage tips.}

[Isakdl]

LGTM