DEPRECATION: add deprecation warning to this package #225
Conversation
As part of the new formkit release, all old form element repositories are being deprecated.
Reviewer's Guide by SourceryThis pull request adds a deprecation warning to the auro-combobox component and updates the documentation generation process to handle deprecated components. The deprecation warning informs users that the component is no longer supported and directs them to migrate to the new Auro Formkit. Updated class diagram for auro-comboboxclassDiagram
class auro_combobox {
+DEPRECATED
+warningMessage: string
+migrateTo: string
}
note for auro_combobox "This component is deprecated and is no longer supported. Please migrate to the new Auro Formkit."
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
|
Surge demo deployment failed! 😭 |
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hey @DukeFerdinand - I've reviewed your changes and found some issues that need to be addressed.
Blocking issues:
- Unexpected error thrown in promise resolution. (link)
Overall Comments:
- Consider adding a step to the release process that archives the deprecated repo.
- It might be helpful to include the date of deprecation in the warning message.
Here's what I looked at during the review
- 🔴 General issues: 1 blocking issue, 2 other issues
- 🟢 Security: all looks good
- 🟢 Testing: all looks good
- 🟢 Complexity: all looks good
- 🟢 Documentation: all looks good
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
| } from "@aurodesignsystem/auro-library/scripts/utils/sharedFileProcessorUtils.mjs"; | ||
|
|
||
|
|
||
| export const fileConfigs = () => [ |
There was a problem hiding this comment.
issue: Avoid hard-coded absolute paths in fileConfigs.
The file configuration uses absolute paths specific to one developer environment, which could cause issues in other environments or during deployment. Consider switching to relative or configurable paths to improve portability.
| processDocFiles({ overwriteLocalCopies: false }) | ||
| .then(() => { |
There was a problem hiding this comment.
issue (bug_risk): Unexpected error thrown in promise resolution.
After successfully processing document files, the code immediately throws an error ('TESTING ERROR'), which prevents further execution and appears to be leftover debugging. Remove or comment out this error before deploying.
| // setup | ||
| await templateFiller.extractNames(); | ||
|
|
||
| for (const fileConfig of fileConfigs(config)) { |
There was a problem hiding this comment.
suggestion: Unused 'config' parameter in fileConfigs function.
The function fileConfigs is defined without any parameters, yet it is being called with a config argument inside processDocFiles. Either update fileConfigs to accept and utilize the config or remove the parameter from the call.
| for (const fileConfig of fileConfigs(config)) { | |
| for (const fileConfig of fileConfigs()) { |
| throw new Error("TESTING ERROR"); | ||
| Logger.log("Docs processed successfully"); |
There was a problem hiding this comment.
suggestion (code-quality): Remove unreachable code. (remove-unreachable-code)
| throw new Error("TESTING ERROR"); | |
| Logger.log("Docs processed successfully"); | |
| throw new Error("TESTING ERROR"); | |
Explanation
Statements after areturn, break, continue or throw will never be executed.Leaving them in the code confuses the reader, who may believe that these
statements have some effect. They should therefore be removed.
DukeFerdinand
deleted the
deprecations/2025_03_05_add_deprecation_warnings
branch
Resolves AlaskaAirlines/auro-formkit#394, adding deprecation warning to old form element repositories.
Summary by Sourcery
Deprecates the auro-combobox component and adds a warning message to the documentation, advising users to migrate to the new Auro Formkit.
Documentation: