fix: Rename path parameter to avoid shadowing path module#319
Open
thompson-tomo wants to merge 2 commits intothlorenz:masterfrom
Open
fix: Rename path parameter to avoid shadowing path module#319thompson-tomo wants to merge 2 commits intothlorenz:masterfrom
thompson-tomo wants to merge 2 commits intothlorenz:masterfrom
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Renames the cleanPath function parameter to avoid shadowing the top-level path module import, improving clarity and unblocking future path.* usage (noted as a precursor to #249).
Changes:
- Renamed
cleanPath(path)parameter tocleanPath(filePath)and updated its internal references.
Comments suppressed due to low confidence (2)
doctoc.js:13
cleanPathexpands~usingprocess.env.HOME, which is unset on some platforms (notably Windows). This can produce paths likeundefined\...when a user passes~...; consider using a cross-platform home lookup (e.g.,os.homedir()or aHOME/USERPROFILEfallback) when expanding~.
function cleanPath(filePath) {
var homeExpanded = (filePath.indexOf('~') === 0) ? process.env.HOME + filePath.substr(1) : filePath;
doctoc.js:12
- PR description mentions
path.join()being blocked, but this file currently doesn't callpath.join()anywhere. Consider updating the PR description to reflect that this rename is primarily a clarity/precursor change rather than fixing an immediate runtime error in this branch.
function cleanPath(filePath) {
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This file contains hidden or 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
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.
The path parameter in the cleanPath function was shadowing the path module imported at the top of the file. This blocks calling path.join(), as currently it is mistakenly treating path as a string method. Renaming the parameter to filepath resolves this issue and improves code clarity.
This is the precursor to #249