fix: Improve cleanPath platform compatability

[hyperupcall]

Uses os.homedir() since that works better on non-POSIXy platforms.

I know this code uses old conventions and methods, so if NodeJS version compatability is a concern (even though they have been unsupported for decades), these are when these functions were added to NodeJS:

• os.homedir was added in v2.3.0
• path.join was added in v0.1.16

[PeterDaveHello]

While using os.homedir() indeed improves cross-platform compatibility, I noticed that the introduction of path.join() deviates slightly from the existing style. I'm unsure if this stylistic change was intended for this PR.

Additionally, if path.join() is used, it should accept multiple arguments (e.g., path.join(os.homedir(), path.substr(1))) rather than a single concatenated string.

Let me know your thoughts on this!

[hyperupcall]

Agreed! Embarrassingly, when I first tested these changes I must have forgotten to quote:

$ ./doctoc.js ~/Documents/...

$ ./doctoc.js '~/Documents/...'

I re-ran and it works as expected. I also fixed up the code to allow for using path.join by renaming the parameter in the function. path.join is also more cross platform.

[PeterDaveHello]

Is renaming path to filepath a mistake because it's unrelated to the topic?

[hyperupcall]

Nope it's intentional; I renamed path to filepath because the path parameter in the cleanPath function was shadowing the path variable defined at the top of the file (var path = require('path')). And this caused a bug, since path.join is a function exported from the path module - String.prototype.join() does not exist. A mistake in my testing prevented me from catching this earlier

As I understand both files and folders can be passed to the cleanPath function, maybe you prefer a different rename?

[PeterDaveHello]

Oh, okay, I thought it was about the rewrite of process.env.HOME only, will take a deeper look at it.

[PeterDaveHello]

Hi @hyperupcall,

I rechecked the change, and it looks like the naming change is helpful but out of the platform compatibility scope, so I'll respectfully suggest two solutions:

1. Revert the naming change for now, and once this PR is merged, we can have another pull request to handle it.
2. Keep them in this pull request, but rewrite the subject and description to properly and fully cover the naming issue.

It'll be great to ensure the commit history is clean and clear, not just to help debug and understand the code but also to make sure each change is atomic. So, I'll also encourage you to open an issue for the second change and revise its commit message to mention your thoughts. What do you think?

[PeterDaveHello]

Just a friendly example of how the second commit message might look like:

Rename path parameter to avoid shadowing path module

The path parameter in the cleanPath function was shadowing
the path module imported at the top of the file. This caused
issues when calling path.join(), as it was mistakenly treated
as a string method. Renaming the parameter to filepath resolves
this issue and improves code clarity.

Or a shorter version could be:

Rename path to avoid conflict with path module

Renaming the path parameter to filepath prevents shadowing
the imported path module and fixes related issues.

I hope this could be helpful 😄

[Copilot]

Copilot reviewed 1 out of 1 changed files in this pull request and generated no suggestions.

Comments skipped due to low confidence (1)

doctoc.js:13

• [nitpick] The parameter name 'filepath' should be consistent with the rest of the codebase. Ensure that 'filepath' is the appropriate name and is used consistently.

function cleanPath(filepath) {