Fix some small pathing issues with new script #88
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
- add preProcessors since api table formatting completely breaks api.md when run after templateReplacer
Reviewer's Guide by SourceryThis PR addresses path handling issues and enhances file processing capabilities in the build scripts. The changes primarily focus on improving path resolution for component roots, adding pre-processing support for file content, and updating the directory path determination method to use ES modules' import.meta.url instead of __dirname. Class diagram for updated AuroLibraryUtils and FileProcessorConfigclassDiagram
class AuroLibraryUtils {
+getDirname() string
+getProjectRootPath string
}
note for AuroLibraryUtils "Updated getDirname to use import.meta.url"
class FileProcessorConfig {
+string|InputFileType input
+string output
+Partial<MarkdownMagicOptions> mdMagicConfig
+Array<(contents: string) => string> preProcessors
+Array<(contents: string) => string> postProcessors
}
note for FileProcessorConfig "Added preProcessors property"
File-Level Changes
Assessment against linked issues
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
![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:
- The move of formatApiTable from postProcessors to preProcessors represents a significant change in processing order. Please document this change and its implications in the PR description.
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.
Apparently it's more "correct" to do it this way :)
|
@sourcery-ai review |
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:
- Bug: preProcessors loop is using postProcessors array (link)
Overall Comments:
- There's a bug in the preProcessors implementation - it's using
postProcessorsarray instead ofpreProcessorsin the loop in processContentForFile - The default parameter was removed from fileConfigs but it's still referenced in the code. Consider keeping the default or updating all callers
Here's what I looked at during the review
- 🔴 General issues: 1 blocking issue
- 🟢 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.
- fixes preprocessor loop using wrong array - use path.join instead of path string concat
DukeFerdinand
force-pushed
the
dhook/fix-small-pathing
branch
from
a562a6f to
ef7ef6f
Compare
|
@sourcery-ai review |
There was a problem hiding this comment.
Hey @DukeFerdinand - I've reviewed your changes - here's some feedback:
Overall Comments:
- The removal of the default parameter in fileConfigs() could be a breaking change if code was relying on those defaults. Consider either keeping the default or documenting this change in the breaking changes section.
Here's what I looked at during the review
- 🟢 General issues: all looks good
- 🟢 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.
sun-mota
requested changes
Nov 6, 2024
This is expected :) it's the main "breaking change" when adopting this new build script |
sun-mota
approved these changes
Nov 6, 2024
There was a problem hiding this comment.
confirmed this works with a change(AlaskaAirlines/auro-flight#140)
|
🎉 This PR is included in version 3.0.1 🎉 The release is available on: Your semantic-release bot 📦🚀 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Alaska Airlines Pull Request
Since we're on a breaking change 3.0.0, there are other non-issues that will completely break your docs build, but these three commits were actually problems in the library :)
Closes #89
Before Submitting this pull request:
Developmentsectionnote: all pull requests require at least one linked ticket
Ready For Review, all ticket's linked underDevelopmentmust have their status changed toReady For Reviewas wellBy submitting this Pull Request, I confirm that my contribution is made under the terms of the Apache 2.0 license and I have performed a self-review of my own update.
Summary by Sourcery
Fix path handling issues in the fromAuroComponentRoot function and enhance file processing capabilities by adding preProcessors. Update AuroLibraryUtils to use import.meta.url for directory path determination.
Bug Fixes:
Enhancements:
Summary by Sourcery
Fix path handling issues in the fromAuroComponentRoot function and enhance file processing capabilities by adding preProcessors. Update AuroLibraryUtils to use import.meta.url for directory path determination.
Bug Fixes:
Enhancements: