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

chore(deps): update dependency happy-dom to v17 #3115

Open
wants to merge 1 commit into
base: feat_v3.x
Choose a base branch
from

Conversation

renovate[bot]
Copy link
Contributor

@renovate renovate bot commented Mar 24, 2025

This PR contains the following updates:

Package Change Age Adoption Passing Confidence
happy-dom ^14.12.3 -> ^17.4.4 age adoption passing confidence

Warning

Some dependencies could not be looked up. Check the Dependency Dashboard for more information.


Release Notes

capricorn86/happy-dom (happy-dom)

v17.4.4

Compare Source

👷‍♂️ Patch fixes
  • Sets 0 instead of undefined as default in setTimeout() to prevent Bun from logging a "TimeoutNaNWarning" - By @​lekoala in task #​1772

v17.4.3

Compare Source

👷‍♂️ Patch fixes
  • Fixes issue where the wrong scope was used when settings.errorCapture is not set to "tryAndCatch" and handleEvent is used for the event listener - By @​capricorn86 in task #​1766

v17.4.2

Compare Source

👷‍♂️ Patch fixes
  • Fixes issue where an error was thrown for "xmlns" or unknown prefixes in Element.setAttribute() - By @​capricorn86 in task #​1750

v17.4.1

Compare Source

👷‍♂️ Patch fixes
  • Fixes issue where an error was thrown for attributes "xlink" or an unknown prefix during parsing of HTML - By @​capricorn86 in task #​1750

v17.4.0

Compare Source

🎨 Features

v17.3.2

Compare Source

👷‍♂️ Patch fixes

v17.3.1

Compare Source

👷‍♂️ Patch fixes
  • Fixes issue where an error was thrown for attributes with "xmlns" as prefix during parsing of HTML (e.g. <svg xmlns:link=""></svg>) - By @​capricorn86 in task #​1750

v17.3.0

Compare Source

🎨 Features

v17.2.4

Compare Source

👷‍♂️ Patch fixes

v17.2.3

Compare Source

👷‍♂️ Patch fixes
  • Element.contentEditable should be synced with the "contenteditable" attribute - By @​karpiuMG in task #​1463

v17.2.2

Compare Source

👷‍♂️ Patch fixes

v17.2.1

Compare Source

👷‍♂️ Patch fixes
  • Handle nested square brackets and parentheses inside pseudo-class arguments - By @​karpiuMG in task #​1072

v17.2.0

Compare Source

🎨 Features

v17.1.13

Compare Source

👷‍♂️ Patch fixes

v17.1.12

Compare Source

👷‍♂️ Patch fixes

v17.1.11

Compare Source

👷‍♂️ Patch fixes
  • Fixes issue with attribute references when using Element.cloneNode() - By @​Mas0nShi in task #​1745

v17.1.10

Compare Source

👷‍♂️ Patch fixes

v17.1.9

Compare Source

👷‍♂️ Patch fixes
  • Event listener properties prefixed with "on" should be the evaluated value of the corresponding attribute - By @​capricorn86 in task #​474

v17.1.8

Compare Source

👷‍♂️ Patch fixes

v17.1.7

Compare Source

👷‍♂️ Patch fixes

v17.1.6

Compare Source

🎨 Features
  • Adds support for sending AbortSignal as option to EventTarget.addEventListener() - By @​karpiuMG in task #​1540

v17.1.5

Compare Source

👷‍♂️ Patch fixes
  • HTMLElement.dataset should return undefined for properties not found - By @​karpiuMG in task #​1689

v17.1.4

Compare Source

👷‍♂️ Patch fixes
  • Fixes issue where the use of filtering in TreeWalker didn't work according to spec - By @​capricorn86 in task #​1605

v17.1.3

Compare Source

👷‍♂️ Patch fixes
  • Fixes incorrect handling of attribute prefixes when iterating NamedNodeMap - By @​capricorn86 in task #​1728
    • This caused attribute names to be incorrectly returned in Element.getAttributeNames() when attributes where using prefixes

v17.1.2

Compare Source

👷‍♂️ Patch fixes
  • AbortSignal.reason can have any type - By @​btea in task #​1718
  • When aborting a request, AbortSignal.reason should be the object used when the promise is rejected - By @​btea in task #​1718

v17.1.1

Compare Source

🎨 Features
👷‍♂️ Patch fixes
  • Fixes issue where it was not possible to nest @media, @supports and @container rules - By @​capricorn86 in task #​1727
  • Fixes issue where CSSStyleSheet was instantiated internally without a Window context, causing errors to not be thrown correctly in CSSStyleSheet methods - By @​capricorn86 in task #​1727
  • Changes errors thrown in CSSStyleSheet methods, so that they work according to spec - By @​capricorn86 in task #​1727

v17.1.0

Compare Source

🎨 Features
  • Add support for CSS media query rule "prefers-reduced-motion" - By @​mwdiaz in task #​1724

v17.0.4

Compare Source

👷‍♂️ Patch fixes
  • The "slotchange" event should be fired after the element has been connected to the DOM - By @​capricorn86 in task #​1722

v17.0.3

Compare Source

👷‍♂️ Patch fixes
  • Fixes bug where nested query selectors is not returning the correct result when there are multiple matching selector groups - By **@​christiango ** in task #​1720

v17.0.2

Compare Source

👷‍♂️ Patch fixes
  • The property "tabIndex" should return "0" by default in HTMLAnchorElement, HTMLAreaElement, HTMLButtonElement, HTMLIFrameElement, HTMLInputElement, HTMLMediaElement, HTMLObjectElement, HTMLSelectElement and HTMLTextAreaElement - By @​capricorn86 in task #​1714

v17.0.1

Compare Source

👷‍♂️ Patch fixes
  • Ensure querySelector() returns the first item that appears in the DOM for grouped selectors - By @​christiango in task #​1710

v17.0.0

Compare Source

💣 Breaking Changes
  • Adds support for ECMAScript modules - By @​capricorn86 in task #​320
    • This change allows the use of import and export statements in JavaScript files
🎨 Features
  • Adds support for tracing never ending tasks when using waitUntilComplete() - By @​capricorn86 in task #​1567
    • Read more about how to enable this feature under debug.traceWaitUntilComplete in the Wiki for IBrowserSettings
  • Adds support for preloading fetch, stylesheet, script and modules in HTMLLinkElement - By @​capricorn86 in task #​320
  • Adds support for HTMLLinkElement.relList.supports() - By @​capricorn86 in task #​320
  • Adds support for Request.mode - By @​capricorn86 in task #​320
  • Output failed requests to the console - By @​capricorn86 in task #​320
  • Adds support for HTMLScriptElement.blocking, HTMLScriptElement.crossOrigin, HTMLScriptElement.fetchPriority, HTMLScriptElement.noModule, HTMLScriptElement.integrity, HTMLScriptElement.referrerPolicy - By @​capricorn86 in task #​320
  • Use cache in virtual server requests - By @​capricorn86 in task #​320
  • Adds support for credentials and referrerPolicy when fetching styles and scripts - By @​capricorn86 in task #​320
  • Disallow invalid attributes from being set in Element.setAttribute() - By @​OlaviSau in task #​1706
👷‍♂️ Patch fixes
  • Call afterAsyncResponse fetch interceptor in virtual server requests - By @​capricorn86 in task #​320
  • Fixes bug where children in a ShadowRoot of a custom element that was upgraded from a HTMLElement wasn't considered connected to the DOM - By @​capricorn86 in task #​320

v16.8.1

Compare Source

👷‍♂️ Patch fixes

v16.8.0

Compare Source

🎨 Features

v16.7.3

Compare Source

👷‍♂️ Patch fixes
  • Removes space from directory name that prevents the repo to be cloned on MS Windows - By @​kleinfreund in task #​1703

v16.7.2

Compare Source

👷‍♂️ Patch fixes

v16.7.1

Compare Source

👷‍♂️ Patch fixes
  • Adds ICookie, IOptionalCookie, CookieSameSiteEnum and IVirtualServer as exports to the index file - By @​capricorn86 in task #​1693
  • Makes non-mandatory cookie properties optional in CookieContainer.addCookies() - By @​capricorn86 in task #​1693

v16.7.0

Compare Source

🎨 Features
  • Adds support for simulating local HTTP servers that serves files from the local file system - By @​capricorn86 in task #​1688
    • Read more about virtual servers in the Wiki

v16.6.0

Compare Source

🎨 Features
  • Adds support for subsequent sibling combinator to querySelector(), querySelectorAll() and matches() (e.g. ".a ~ .b") - By @​karpiuMG in task #​1683

v16.5.3

Compare Source

👷‍♂️ Patch fixes
  • Fixes problem with encoding and decoding attribute values in HTML - By @​capricorn86 in task #​1678
  • Fixes issue where it was not possible to query selector by class when the attribute value had line breaks in it - By @​capricorn86 in task #​1678

v16.5.2

Compare Source

👷‍♂️ Patch fixes
  • Event.target should be the target element after an event has been dispatched - By @​capricorn86 in task #​1529

v16.5.1

Compare Source

👷‍♂️ Patch fixes
  • Fixes issue where Comment, Text and DocumentFragment are not instances of their corresponding property on Window - By @​capricorn86 in task #​1577

v16.5.0

Compare Source

🎨 Features

v16.4.3

Compare Source

👷‍♂️ Patch fixes
  • Adds null check for if browser frame is available in Response during tear down of the Window - By @​capricorn86 in task #​1669

v16.4.2

Compare Source

👷‍♂️ Patch fixes

v16.4.1

Compare Source

👷‍♂️ Patch fixes
  • Fixes issue where HTML assigned to document.documentElement.innerHTML isnt parsed correctly since v16 - By @​capricorn86 in task #​1663

v16.4.0

Compare Source

🎨 Features

v16.3.0

Compare Source

🎨 Features
  • Adds support for child combinator to ":has()" pseudo selector (e.g. "span:has(> video)") - By @​capricorn86 in task #​1642

v16.2.9

Compare Source

👷‍♂️ Patch fixes
  • Fixes the HTMLInputElement.defaultChecked property - By @​capricorn86 in task #​1587
    • This issue caused React not to serialize the "checked" attribute correctly

v16.2.8

Compare Source

👷‍♂️ Patch fixes
  • Fixes issue where the wrong event target was used when dispatching events on HTMLFormElement or HTMLSelectElement - By @​capricorn86 in task #​1628

v16.2.7

Compare Source

👷‍♂️ Patch fixes
  • Fixes issue where text in <script> and <style> elements should not be decoded or encoded - By @​capricorn86 in task #​1564

v16.2.6

Compare Source

👷‍♂️ Patch fixes
  • Fixes problem where snapshots did not result in HTML for <form> and <select> elements - By @​capricorn86 in task #​1608

v16.2.5

Compare Source

👷‍♂️ Patch fixes
  • Fixes bug where the reference to a parent HTMLFormElement and HTMLSelectElement was wrong which affected the methods remove(), replaceWith(), before(), after(), append(), prepend(), replaceChildren() and insertAdjacentElement() - By @​capricorn86 in task #​1637

v16.2.4

Compare Source

👷‍♂️ Patch fixes
  • Fixes bug where the incorrect location is set after a redirect in BrowserFrame.goto() and DetachedBrowserFrame.goto() - By @​capricorn86 in task #​1627

v16.2.3

Compare Source

👷‍♂️ Patch fixes

v16.2.2

Compare Source

👷‍♂️ Patch fixes
  • Improves error when a Symbol object is being sent to querySelector() or querySelectorAll() as selector - By @​chocolateboy in task #​1640

v16.2.1

Compare Source

👷‍♂️ Patch fixes
  • Set request credentials to "same-origin" in XMLHttpRequest when "withCredentials" is false - By @​saitonakamura in task #​1631

v16.2.0

Compare Source

🎨 Features

v16.1.0

Compare Source

🎨 Features

v16.0.1

Compare Source

👷‍♂️ Patch fixes
  • Fixes problem with children of created documents (e.g. document.implementation.createHTMLDocument()) not being considered as connected to a DOM that was introduced in v16 - By @​capricorn86 in task #​1647

v16.0.0

Compare Source

💣 Breaking Changes
  • Refactors XML and HTML parsing and serialization - By @​capricorn86 in task #​1615
    • This change may break your tests as the serialized output may differ from v15
🎨 Features
👷‍♂️ Patch fixes

v15.11.7

Compare Source

👷‍♂️ Patch fixes
  • Allow for an URL to be a string or an URL object in History.pushState() and History.replaceState() - By @​sohailalam2 in task #​1621

v15.11.6

Compare Source

👷‍♂️ Patch fixes

v15.11.5

Compare Source

👷‍♂️ Patch fixes
  • HTMLSelectElement should not dispatch "change" event when changing value or index - By @​capricorn86 in task #​1603

v15.11.4

Compare Source

👷‍♂️ Patch fixes
  • Strings should be converted into numbers in setters for HTMLMeterElement and HTMLProgressElement - By @​capricorn86 in task #​1601

v15.11.3

Compare Source

👷‍♂️ Patch fixes

v15.11.2

Compare Source

👷‍♂️ Patch fixes
  • Fixes bug where pseudo selectors without an ending parentheses threw an in invalid selector error - By @​capricorn86 in task #​1558
  • Fixes bug where it was not possible to use the characters ":" and "\" in attribute selectors - By @​capricorn86 in task #​1561

v15.11.1

Compare Source

👷‍♂️ Patch fixes
  • Fixes bug where Document.activeElement is set to the wrong target when triggering HTMLSelectElement.focus() - By @​capricorn86 in task #​1592
    • HTMLSelectElement is a Proxy since v15 and focus() was setting the target of the Proxy as the active element, but should set the Proxy

v15.11.0

Compare Source

🎨 Features

v15.10.8

Compare Source

👷‍♂️ Patch fixes
  • Validate that object is of type Blob in FileReader.readAsArrayBuffer(), FileReader.readAsBinaryString(), FileReader.readAsDataURL() and FileReader.readAsText() - By @​btea in task #​1565

v15.10.7

Compare Source

👷‍♂️ Patch fixes
  • Cookies with values that contains "=" should be supported - By @​btea in task #​1570

v15.10.6

Compare Source

👷‍♂️ Patch fixes
  • Accept objects with a stringifier (such as a URL object) in Location.assign() and Location.replace() - By @​silverwind in task #​1568

v15.10.5

Compare Source

👷‍♂️ Patch fixes
  • Fixes incorrect serialization of special characters in raw text elements such as <script> and <style> - By @​BenjaminAster in task #​1566

v15.10.4

Compare Source

👷‍♂️ Patch fixes

v15.10.3

Compare Source

👷‍♂️ Patch fixes
  • Allow to set custom export conditions in @happy-dom/jest-environment - By @​aearly in task #​1555

v15.10.2

Compare Source

👷‍♂️ Patch fixes
  • Fixes a security vulnerability that allowed for server side code to be executed by a <script> tag - By @​capricorn86 in task #​1585
    • There was a case that was missed with the first patch

v15.10.1

Compare Source

👷‍♂️ Patch fixes
  • Fixes a security vulnerability that allowed for server side code to be executed by a <script> tag - By @​capricorn86 in task #​1585

v15.10.0

Compare Source

🎨 Features
  • Adds a new setting called disableSameOriginPolicy that makes it possible to bypass the same-origin policy in fetch requests - By @​OlaviSau in task #​1553

v15.9.0

Compare Source

🎨 Features
  • Adds support for "aspect-ratio" to CSSStyleDeclaration - By @​yinm in task #​1147

v15.8.5

Compare Source

👷‍♂️ Patch fixes
  • Fixes bug where Node.getRootNode() returned null when it was within a ShadowRoot that previously been disconnected from the Document - By @​capricorn86 in task #​1581

v15.8.4

Compare Source

👷‍♂️ Patch fixes
  • Fixes bug where child nodes of HTMLSelectElement and HTMLFormElement had the wrong reference to the parent - By @​capricorn86 in task #​1578

v15.8.3

Compare Source

👷‍♂️ Patch fixes
  • Toggle "open" attribute on HTMLDetailsElement when dispatching a click event on a summary element which is a child of the details element - By @​mikedidomizio in task #​1534

v15.8.2

Compare Source

👷‍♂️ Patch fixes
  • Use globalThis instead of global to make Happy DOM work in other runtimes such as Cloudflare workers - By @​mattallty in task #​1546

v15.8.1

Compare Source

👷‍♂️ Patch fixes

v15.8.0

Compare Source

👷‍♂️ Patch fixes
  • Adds support for using non-ASCII characters in custom elements when parsing HTML - By @​capricorn86 in task #​1079
  • Fixes an issue where getHTML() and getInnerHTML() would return the slotted content of a shadow root before the template, but the template should be the first child - By @​capricorn86 in task #​1079
  • Fixes a bug where SVG elements would not be found by getElementsByTagName() - By @​capricorn86 in task #​1079
  • Improves performance when creating elements (e.g. during parsing of HTML) - By @​capricorn86 in task #​1550
    • Binding all methods to the target scope in Proxies caused a performance hit, so this is now done when calling a method the first time
🎨 Features
  • Adds support for all remaining SVG elements: SVGAnimateElement, SVGAnimateMotionElement, SVGAnimateTransformElement, SVGCircleElement, SVGClipPathElement, SVGDefsElement, SVGDescElement, SVGEllipseElement, SVGFEBlendElement, SVGFEColorMatrixElement, SVGFEComponentTransferElement, SVGFECompositeElement, SVGFEConvolveMatrixElement, SVGFEDiffuseLightingElement, SVGFEDisplacementMapElement, SVGFEDistantLightElement, SVGFEDropShadowElement, SVGFEFloodElement, SVGFEFuncAElement, SVGFEFuncBElement, SVGFEFuncGElement, SVGFEFuncRElement, SVGFEGaussianBlurElement, SVGFEImageElement, SVGFEMergeElement, SVGFEMergeNodeElement, SVGFEMorphologyElement, SVGFEOffsetElement, SVGFEPointLightElement, SVGFESpecularLightingElement, SVGFESpotLightElement, SVGFETileElement, SVGFETurbulenceElement, SVGFilterElement, SVGForeignObjectElement, SVGGElement, SVGImageElement, SVGLineElement, SVGLinearGradientElement, SVGMarkerElement, SVGMaskElement, SVGMetadataElement, SVGMPathElement, SVGPathElement, SVGPatternElement, SVGPolygonElement, SVGPolylineElement, SVGRadialGradientElement, SVGRectElement, SVGScriptElement, SVGSetElement, SVGStopElement, SVGStyleElement, SVGSwitchElement, SVGSymbolElement, SVGTextElement, SVGTextPathElement, SVGTitleElement, SVGTSpanElement, SVGUseElement and SVGViewElement - By @​capricorn86 in task #​1079
  • Adds support for DOMMatrix, DOMMatrixReadOnly, DOMPoint and DOMPointReadOnly - By @​capricorn86 in task #​1079
  • Adds support for SVGAngle, SVGAnimatedAngle, SVGAnimatedBoolean, SVGAnimatedEnumeration, SVGAnimatedInteger, SVGAnimatedLength, SVGAnimatedLengthList, SVGAnimatedNumber, SVGAnimatedNumberList, SVGAnimatedPreserveAspectRatio, SVGAnimatedRect, SVGAnimatedString, SVGAnimatedTransformList, SVGLength, SVGLengthList, SVGMatrix, SVGNumber, SVGNumberList, SVGPoint, SVGPointList, SVGPreserveAspectRatio, SVGRect, SVGStringList, SVGTransform, SVGTransformList and SVGUnitTypes - By @​capricorn86 in task #​1079

v15.7.4

Compare Source

👷‍♂️ Patch fixes
  • Fixes incorrect handling of non-node items inserted using replaceWith(), before() and after() - By @​BenjaminAster in task #​1533

v15.7.3

Compare Source

👷‍♂️ Patch fixes
  • Fixes bug that occurs when checking if a symbol property exists on HTMLSelectElement - By @​Cherry in task #​1526

v15.7.2

Compare Source

👷‍♂️ Patch fixes
  • Fixes problem where it is not possible to observe again after disconnecting in MutationObserver - By @​capricorn86 in task #​1524

v15.7.1

Compare Source

👷‍♂️ Patch fixes
  • Fixes selector validation and converts selectors to string (e.g. querySelector(['.class'])) - By @​capricorn86 in task #​1507

v15.7.0

Compare Source

🎨 Features

v15.6.1

Compare Source

👷‍♂️ Patch fixes
  • Include Access-Control-*, Origin headers for cross-origin preflight requests - By @​rexxars in task #​1489

v15.6.0

Compare Source

🎨 Features
👷‍♂️ Patch fixes
  • Changes wrong property name "inputmode" to "inputMode" in HTMLInputElement and HTMLTextAreaElement - By @​capricorn86 in task #​1487

v15.5.0

Compare Source

🎨 Features

v15.4.3

Compare Source

👷‍♂️ Patch fixes
  • Adds support for supporting new lines and tabs as white-space character in CSS selectors - By @​syi0808 in task #​1414

v15.4.2

Compare Source

👷‍♂️ Patch fixes

v15.4.1

Compare Source

👷‍♂️ Patch fixes
  • Throw error in FormData.append() when value parameter type is incorrect - By @​btea in task #​1484

v15.4.0

Compare Source

🎨 Features

v15.3.2

Compare Source

👷‍♂️ Patch fixes
  • Fixes the `HTMLInputElement.

Configuration

📅 Schedule: Branch creation - "* 0-3 * * 1" (UTC), Automerge - At any time (no schedule defined).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about this update again.


  • If you want to rebase/retry this PR, check this box

This PR was generated by Mend Renovate. View the repository job log.

Copy link
Contributor Author

renovate bot commented Mar 24, 2025

⚠️ Artifact update problem

Renovate failed to update an artifact related to this branch. You probably do not want to merge this PR as-is.

♻ Renovate will retry this branch, including artifacts, only when one of the following happens:

  • any of the package files in this branch needs updating, or
  • the branch becomes conflicted, or
  • you click the rebase/retry checkbox if found above, or
  • you rename this PR's title to start with "rebase!" to trigger it manually

The artifact failure details are included below:

File name: pnpm-lock.yaml
Scope: all 5 workspace projects
Progress: resolved 1, reused 0, downloaded 0, added 0
packages/nutui-replace-icons             |  WARN  deprecated [email protected]
packages/nutui-taro-demo                 |  WARN  deprecated [email protected]
/tmp/renovate/repos/github/jdf2e/nutui-react/packages/nutui-taro-demo:
 ERR_PNPM_FETCH_404  GET https://registry.npmjs.org/@jdtaro%2Ftaro-platform-jdharmony: Not Found - 404

This error happened while installing a direct dependency of /tmp/renovate/repos/github/jdf2e/nutui-react/packages/nutui-taro-demo

@jdtaro/taro-platform-jdharmony is not in the npm registry, or you have no permission to fetch it.

No authorization header was set for the request.

Copy link

coderabbitai bot commented Mar 24, 2025

Important

Review skipped

Bot user detected.

To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


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
🪧 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 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.

@github-actions github-actions bot added action:review This PR needs more reviews (less than 2 approvals) 3.x Target branch 3.x labels Mar 24, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
3.x Target branch 3.x action:review This PR needs more reviews (less than 2 approvals) dependencies size/XS
Projects
None yet
Development

Successfully merging this pull request may close these issues.

0 participants