-
Notifications
You must be signed in to change notification settings - Fork 1
DEPRECATION: add deprecation warning to this package #281
DEPRECATION: add deprecation warning to this package #281
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-dropdown component and updates the documentation build process to accommodate deprecated components. It also updates the location of the design tokens CSS file. No diagrams generated as the changes look simple and do not need a visual representation. File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
Surge demo deployment failed! 😭 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hey @DukeFerdinand - I've reviewed your changes - here's some feedback:
Overall Comments:
- Consider adding a script to automatically update the auro-design-tokens and webcorestylesheets versions in the README.
- It would be helpful to include a brief explanation of why the component is being deprecated in the README.
Here's what I looked at during the review
- 🟡 General issues: 2 issues found
- 🟢 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.
|
||
processDocFiles({ overwriteLocalCopies: false }) | ||
.then(() => { | ||
throw new Error("TESTING ERROR"); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
issue (bug_risk): Potential leftover test throw in production.
The deliberate error throw in the .then() block appears to be a remnant of a debugging session. This will prevent the normal success log from ever being executed and could lead to confusion in production.
// README.md | ||
{ | ||
identifier: "README.md", | ||
input: "/Users/[email protected]/code/auro/auro-cli/.gitter-temp/multi-git-changer-3406589879/docTemplates/README.md", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
issue (bug_risk): Avoid hard-coded absolute paths in file configurations.
Using hard-coded absolute paths might work in a controlled environment, but these paths could break when the code is run on a different machine or after refactoring the directory structure. Consider using relative paths or external configuration to improve portability.
throw new Error("TESTING ERROR"); | ||
Logger.log("Docs processed successfully"); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Resolves AlaskaAirlines/auro-formkit#394, adding deprecation warning to old form element repositories.
Summary by Sourcery
Adds a deprecation warning to the component and updates the documentation to reflect this change. This includes updating the README, adding a new documentation template, and modifying the build process for documentation.
Enhancements:
Documentation: