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

Add last updated property to tile card state content #21191

Merged
merged 1 commit into from
Jun 27, 2024

Conversation

piitaya
Copy link
Member

@piitaya piitaya commented Jun 27, 2024

Proposed change

Add last updated property to tile card state content

Type of change

  • Dependency upgrade
  • Bugfix (non-breaking change which fixes an issue)
  • New feature (thank you!)
  • Breaking change (fix/feature causing existing functionality to break)
  • Code quality improvements to existing code or addition of tests

Example configuration

Additional information

Checklist

  • The code change is tested and works locally.
  • There is no commented out code in this PR.
  • Tests have been added to verify that the new code works.

If user exposed functionality or configuration variables are added/changed:

Summary by CodeRabbit

  • New Features

    • Added a new option to display "Last updated" time in the Hui Tile Card.
    • Enhanced the Tile Card Editor with a new state content selection for "Last updated."
  • Localization

    • Added "Last updated" translation to the English language pack.

@piitaya piitaya added this to the 2024.7 milestone Jun 27, 2024
Copy link
Contributor

coderabbitai bot commented Jun 27, 2024

Walkthrough

Walkthrough

The update introduces a new feature to the HuiTileCard and its editor by adding the "last-updated" option. This enables users to display the last update time of an entity in a <ha-relative-time> element. Additionally, the corresponding translations for this feature are added to the English localization file.

Changes

File Change Summary
src/panels/lovelace/cards/hui-tile-card.ts Added a new condition for content === "last-updated", rendering a <ha-relative-time> element with stateObj.last_updated as datetime.
.../panels/lovelace/editor/config-elements/hui-tile-card-editor.ts Introduced a new option for state content selection by adding { label: localize("...last-updated"), value: "last-updated" } to the tile card editor.
src/translations/en.json Added "last-updated": "Last updated" under "state_content_options" in the English translation file.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Editor as HuiTileCardEditor
    participant Card as HuiTileCard
    participant RelativeTime as ha-relative-time
    
    User->>Editor: Open Tile Card Editor
    Editor->>User: Display content options
    User->>Editor: Select "Last updated"
    Editor->>Card: Pass "last-updated" value
    Card->>RelativeTime: Render ha-relative-time with last_updated
Loading

This diagram illustrates the interactions for selecting the "last-updated" state content option in the tile card editor. Once selected, the card renders the <ha-relative-time> component showing the last update time of the entity.


Recent review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE

Commits

Files that changed from the base of the PR and between 49c42fc and 960e93e.

Files selected for processing (3)
  • src/panels/lovelace/cards/hui-tile-card.ts (1 hunks)
  • src/panels/lovelace/editor/config-elements/hui-tile-card-editor.ts (1 hunks)
  • src/translations/en.json (1 hunks)
Additional context used
Biome
src/panels/lovelace/editor/config-elements/hui-tile-card-editor.ts

[error] 215-215: Forbidden non-null assertion.

(lint/style/noNonNullAssertion)


[error] 270-270: Forbidden non-null assertion.

Unsafe fix: Replace with optional chain operator ?. This operator includes runtime checks, so it is safer than the compile-only non-null assertion operator

(lint/style/noNonNullAssertion)


[error] 306-306: Forbidden non-null assertion.

Unsafe fix: Replace with optional chain operator ?. This operator includes runtime checks, so it is safer than the compile-only non-null assertion operator

(lint/style/noNonNullAssertion)


[error] 327-327: Avoid the delete operator which can impact performance.

Unsafe fix: Use an undefined assignment instead.

(lint/performance/noDelete)


[error] 332-332: Avoid the delete operator which can impact performance.

Unsafe fix: Use an undefined assignment instead.

(lint/performance/noDelete)


[error] 354-354: Avoid the delete operator which can impact performance.

Unsafe fix: Use an undefined assignment instead.

(lint/performance/noDelete)


[error] 368-368: Forbidden non-null assertion.

Unsafe fix: Replace with optional chain operator ?. This operator includes runtime checks, so it is safer than the compile-only non-null assertion operator

(lint/style/noNonNullAssertion)


[error] 369-369: Forbidden non-null assertion.

Unsafe fix: Replace with optional chain operator ?. This operator includes runtime checks, so it is safer than the compile-only non-null assertion operator

(lint/style/noNonNullAssertion)


[error] 373-373: Forbidden non-null assertion.

(lint/style/noNonNullAssertion)


[error] 373-373: Forbidden non-null assertion.

Unsafe fix: Replace with optional chain operator ?. This operator includes runtime checks, so it is safer than the compile-only non-null assertion operator

(lint/style/noNonNullAssertion)


[error] 376-376: Forbidden non-null assertion.

(lint/style/noNonNullAssertion)


[error] 376-376: Forbidden non-null assertion.

Unsafe fix: Replace with optional chain operator ?. This operator includes runtime checks, so it is safer than the compile-only non-null assertion operator

(lint/style/noNonNullAssertion)


[error] 379-379: Forbidden non-null assertion.

(lint/style/noNonNullAssertion)


[error] 382-382: Forbidden non-null assertion.

(lint/style/noNonNullAssertion)


[error] 407-407: Forbidden non-null assertion.

Unsafe fix: Replace with optional chain operator ?. This operator includes runtime checks, so it is safer than the compile-only non-null assertion operator

(lint/style/noNonNullAssertion)


[error] 412-412: Forbidden non-null assertion.

Unsafe fix: Replace with optional chain operator ?. This operator includes runtime checks, so it is safer than the compile-only non-null assertion operator

(lint/style/noNonNullAssertion)

src/panels/lovelace/cards/hui-tile-card.ts

[error] 139-139: Forbidden non-null assertion.

(lint/style/noNonNullAssertion)


[error] 139-139: Forbidden non-null assertion.

(lint/style/noNonNullAssertion)


[error] 139-139: Forbidden non-null assertion.

(lint/style/noNonNullAssertion)


[error] 145-145: Forbidden non-null assertion.

Unsafe fix: Replace with optional chain operator ?. This operator includes runtime checks, so it is safer than the compile-only non-null assertion operator

(lint/style/noNonNullAssertion)


[error] 146-146: Forbidden non-null assertion.

Unsafe fix: Replace with optional chain operator ?. This operator includes runtime checks, so it is safer than the compile-only non-null assertion operator

(lint/style/noNonNullAssertion)


[error] 148-148: Forbidden non-null assertion.

(lint/style/noNonNullAssertion)


[error] 158-158: Forbidden non-null assertion.

Unsafe fix: Replace with optional chain operator ?. This operator includes runtime checks, so it is safer than the compile-only non-null assertion operator

(lint/style/noNonNullAssertion)


[error] 231-231: Forbidden non-null assertion.

Unsafe fix: Replace with optional chain operator ?. This operator includes runtime checks, so it is safer than the compile-only non-null assertion operator

(lint/style/noNonNullAssertion)


[error] 260-260: Forbidden non-null assertion.

Unsafe fix: Replace with optional chain operator ?. This operator includes runtime checks, so it is safer than the compile-only non-null assertion operator

(lint/style/noNonNullAssertion)


[error] 265-265: Forbidden non-null assertion.

Unsafe fix: Replace with optional chain operator ?. This operator includes runtime checks, so it is safer than the compile-only non-null assertion operator

(lint/style/noNonNullAssertion)


[error] 310-311: Forbidden non-null assertion.

(lint/style/noNonNullAssertion)


[error] 388-388: Forbidden non-null assertion.

Unsafe fix: Replace with optional chain operator ?. This operator includes runtime checks, so it is safer than the compile-only non-null assertion operator

(lint/style/noNonNullAssertion)


[error] 389-389: Forbidden non-null assertion.

Unsafe fix: Replace with optional chain operator ?. This operator includes runtime checks, so it is safer than the compile-only non-null assertion operator

(lint/style/noNonNullAssertion)


[error] 332-332: Excessive complexity detected.

Please refactor this function to reduce its complexity score from 16 to the max allowed complexity 15.

(lint/complexity/noExcessiveCognitiveComplexity)

Gitleaks
src/translations/en.json

6536-6537: Identified a HashiCorp Terraform password field, risking unauthorized infrastructure configuration and security breaches.

(hashicorp-tf-password)

Additional comments not posted (5)
src/panels/lovelace/editor/config-elements/hui-tile-card-editor.ts (2)

204-209: Addition of 'last-updated' state content option is well-implemented.

The new option allows users to display the "last updated" timestamp, enhancing the functionality of the tile card editor. The use of localization ensures proper internationalization.


Line range hint 1-413: General approval for well-structured code and logic.

The component is well-structured, following best practices for LitElement components, and handles state and events appropriately.

src/panels/lovelace/cards/hui-tile-card.ts (2)

241-248: Addition of 'last-updated' condition is correctly implemented.

The new condition enhances the tile card by allowing the display of the "last updated" timestamp, providing more information to the user. The use of the <ha-relative-time> component is appropriate for this purpose.


Line range hint 1-410: General approval for well-structured code and logic.

The component is well-structured, following best practices for LitElement components, and handles state and events appropriately.

src/translations/en.json (1)

5991-5991: Translation addition is correct and well-placed.

The new key "last-updated" with the value "Last updated" is consistent with the existing structure and naming conventions of translation keys in en.json. This addition supports the new functionality in the user interface effectively.


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

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>.
    • 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
Contributor

@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: 0

Outside diff range comments (4)
src/panels/lovelace/editor/config-elements/hui-tile-card-editor.ts (2)

Line range hint 215-215: Replace non-null assertions with optional chaining for safer code.

Non-null assertions can lead to runtime errors. Optional chaining is safer as it includes runtime checks.

- this.hass!
+ this.hass?
- stateObj!
+ stateObj?
- this._config!
+ this._config?
- this._subElementEditorConfig!
+ this._subElementEditorConfig?

Also applies to: 270-270, 306-306, 368-368, 369-369, 373-373, 376-376, 379-379, 382-382, 407-407, 412-412


Line range hint 327-327: Optimize performance by replacing delete operations with undefined assignments.

Using delete can lead to performance issues in JavaScript. It's recommended to use undefined assignments instead.

- delete config.state_content;
+ config.state_content = undefined;
- delete config.features;
+ config.features = undefined;

Also applies to: 332-332, 354-354

src/panels/lovelace/cards/hui-tile-card.ts (2)

Line range hint 139-139: Replace non-null assertions with optional chaining for safer code.

Non-null assertions can lead to runtime errors. Optional chaining is safer as it includes runtime checks.

- this.hass!
+ this.hass?
- this._config!
+ this._config?
- ev.detail.action!
+ ev.detail.action?

Also applies to: 145-145, 146-146, 148-148, 158-158, 231-231, 260-260, 265-265, 388-388, 389-389


Line range hint 332-332: Consider refactoring to reduce complexity.

The function has a high complexity score, which can make it difficult to understand and maintain. Consider breaking it down into smaller, more manageable functions.

@piitaya piitaya merged commit 5273293 into dev Jun 27, 2024
14 checks passed
@piitaya piitaya deleted the last-updated-tile-card branch June 27, 2024 16:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

tile option last-changed does not see position% only open/close
2 participants