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: Update JSON schema for Summary2 #14529

Merged
merged 2 commits into from
Jan 31, 2025
Merged

Conversation

mlqn
Copy link
Contributor

@mlqn mlqn commented Jan 28, 2025

Description

Update JSON schema for Summary2

Verification

  • Your code builds clean without any errors or warnings
  • Manual testing done (required)

Summary by CodeRabbit

Summary by CodeRabbit

  • New Features

    • Added isCompact property to control component compactness.
    • Introduced default "auto" sizing for grid properties (xs, sm, md, lg, xl).
    • Expanded override options for multiple component types (Tabs, Map, Subform, Likert, Payment, Header, Paragraph, Text, Number, Date).
  • Localization Improvements

    • Added new error messages and validation feedback in Norwegian.
    • Enhanced UI labels and descriptions for better user guidance.

Copy link
Contributor

coderabbitai bot commented Jan 28, 2025

📝 Walkthrough

Walkthrough

The pull request modifies the JSON schema for the Summary2 component in the frontend package. The changes include adding a default value of "auto" to grid properties (xs, sm, md, lg, xl), introducing a new boolean isCompact property, and expanding the overrides array with multiple new reference types for various summary override props. Additionally, it enhances localization in the Norwegian language JSON file by adding new error messages, labels, and validation messages to improve user feedback and interface clarity.

Changes

File Change Summary
frontend/packages/ux-editor/src/testing/schemas/json/component/Summary2.schema.v1.json - Added isCompact boolean property
- Updated grid properties (xs, sm, md, lg, xl) with default "auto"
- Added new override references for multiple component types
frontend/language/src/nb.json - Added multiple API error messages and validation error messages
- Added new labels for application content library

Possibly related PRs

Suggested labels

text/content, added-to-sprint

Suggested reviewers

  • Ildest
  • Jondyr
  • github-actions

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

@github-actions github-actions bot added area/ui-editor Area: Related to the designer tool for assembling app UI in Altinn Studio. solution/studio/designer Issues related to the Altinn Studio Designer solution. frontend labels Jan 28, 2025
@mlqn mlqn marked this pull request as ready for review January 28, 2025 10:06
@mlqn mlqn added team/studio-domain2 kind/feature-request Feature request that will be considered. labels Jan 28, 2025
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: 3

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 10be65e and 7c623bb.

📒 Files selected for processing (1)
  • frontend/packages/ux-editor/src/testing/schemas/json/component/Summary2.schema.v1.json (3 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: Build environment and run e2e test
  • GitHub Check: CodeQL
  • GitHub Check: Testing
🔇 Additional comments (1)
frontend/packages/ux-editor/src/testing/schemas/json/component/Summary2.schema.v1.json (1)

Line range hint 1-106: Overall changes look good!

The schema updates successfully enhance the Summary2 component's configurability by:

  1. Adding default grid behavior
  2. Introducing compact mode option
  3. Expanding override capabilities

The changes maintain schema integrity and align well with the PR objectives.

Copy link

codecov bot commented Jan 28, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 95.70%. Comparing base (10be65e) to head (2331b22).
Report is 9 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main   #14529   +/-   ##
=======================================
  Coverage   95.70%   95.70%           
=======================================
  Files        1902     1902           
  Lines       24778    24778           
  Branches     2840     2840           
=======================================
  Hits        23715    23715           
  Misses        802      802           
  Partials      261      261           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@mlqn mlqn changed the title feat: Update of the JSON schema for Summary2 feat: Update JSON schema for Summary2 Jan 28, 2025
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

🧹 Nitpick comments (2)
frontend/language/src/nb.json (2)

Line range hint 14-15: Consider adding more context to code list labels.

While the translations are correct, consider adding more descriptive text to help users understand the purpose of code lists, especially for the "clear_search_button_label" which could benefit from additional context.

Consider updating the translations to be more descriptive:

-  "app_content_library.code_lists.clear_search_button_label": "Fjern søkeord",
+  "app_content_library.code_lists.clear_search_button_label": "Fjern søkeord fra kodeliste",

1392-1392: Add more context to isCompact translation.

Since this is part of the Summary2 schema update, consider making the translation more specific to its context.

Consider updating the translation to be more descriptive:

-  "ux_editor.component_properties.isCompact": "Bruk kompakt visning",
+  "ux_editor.component_properties.isCompact": "Bruk kompakt visning i oppsummering",
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 7c623bb and 2331b22.

📒 Files selected for processing (1)
  • frontend/language/src/nb.json (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (4)
  • GitHub Check: Build environment and run e2e test
  • GitHub Check: Typechecking and linting
  • GitHub Check: Testing
  • GitHub Check: CodeQL
🔇 Additional comments (2)
frontend/language/src/nb.json (2)

Line range hint 1-13: LGTM! API error messages are well-structured.

The new API error messages follow a consistent format and provide clear feedback in Norwegian.


Line range hint 16-17: LGTM! Validation messages are clear and consistent.

The validation error messages provide clear guidance and maintain consistency with existing message patterns.

@lassopicasso lassopicasso self-assigned this Jan 31, 2025
@lassopicasso lassopicasso removed their assignment Jan 31, 2025
@lassopicasso lassopicasso added the skip-manual-testing PRs that do not need to be tested manually label Jan 31, 2025
@lassopicasso lassopicasso merged commit 63f248b into main Jan 31, 2025
12 checks passed
@lassopicasso lassopicasso deleted the update-summary2-schema branch January 31, 2025 07:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/ui-editor Area: Related to the designer tool for assembling app UI in Altinn Studio. frontend kind/feature-request Feature request that will be considered. skip-manual-testing PRs that do not need to be tested manually solution/studio/designer Issues related to the Altinn Studio Designer solution. team/studio-domain2
Projects
Status: ✅ Done
Development

Successfully merging this pull request may close these issues.

2 participants