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.

Sign up for GitHub

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

build(charts): compatible with the old version of charts chart introd… #2327

Merged
merged 1 commit into from
Oct 21, 2024
Merged

build(charts): compatible with the old version of charts chart introd… #2327

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 16 additions & 2 deletions internals/cli/src/commands/build/build-entry-app.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -149,10 +149,24 @@ const buildFullRuntime = (mode: RunTimeModeType) => {
include: includeTemplate.join(endOfLine),
components: componentsTemplate.join(',' + endOfLine),
exportComponents: componentsTemplate
.map((component) => `${component}${joinStr}${component} as Tiny${component.trim()}`)
.map((component) => {
if (component.includes('Hui')) {
return `${component}${joinStr}${component} as ${component
.replace('Huicharts', 'Charts')
.trim()}${joinStr}${component} as Tiny${component.trim()}`
Comment on lines +153 to +156
Copy link

Choose a reason for hiding this comment

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

⚠️ Potential issue

Fix the inconsistency between the condition and the replacement

The condition component.includes('Hui') checks for 'Hui', but the replacement targets 'Huicharts'. If a component includes 'Hui' but not 'Huicharts', the replacement will not be effective.

To ensure the replacement works as intended, consider aligning the condition and the replacement string.

Option 1: Change the condition to check for 'Huicharts':

- if (component.includes('Hui')) {
+ if (component.includes('Huicharts')) {

Option 2: Modify the replacement string to replace 'Hui' with 'Charts':

- .replace('Huicharts', 'Charts')
+ .replace('Hui', 'Charts')

Please verify which option matches the desired behavior.

Committable suggestion was skipped due to low confidence.

}
return `${component}${joinStr}${component} as Tiny${component.trim()}`
})
.join(joinStr),
defaultComponents: componentsTemplate
.map((component) => `${component}${joinStr}Tiny${component.trim()}: ${component}`)
.map((component) => {
if (component.includes('Hui')) {
return `${component}${joinStr}${component
.replace('Huicharts', 'Charts')
.trim()}: ${component}${joinStr}Tiny${component.trim()}: ${component}`
Comment on lines +163 to +166
Copy link

Choose a reason for hiding this comment

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

⚠️ Potential issue

Fix the inconsistency between the condition and the replacement

The same inconsistency exists here in the defaultComponents mapping. The condition checks for 'Hui', but the replacement targets 'Huicharts'. This could lead to the replacement not functioning as intended.

Apply the same fix as suggested earlier to ensure consistency:

Option 1:

- if (component.includes('Hui')) {
+ if (component.includes('Huicharts')) {

Option 2:

- .replace('Huicharts', 'Charts')
+ .replace('Hui', 'Charts')

Confirm which option aligns with the intended functionality.

Committable suggestion was skipped due to low confidence.

}
return `${component}${joinStr}Tiny${component.trim()}: ${component}`
})
.join(joinStr)
}
})
Expand Down
18 changes: 16 additions & 2 deletions internals/cli/src/commands/build/build-entry.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,10 +100,24 @@ const createEntry = (mode) => {
include: includeTemplate.join(endOfLine),
components: componentsTemplate.join(joinStr),
exportComponents: componentsTemplate
.map((component) => `${component}${joinStr}${component} as Tiny${component.trim()}`)
.map((component) => {
if (component.includes('Hui')) {
return `${component}${joinStr}${component} as ${component
.replace('Huicharts', 'Charts')
.trim()}${joinStr}${component} as Tiny${component.trim()}`
}
return `${component}${joinStr}${component} as Tiny${component.trim()}`
})
Comment on lines +103 to +110
Copy link

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

Consider refactoring to reduce code duplication

The mapping logic in both exportComponents and defaultComponents is quite similar. To enhance maintainability and reduce repetition, consider extracting the conditional mapping into a helper function.

Example:

function mapComponent(component) {
  if (component.includes('Huicharts')) {
    const replacedComponent = component.replace('Huicharts', 'Charts').trim()
    return {
      exportMapping: `${component}${joinStr}${component} as ${replacedComponent}${joinStr}${component} as Tiny${component.trim()}`,
      defaultMapping: `${component}${joinStr}${replacedComponent}: ${component}${joinStr}Tiny${component.trim()}: ${component}`
    }
  }
  return {
    exportMapping: `${component}${joinStr}${component} as Tiny${component.trim()}`,
    defaultMapping: `${component}${joinStr}Tiny${component.trim()}: ${component}`
  }
}

Then apply this function within your mappings:

exportComponents: componentsTemplate
  .map((component) => mapComponent(component).exportMapping)
  .join(joinStr),
defaultComponents: componentsTemplate
  .map((component) => mapComponent(component).defaultMapping)
  .join(joinStr),

This refactoring will make the code cleaner and easier to maintain.

Also applies to: 113-120

⚠️ Potential issue

Potential issue with component name replacement logic

The condition component.includes('Hui') may match component names that include 'Hui' but are not specifically 'Huicharts'. However, the replacement only targets 'Huicharts' by replacing it with 'Charts'. This could lead to situations where the condition is true, but the replacement does nothing, potentially causing incorrect export mappings.

Consider refining the condition to specifically check for 'Huicharts' instead of 'Hui', or adjust the replacement logic to handle all relevant component names.

Potential fix:

.map((component) => {
-  if (component.includes('Hui')) {
+  if (component.includes('Huicharts')) {
     return `${component}${joinStr}${component.replace('Huicharts', 'Charts').trim()}${joinStr}${component} as Tiny${component.trim()}`
   }
   return `${component}${joinStr}${component} as Tiny${component.trim()}`
 })

Alternatively, if multiple component names include 'Hui' and require similar handling, ensure that both the condition and the replacement logic are aligned.

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
.map((component) => {
if (component.includes('Hui')) {
return `${component}${joinStr}${component} as ${component
.replace('Huicharts', 'Charts')
.trim()}${joinStr}${component} as Tiny${component.trim()}`
}
return `${component}${joinStr}${component} as Tiny${component.trim()}`
})
.map((component) => {
if (component.includes('Huicharts')) {
return `${component}${joinStr}${component.replace('Huicharts', 'Charts').trim()}${joinStr}${component} as Tiny${component.trim()}`
}
return `${component}${joinStr}${component} as Tiny${component.trim()}`
})

.join(joinStr),
defaultComponents: componentsTemplate
.map((component) => `${component}${joinStr}Tiny${component.trim()}: ${component}`)
.map((component) => {
if (component.includes('Hui')) {
return `${component}${joinStr}${component
.replace('Huicharts', 'Charts')
.trim()}: ${component}${joinStr}Tiny${component.trim()}: ${component}`
}
return `${component}${joinStr}Tiny${component.trim()}: ${component}`
})
Comment on lines +113 to +120
Copy link

Choose a reason for hiding this comment

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

⚠️ Potential issue

Potential issue with component name replacement in default components

Similarly, in the defaultComponents mapping, the condition component.includes('Hui') might match component names that contain 'Hui' but not 'Huicharts'. Since the replacement only affects 'Huicharts', this may result in incorrect default component mappings when the component name includes 'Hui' but does not contain 'Huicharts'.

Consider refining the condition or the replacement logic to ensure consistent and correct component mappings.

Potential fix:

.map((component) => {
-  if (component.includes('Hui')) {
+  if (component.includes('Huicharts')) {
     return `${component}${joinStr}${component.replace('Huicharts', 'Charts').trim()}: ${component}${joinStr}Tiny${component.trim()}: ${component}`
   }
   return `${component}${joinStr}Tiny${component.trim()}: ${component}`
 })
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
.map((component) => {
if (component.includes('Hui')) {
return `${component}${joinStr}${component
.replace('Huicharts', 'Charts')
.trim()}: ${component}${joinStr}Tiny${component.trim()}: ${component}`
}
return `${component}${joinStr}Tiny${component.trim()}: ${component}`
})
.map((component) => {
if (component.includes('Huicharts')) {
return `${component}${joinStr}${component
.replace('Huicharts', 'Charts')
.trim()}: ${component}${joinStr}Tiny${component.trim()}: ${component}`
}
return `${component}${joinStr}Tiny${component.trim()}: ${component}`
})

.join(joinStr)
}
})
Expand Down
Loading