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: Retrieving help texts from nb.json instead of JSON schemas #14420

Merged

Conversation

mlqn
Copy link
Contributor

@mlqn mlqn commented Jan 14, 2025

Description

Retrieving help texts from nb.json instead of JSON schemas

Related Issue(s)

Verification

  • Your code builds clean without any errors or warnings
  • Manual testing done (required)
  • Relevant automated test added (if you find this hard, leave it and we'll help out)

Documentation

  • User documentation is updated with a separate linked PR in altinn-studio-docs. (if applicable)

Summary by CodeRabbit

  • New Features

    • Added help text for preselectedOptionIndex in Norwegian language file
  • Refactor

    • Removed helpText prop from multiple components related to data model bindings and property editing
    • Introduced useComponentPropertyHelpText hook to dynamically generate help text
  • Documentation

    • Updated component documentation by removing explicit help text props

@mlqn mlqn linked an issue Jan 14, 2025 that may be closed by this pull request
Copy link
Contributor

coderabbitai bot commented Jan 14, 2025

📝 Walkthrough

Walkthrough

This pull request involves systematic modifications across multiple frontend components, primarily focusing on removing helpText properties and introducing a new useComponentPropertyHelpText hook. The changes span several TypeScript files in the UX editor package, affecting how help text is managed and displayed. A complementary change in the Norwegian language JSON file adds a help text for the preselectedOptionIndex property, providing guidance on its usage.

Changes

File Change Summary
frontend/language/src/nb.json Added help text for preselectedOptionIndex property
frontend/packages/ux-editor/src/components/Properties/DataModelBindings.tsx Removed helpText prop from EditDataModelBinding
frontend/packages/ux-editor/src/components/config/FormComponentConfig.tsx Removed validFileEndings and associated helpText attributes
frontend/packages/ux-editor/src/components/**/EditBinding/* Removed helpText from props, interfaces, and test configurations
frontend/packages/ux-editor/src/components/config/editModal/EditNumberValue.tsx Replaced helpText prop with useComponentPropertyHelpText hook
frontend/packages/ux-editor/src/components/config/editModal/EditStringValue.tsx Replaced helpText prop with useComponentPropertyHelpText hook

Possibly related PRs

Suggested labels

skip-releasenotes, quality/testing, skip-documentation

Suggested reviewers

  • ErlingHauan
  • JamalAlabdullah

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.

@mlqn mlqn changed the title chore: Retrieve help texts from nb.json instead of JSON schemas chore: Retrieving help texts from nb.json instead of JSON schemas Jan 14, 2025
@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 14, 2025
Copy link

codecov bot commented Jan 14, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 95.64%. Comparing base (8133d37) to head (b9e1998).
Report is 29 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main   #14420   +/-   ##
=======================================
  Coverage   95.64%   95.64%           
=======================================
  Files        1874     1874           
  Lines       24354    24359    +5     
  Branches     2800     2800           
=======================================
+ Hits        23294    23299    +5     
  Misses        799      799           
  Partials      261      261           

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

@mlqn mlqn marked this pull request as ready for review January 14, 2025 15:45
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 (1)
frontend/packages/ux-editor/src/components/config/editModal/EditNumberValue.tsx (1)

34-34: Consider improving type safety when converting propertyKey to string.

While the implementation is correct, the type conversion of propertyKey to string could be made more explicit:

-      helpText={componentPropertyHelpText(String(propertyKey))}
+      helpText={componentPropertyHelpText(propertyKey.toString())}

This makes the intention clearer and is more idiomatic in TypeScript.

Also applies to: 51-51

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 3598858 and b9e1998.

📒 Files selected for processing (10)
  • frontend/language/src/nb.json (1 hunks)
  • frontend/packages/ux-editor/src/components/Properties/DataModelBindings.tsx (0 hunks)
  • frontend/packages/ux-editor/src/components/config/FormComponentConfig.tsx (1 hunks)
  • frontend/packages/ux-editor/src/components/config/editModal/EditDataModelBinding/EditBinding/EditBinding.test.tsx (0 hunks)
  • frontend/packages/ux-editor/src/components/config/editModal/EditDataModelBinding/EditBinding/EditBinding.tsx (0 hunks)
  • frontend/packages/ux-editor/src/components/config/editModal/EditDataModelBinding/EditBinding/SelectDataFieldBinding.tsx (3 hunks)
  • frontend/packages/ux-editor/src/components/config/editModal/EditDataModelBinding/EditDataModelBinding.test.tsx (0 hunks)
  • frontend/packages/ux-editor/src/components/config/editModal/EditDataModelBinding/EditDataModelBinding.tsx (0 hunks)
  • frontend/packages/ux-editor/src/components/config/editModal/EditNumberValue.tsx (3 hunks)
  • frontend/packages/ux-editor/src/components/config/editModal/EditStringValue.tsx (3 hunks)
💤 Files with no reviewable changes (5)
  • frontend/packages/ux-editor/src/components/config/editModal/EditDataModelBinding/EditDataModelBinding.test.tsx
  • frontend/packages/ux-editor/src/components/config/editModal/EditDataModelBinding/EditDataModelBinding.tsx
  • frontend/packages/ux-editor/src/components/config/editModal/EditDataModelBinding/EditBinding/EditBinding.test.tsx
  • frontend/packages/ux-editor/src/components/config/editModal/EditDataModelBinding/EditBinding/EditBinding.tsx
  • frontend/packages/ux-editor/src/components/Properties/DataModelBindings.tsx
✅ Files skipped from review due to trivial changes (1)
  • frontend/language/src/nb.json
🔇 Additional comments (5)
frontend/packages/ux-editor/src/components/config/editModal/EditDataModelBinding/EditBinding/SelectDataFieldBinding.tsx (2)

13-13: LGTM: Hook import added correctly.

The import of useComponentPropertyHelpText hook is properly placed with other hook imports.


37-37: LGTM: Help text retrieval migrated to use the new hook.

The migration from static helpText prop to dynamic retrieval using useComponentPropertyHelpText is implemented correctly. The hook is properly initialized and used with the correct key format data_model_bindings.${bindingKey}.

Also applies to: 60-60

frontend/packages/ux-editor/src/components/config/editModal/EditStringValue.tsx (1)

9-9: LGTM: String value editing component updated to use the new help text system.

The changes correctly implement the new help text retrieval system:

  1. Hook import added
  2. Hook properly initialized
  3. Help text dynamically retrieved using the property key

Also applies to: 29-29, 45-45

frontend/packages/ux-editor/src/components/config/FormComponentConfig.tsx (1)

48-48: LGTM: Properties destructuring simplified.

The removal of validFileEndings from destructuring is consistent with the migration to the new help text system.

frontend/packages/ux-editor/src/components/config/editModal/EditNumberValue.tsx (1)

9-13: LGTM: Hook imports properly organized.

The imports are correctly grouped and organized.

Copy link
Member

@Jondyr Jondyr left a comment

Choose a reason for hiding this comment

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

LGTM 👍 🚀

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 solution/studio/designer Issues related to the Altinn Studio Designer solution.
Projects
None yet
3 participants