This repository was archived by the owner on Mar 7, 2025. It is now read-only.
DEPRECATION: add deprecation warning to this package #382
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-input component and updates the documentation generation process to reflect this change. It introduces a new documentation template and a custom script to handle the generation of documentation for deprecated components. Updated class diagram for deprecatedDocsProcessorclassDiagram
class deprecatedDocsProcessor {
+fileConfigs()
+processDocFiles(config)
}
class fileConfigs {
+identifier: string
+input: string
+output: string
+mdMagicConfig: object
+preProcessors: array
}
deprecatedDocsProcessor -- fileConfigs : 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 more detailed explanation of the deprecation and migration process in the README.
- It might be helpful to include the date of deprecation for better context.
Here's what I looked at during the review
- 🟡 General issues: 3 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.
| // setup | ||
| await templateFiller.extractNames(); | ||
|
|
||
| for (const fileConfig of fileConfigs(config)) { |
There was a problem hiding this comment.
suggestion: Unused configuration parameter in fileConfigs call.
The fileConfigs function does not accept or use any parameter yet you are passing 'config' to it. Consider either removing the parameter from the call or updating fileConfigs to leverage the provided configuration.
Suggested change
| for (const fileConfig of fileConfigs(config)) { | |
| for (const fileConfig of fileConfigs()) { |
| // eslint-disable-next-line no-await-in-loop | ||
| await processContentForFile(fileConfig); | ||
| } catch (err) { | ||
| Logger.error(`Error processing ${fileConfig.identifier}: ${err.message}`); |
There was a problem hiding this comment.
suggestion (bug_risk): Consider propagating errors from file processing.
By catching errors inside the loop and simply logging them, the overall process still resolves as successful. Depending on the intended behavior, you may want the function to reject or accumulate errors so that the build signals failure if any file fails to process.
Suggested change
| Logger.error(`Error processing ${fileConfig.identifier}: ${err.message}`); | |
| Logger.error(`Error processing ${fileConfig.identifier}: ${err.message}`); | |
| throw err; |
|
|
||
| This file is generated based on a template fetched from | ||
| `https://raw.githubusercontent.com/AlaskaAirlines/WC-Generator/master/componentDocs/README_updated_paths.md` | ||
| and copied to `./componentDocs/README.md` each time the the docs are compiled. |
There was a problem hiding this comment.
issue (typo): Typo: "the the"
There seems to be a typo: "the the docs are compiled" should be "the docs are compiled".
Suggested change
| and copied to `./componentDocs/README.md` each time the the docs are compiled. | |
| and copied to `./componentDocs/README.md` each time the docs are compiled. |
rmenner
approved these changes
Mar 7, 2025
|
🎉 This PR is included in version 4.3.4 🎉 The release is available on: Your semantic-release bot 📦🚀 |
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 component and updates the documentation to reflect this change. The component is no longer supported and users are encouraged to migrate to Auro Formkit.
Documentation: