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

feat: allow custom attributes to be dynamic #26

Merged
merged 1 commit into from
Jun 18, 2024

Conversation

tonyennis145
Copy link
Contributor

No description provided.

Copy link

coderabbitai bot commented Jun 15, 2024

Walkthrough

The recent changes to the Attributes class in lib/entity/attributes.js primarily focus on enhancing the validation process for native attributes. These modifications include adding the new isValidNativeAttribute method to streamline native attribute validation before they are set on elements. Additionally, the isValidAttribute method has been adjusted to always return true and incorporates a specific check for attribute === ':'.

Changes

Files Change Summary
lib/entity/attributes.js Added isValidNativeAttribute method and updated isValidAttribute to include a check for attribute === ':'. Refined attribute validation logic.

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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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 as 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 resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 3

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between e4d8595 and 17af79a.

Files selected for processing (1)
  • lib/entity/attributes.js (2 hunks)

Comment on lines +20 to +25
if (attribute === ':') return false
if (!attribute.startsWith(':')) return false
if (Attributes.FORBIDDEN_ATTRIBUTES.includes(attribute)) return false
if (Events.isValidEvent(attribute)) return false
if (Attributes.CUSTOM_ATTRIBUTES.includes(attribute)) return true

return true
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Question the logic change in isValidAttribute.

The method now includes a check for attribute === ':', which correctly returns false. However, the subsequent line always returns true, which could inadvertently allow invalid attributes. Please verify if this is the intended behavior or consider revising it to ensure only valid attributes are accepted.

Comment on lines +28 to +29
static isValidNativeAttribute(attribute, element) {
if (!Attributes.isValidAttribute(attribute)) return false
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! Suggest a minor optimization in isValidNativeAttribute.

Consider caching the result of attribute.replace(':', '').split('.') since it's used multiple times, which could improve performance slightly.

-    const [nativeAttr] = attribute.replace(':', '').split('.');
+    const [nativeAttr] = attribute.startsWith(':') ? attribute.slice(1).split('.') : attribute.split('.');

Also applies to: 33-35

Comment on lines +250 to +274
const element = this.entity.element
const expr = element.getAttribute(attr)
if (!expr) return

try {
const newValue = await this._interpret(expr)
const nativeAttr = kebabToCamelCase(attr.slice(1))

if (attr.startsWith(':data-')) {
if (
this.entity.element.dataset[nativeAttr.slice(4)] !== newValue &&
newValue != null
) {
const datasetAttr =
nativeAttr[4].toLowerCase() + nativeAttr.slice(5)
this.entity.element.dataset[datasetAttr] = newValue

if (Attributes.isValidNativeAttribute(attr, element)) {
const nativeAttr = kebabToCamelCase(attr.slice(1))

if (attr.startsWith(':data-')) {
if (
element.dataset[nativeAttr.slice(4)] !== newValue &&
newValue != null
) {
const datasetAttr =
nativeAttr[4].toLowerCase() + nativeAttr.slice(5)
element.dataset[datasetAttr] = newValue
}
} else if (element[nativeAttr] !== newValue && newValue != null) {
element[nativeAttr] = newValue
}
} else if (
this.entity.element[nativeAttr] !== newValue &&
newValue != null
)
this.entity.element[nativeAttr] = newValue
} else {
element.setAttribute(attr.slice(1), newValue)
}
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Clarify handling of :data- attributes in evaluateOtherAttributes.

The method now includes handling for :data- attributes, which is a good improvement. However, the transformation of the attribute name from the dataset convention to the DOM API should be clarified or commented to avoid confusion for future maintainers.

@tonyennis145 tonyennis145 merged commit eced283 into main Jun 18, 2024
2 checks passed
Copy link

🚀 PR was released in v1.0.16 🚀

@github-actions github-actions bot added the released This has been released in npm label Jun 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
released This has been released in npm
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants