This repository was archived by the owner on Mar 7, 2025. It is now read-only.
DEPRECATION: add deprecation warning to this package #304
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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-datepicker component and updates the documentation generation process to handle deprecated components. It introduces a new documentation template and a custom script to generate documentation that includes the deprecation notice. Updated class diagram for deprecatedDocsProcessorclassDiagram
class processDocFiles{
+config
}
class fileConfigs{
+identifier
+input
+output
+mdMagicConfig
+preProcessors
}
class templateFiller{
+formatApiTable()
+extractNames()
}
class Logger{
+log(message)
+error(message)
}
processDocFiles -- fileConfigs : uses
processDocFiles -- templateFiller : uses
processDocFiles -- Logger : uses
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 - here's some feedback:
Overall Comments:
- Consider adding a script to automatically update the year in the deprecation warning message in
README.mdanddocTemplates/README.md. - It might be helpful to include the date of deprecation in the deprecation warning.
Here's what I looked at during the review
- 🟡 General issues: 1 issue 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.
Comment on lines
+61
to
+65
| processDocFiles({ overwriteLocalCopies: false }) | ||
| .then(() => { | ||
| throw new Error("TESTING ERROR"); | ||
| Logger.log("Docs processed successfully"); | ||
| }) |
There was a problem hiding this comment.
suggestion (bug_risk): Revisit the intentional throwing of a testing error in production code.
The explicit throw of "TESTING ERROR" will always trigger the catch block and may be left over from debugging. Confirm if this behavior is intended or if it should be removed or conditioned on a debug flag.
Suggested change
| processDocFiles({ overwriteLocalCopies: false }) | |
| .then(() => { | |
| throw new Error("TESTING ERROR"); | |
| Logger.log("Docs processed successfully"); | |
| }) | |
| processDocFiles({ overwriteLocalCopies: false }) | |
| .then(() => { | |
| if (process.env.NODE_ENV !== 'production') { | |
| throw new Error("TESTING ERROR"); | |
| } | |
| Logger.log("Docs processed successfully"); | |
| }) |
Comment on lines
+63
to
+64
| 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)
Suggested change
| 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
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Resolves AlaskaAirlines/auro-formkit#394, adding deprecation warning to old form element repositories.
Summary by Sourcery
Adds a deprecation warning to the auro-datepicker component and updates the documentation to reflect its deprecated status. This change informs users that the component is no longer supported and encourages migration to the new Auro Formkit.
Documentation: