chore: Refactor library to use smaller modules #91
Conversation
The `index.js` file got pretty big over time. This commit splits it into smaller modules: - The core logic remains in `index.js` - The `munge` functions are moved to the `lib/munge` directory. Each module detects and wraps one kind of target. - Helper functions are moved out of `index.js` to the `lib` directory Using multiple modules instead of a single `index.js` enables easier future extensions.
| const osHomedir = require('os-homedir') | ||
|
|
||
| const home = process.env.SPAWN_WRAP_SHIM_ROOT || osHomedir() | ||
| const homedir = home + '/.node-spawn-wrap-' |
| } | ||
|
|
||
| let npmPath = whichOrUndefined('npm') || 'npm' | ||
| npmPath = path.dirname(npmPath) + '\\node_modules\\npm\\bin\\npm-cli.js' |
There was a problem hiding this comment.
Would love to eliminate path concatenation, use path.join instead. Again this can be a follow-up, I know what's here is just a straight move from index.js.
| } | ||
|
|
||
| if (hasMain) { | ||
| const replace = workingDir + '/' + command |
| options.originalNode = shebangbin | ||
| options.basename = maybeNode | ||
| options.file = shebangbin | ||
| options.args = [shebangbin, workingDir + '/' + maybeNode] |
|
Oh @demurgos if you make these changes please just add a commit, I will squash when I do the merge. This will make it easier for me to re-review. |
|
Thanks for the reviews. I'll address the comments tomorrow (moving let, fixing Edit: I'm not sure if I'll have time this week-end, but I'll try to address your comments. |
|
force-pushing is fine for the smaller PR's. |
| if (!IS_DEBUG) { | ||
| return; | ||
| } | ||
| const prefix = 'SW ' + process.pid + ': ' |
This commit inlines the `KNOWN_SHELLS` constant inside `isSh` and uses a simple array instead of a set.
In debug mode, the shim directory is not cleaned-up but the `signalExit` handler is still passed. This commit simplifies the code by avoiding to attach the handler altogether when it has no effect.
|
I fixed most of the comments relative to minor issues. I'll leave replacing string concatenation with dedicated functions to a follow-up PR because it is an important topic. I think that this PR can be merged as-is. You can squash the commits or simply rebase (each one is a self-contained minor fix) |
|
For semantic versioning I think this will need to be squashed into the chore commit. But thanks @demurgos! I'll take a closer look soon! |
There was a problem hiding this comment.
👍
I'll leave the merge and release to @bcoe or @coreyfarrell
The
index.jsfile got pretty big over time. This commit splits it into smaller modules:index.jsmungefunctions are moved to thelib/mungedirectory. Each module detects and wraps one kind of target.index.jsto thelibdirectoryUsing multiple modules instead of a single
index.jsenables easier future extensions.