Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix link #130

Merged
merged 2 commits into from
Feb 18, 2025
Merged

Fix link #130

merged 2 commits into from
Feb 18, 2025

Conversation

JeroenDeDauw
Copy link
Member

@JeroenDeDauw JeroenDeDauw commented Feb 17, 2025

Reported at https://phabricator.wikimedia.org/T386183

I did not manually test this

Summary by CodeRabbit

  • New Features
    • The configuration text now uses Markdown-style links for clearer, consistent information display.
    • Introductory and footer messages have been enhanced to show formatted content safely, improving readability on the page.

Copy link

coderabbitai bot commented Feb 17, 2025

Walkthrough

The pull request updates a localization file and adjusts HTML message processing. In the localization file, a translation string has been modified to use Markdown-style linking instead of an HTML anchor. In the HTML presenter class, the methods for rendering intro and footer messages have been updated—using parsing for the introduction and escaping for the footer—to change how message content is prepared for HTML output.

Changes

File Summary
i18n/en.json Updated the "wikibase-rdf-config-list-intro" string; replaced HTML anchor tag with Markdown-style link formatting.
src/…/HtmlPredicatesPresenter.php Modified createIntro() to use parse() instead of text() and createFooter() to use escaped() instead of text().

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant Presenter as HtmlPredicatesPresenter
    participant Message

    Client->>Presenter: call createIntro()
    Presenter->>Message: retrieve intro message
    Message-->>Presenter: return raw intro message
    Presenter->>Presenter: process message with parse()
    Presenter-->>Client: return parsed intro HTML

    Client->>Presenter: call createFooter()
    Presenter->>Message: retrieve footer message
    Message-->>Presenter: return raw footer message
    Presenter->>Presenter: process message with escaped()
    Presenter-->>Client: return escaped footer HTML
Loading

Poem

I’m a rabbit with a skip in my code,
Hoping through configs on a bright new road.
Markdown links replace old HTML lore,
Parsing and escaping tweak messages more.
With a twitch of my nose, I cheer for what's in store!

Warning

There were issues while running some tools. Please review the errors and either fix the tool’s configuration or disable the tool if it’s a critical failure.

🔧 PHPStan (2.0.3)

/bin/bash: line 1: /vendor/bin/phpstan: No such file or directory


📜 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 53a53a0 and d748076.

📒 Files selected for processing (2)
  • i18n/en.json (1 hunks)
  • src/Presentation/HtmlPredicatesPresenter.php (2 hunks)
🚧 Files skipped from review as they are similar to previous changes (2)
  • i18n/en.json
  • src/Presentation/HtmlPredicatesPresenter.php

🪧 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. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @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.

@JeroenDeDauw JeroenDeDauw force-pushed the HtmlPredicatesPresenter branch from 53a53a0 to d748076 Compare February 17, 2025 18:40
@malberts malberts merged commit a42934e into master Feb 18, 2025
9 of 15 checks passed
@malberts malberts deleted the HtmlPredicatesPresenter branch February 18, 2025 13:59
@malberts
Copy link
Contributor

I confirmed with a manual test.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants