Added a type signature to settingscache.getPublic

[ErisDS]

• this piece of code returns settings based on their type, with schema changes, the returned type can change in potentially unexpected ways
• adding a type block here means that code using this method can determine if it's requested an unexpected property

[coderabbitai]

Walkthrough

The pull request introduces a new typedef named PublicSettingsCache that defines a structured object with properties such as title, description, logo, icon, accent_color, among others, each with specific types like string|null or boolean|null. The getPublic method in the cache manager is updated to return an object typed as PublicSettingsCache instead of a generic object. Its implementation is refactored: the previous method using _.each to iterate over settings is replaced with a more concise approach using Object.fromEntries and map. This revised implementation initializes the settings with keys set to null based on the publicSettings keys, then populates them via the _doGet method.

---

📜 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 54461a2 and 007c86a.

📒 Files selected for processing (1)

• ghost/core/core/shared/settings-cache/CacheManager.js (2 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (9)

• GitHub Check: Ghost-CLI tests
• GitHub Check: Database tests (Node 20.11.1, sqlite3)
• GitHub Check: Database tests (Node 22.13.1, mysql8)
• GitHub Check: Unit tests (Node 22.13.1)
• GitHub Check: Database tests (Node 20.11.1, mysql8)
• GitHub Check: Unit tests (Node 20.11.1)
• GitHub Check: Unit tests (Node 18.12.1)
• GitHub Check: Regression tests (Node 20.11.1, mysql8)
• GitHub Check: Database tests (Node 18.12.1, mysql8)

🔇 Additional comments (3)

ghost/core/core/shared/settings-cache/CacheManager.js (3)

15-65: Well-defined typedef for PublicSettingsCache.

The addition of this comprehensive typedef provides excellent documentation and type safety. Each property is clearly documented with its purpose and expected type, which will help developers understand what settings are available and their expected formats.

The inclusion of the never type for [x] property is a good practice to prevent accessing undefined properties.

---

220-220: Improved type safety for getPublic return value.

Changing the return type from generic {object} to the specific {PublicSettingsCache} enhances type safety and makes it clear what shape of data consumers should expect.

---

222-233: Refactored implementation with improved type safety and modernized code.

The updated implementation for getPublic() offers several improvements:

1. It correctly builds a return object that matches the PublicSettingsCache type definition
2. Using Object.fromEntries with map creates a clean initialization of the object
3. The explicit type annotation ensures TypeScript validation
4. The null coalescing operator (??) ensures consistent null values instead of undefined
5. Clear comments explain the two-stage process of building and populating the object

This implementation is more maintainable and provides better type safety than the previous one.

✨ Finishing Touches

• 📝 Generate Docstrings

---

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

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai plan to trigger planning for file edits and PR creation.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.