fix: ensure output directory exists before running generators #234
Conversation
src/generators.mjs
Outdated
| } | ||
| } catch (err) { | ||
| if (err.code === 'ENOENT') { | ||
| mkdirSync(extra.output, { recursive: true }); |
There was a problem hiding this comment.
I would think that the expected behavior would be to create a directory if it does not exist.
bjohansebas
force-pushed
the
ensure-directory
branch
from
83653d8 to
06cef1f
Compare
|
I don’t think we should do this. The process will error anyways if the path is wrong or not a directory. |
|
You're right about when it's not a directory, but creating the directory would be fine when it doesn't exist. WDYT? |
Contrarily, I feel like when I pass a directory as the output, it should be created if it doesn't exist. This is the behavior of many other tools, for example, |
| } catch (err) { | ||
| if (err.code === 'ENOENT') { | ||
| mkdir(extra.output, { recursive: true }); | ||
| } |
There was a problem hiding this comment.
| } | |
| } else throw err; |
We should probably not swallow the error in other cases
I believe we should avoid handling directory creation ourselves. There are several potential issues, such as lacking directory creation permissions or the need to create directories recursively. These complexities can lead to complications that may not be worth addressing. Ultimately, the users of this tool are likely to be tech-savvy individuals who will understand any errors that arise and can address them accordingly. After all, this tool is intended for Node.js collaborators rather than end-users. That's just my perspective :) |
|
Just to clarify, if you rebase to include the latest changes, will this error out if no output is specified? |
| @@ -51,6 +52,16 @@ const createGenerator = markdownInput => { | |||
| * @param {import('./generators/types.d.ts').GeneratorOptions} options The options for the generator runtime | |||
| */ | |||
| const runGenerators = async ({ generators, ...extra }) => { | |||
| try { | |||
There was a problem hiding this comment.
I do believe at the very least this code should live somewhere else, and not here.
While testing this, I realized that there is no verification when --output is a file or does not exist.