Allow customizing start path for manual job resolution

[iffa]

Use case:

We have sidequest.js and sidequest.jobs.js side-by-side in src/. When we run our API, process.cwd is one directory above that -> Sidequest doesn't find sidequest.jobs.js at all. There's currently no way of overriding the default starting point of process.cwd, so I had to patch Sidequest in our repo with the correct starting path to get it working for now.

[GiovaniGuizzo]

Why not putting sidequest.jobs.js in the root of the project?

[iffa]

Only reason is that it would be more work to put together :D

These are actually .ts files and we transpile to JS, so here's what actually happens:

• We have source code under src/
• We transpile everything in src/ to JS, goes under build/

-> If we include sidequest.jobs.ts/sidequest.jobs.js in transpilation, we would have a src dir under build/ unless we do some adjustments / transpile and copy sidequest.jobs.ts separately

[GiovaniGuizzo]

Got it. I think the best option would be to create a config option to provide the sidequest.jobs.js path.
I will work on that when I have the time.

[iffa]

Got it. I think the best option would be to create a config option to provide the sidequest.jobs.js path. I will work on that when I have the time.

Perfect! As said, I already patched the relevant code to suit our project's needs so this is not that important :)

[faizanu94]

Hey folks, I’ve opened a PR #109 to address this.

It adds a paths.start config option so you can point Sidequest directly to a custom sidequest.jobs.js (e.g. when it’s emitted to dist/ or build/).

This keeps the default upward-search behavior, but makes it easier for projects with non-standard layouts or build outputs.

Tests + docs included.

Would appreciate your feedback!

[GiovaniGuizzo]

Hey everyone.

@faizanu94 thanks for our contribution. I have answered your PR. However, your solution wouldn't solve all the issues we are facing.

I created a new PR #111 that solves the issue once and for all. It allows you to provide a relative path like this:

await Sidequest.start({
  manualJobResolution: true,
  jobsFilePath: "./sidequest.jobs.js"
});

This will make Sidequest look for the manual resolution file in the same directory of the script that called Sidequest.start. Relative paths will be resolved in this manner.

This will allow Sidequest to be used in a library that contains the manual resolution file bundled in the lib directories.

[sidequest-release]

🎉 This issue has been resolved in version 1.11.0 🎉

The release is available on:

• v1.11.0
• GitHub release

Your semantic-release bot 📦🚀