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

Visual editor for .quilt/catalog/config.yaml #4261

Open
wants to merge 84 commits into
base: master
Choose a base branch
from

Conversation

fiskus
Copy link
Member

@fiskus fiskus commented Dec 20, 2024

image

  • Unit tests
  • Documentation
  • Changelog entry (skip if change is not significant to end users, e.g. docs only)

@fiskus fiskus requested a review from Copilot December 20, 2024 16:06

Choose a reason for hiding this comment

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

Copilot reviewed 5 out of 13 changed files in this pull request and generated no comments.

Files not reviewed (8)
  • catalog/app/components/FileEditor/QuiltConfigEditor/BucketPreferences.tsx: Evaluated as low risk
  • catalog/app/utils/BucketPreferences/index.ts: Evaluated as low risk
  • catalog/app/components/FileEditor/QuiltConfigEditor/index.tsx: Evaluated as low risk
  • catalog/app/components/FileEditor/loader.spec.ts: Evaluated as low risk
  • catalog/app/components/FileEditor/FileEditor.tsx: Evaluated as low risk
  • catalog/app/components/FileEditor/loader.ts: Evaluated as low risk
  • catalog/app/utils/BucketPreferences/BucketPreferences.ts: Evaluated as low risk
  • catalog/app/components/FileEditor/QuiltConfigEditor/BucketPreferences/index.ts: Evaluated as low risk
Comments suppressed due to low confidence (3)

catalog/app/components/FileEditor/QuiltConfigEditor/BucketPreferences/PackageDescription.tsx:73

  • [nitpick] The function name handleEnter is ambiguous. It should be renamed to something more descriptive like handleEnterKeyPress.
const handleEnter = React.useCallback(

catalog/app/components/FileEditor/QuiltConfigEditor/BucketPreferences/PackageDescription.tsx:23

  • The options prop in the Labels component is an empty array, which might be a mistake. Ensure that it is populated with the correct options.
options={[]}

catalog/app/components/FileEditor/QuiltConfigEditor/BucketPreferences/PackageDescription.tsx:241

  • Passing an empty string to handlePattern in PackageDescription could lead to unintended behavior. Ensure that handlePattern is always a valid string.
handlePattern=""
Copy link

codecov bot commented Dec 20, 2024

Codecov Report

Attention: Patch coverage is 82.64151% with 46 lines in your changes missing coverage. Please review.

Project coverage is 38.35%. Comparing base (aa14ad8) to head (046edad).

Files with missing lines Patch % Lines
...figEditor/BucketPreferences/PackageDescription.tsx 70.88% 22 Missing and 1 partial ⚠️
...nfigEditor/BucketPreferences/BucketPreferences.tsx 87.93% 14 Missing ⚠️
catalog/app/components/FileEditor/FileEditor.tsx 50.00% 5 Missing ⚠️
...itor/QuiltConfigEditor/BucketPreferences/State.tsx 94.64% 3 Missing ⚠️
...ditor/QuiltConfigEditor/BucketPreferences/index.ts 0.00% 1 Missing ⚠️
Additional details and impacted files
@@           Coverage Diff           @@
##           master    #4261   +/-   ##
=======================================
  Coverage   38.35%   38.35%           
=======================================
  Files         778      777    -1     
  Lines       34366    34400   +34     
  Branches     5424     5494   +70     
=======================================
+ Hits        13180    13195   +15     
- Misses      20007    20026   +19     
  Partials     1179     1179           
Flag Coverage Δ
api-python 91.34% <ø> (ø)
catalog 17.58% <82.64%> (+0.70%) ⬆️
lambda 91.35% <ø> (-0.14%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

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

@fiskus fiskus changed the title Bucket preferences editor Visual editor for .quilt/catalog/config.yaml Dec 24, 2024
@fiskus fiskus marked this pull request as ready for review December 24, 2024 14:34
@fiskus fiskus requested a review from Copilot December 24, 2024 14:35

Choose a reason for hiding this comment

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

Copilot reviewed 7 out of 18 changed files in this pull request and generated no comments.

Files not reviewed (11)
  • catalog/app/components/FileEditor/QuiltConfigEditor/BucketPreferences.tsx: Evaluated as low risk
  • catalog/app/utils/BucketPreferences/index.ts: Evaluated as low risk
  • catalog/app/components/FileEditor/QuiltConfigEditor/index.tsx: Evaluated as low risk
  • catalog/CHANGELOG.md: Evaluated as low risk
  • catalog/app/components/FileEditor/loader.spec.ts: Evaluated as low risk
  • catalog/app/components/FileEditor/FileEditor.tsx: Evaluated as low risk
  • docs/Catalog/Preferences.md: Evaluated as low risk
  • catalog/app/components/FileEditor/loader.ts: Evaluated as low risk
  • catalog/app/utils/BucketPreferences/BucketPreferences.ts: Evaluated as low risk
  • catalog/app/components/FileEditor/QuiltConfigEditor/BucketPreferences/index.ts: Evaluated as low risk
  • catalog/app/components/FileEditor/types.ts: Evaluated as low risk
Comments suppressed due to low confidence (4)

catalog/app/components/FileEditor/QuiltConfigEditor/BucketPreferences/State.tsx:44

  • The check for 'typeof json?.ui?.blocks?.meta !== 'undefined'' is redundant because 'json?.ui?.blocks?.meta' is already being checked for truthiness.
typeof json?.ui?.blocks?.meta !== 'undefined' ? !!json?.ui?.blocks?.meta : json?.ui?.blocks?.meta,

catalog/app/components/FileEditor/QuiltConfigEditor/BucketPreferences/State.tsx:27

  • [nitpick] The 'isExpanded' function returns 'false' if 'parent' is 'true' or 'undefined', which might be confusing and could lead to unexpected behavior. Consider clarifying this logic.
if (parent === true || parent === undefined) return false

catalog/app/components/FileEditor/QuiltConfigEditor/BucketPreferences/PackageDescription.tsx:145

  • [nitpick] The variable name 'handlePattern' is ambiguous. It should be renamed to 'packageHandlePattern'.
handlePattern

catalog/app/components/FileEditor/QuiltConfigEditor/BucketPreferences/PackageDescription.tsx:48

  • The error message for invalid JSON paths should be more descriptive.
helperText={error?.message}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant