Skip to content

fix(cli): create output directory if it doesn't exist#1445

Merged
josephjclark merged 1 commit into
OpenFn:lamine-1from
lamine2000:fix/output-path-mkdir-859
Jun 9, 2026
Merged

fix(cli): create output directory if it doesn't exist#1445
josephjclark merged 1 commit into
OpenFn:lamine-1from
lamine2000:fix/output-path-mkdir-859

Conversation

@lamine2000

@lamine2000 lamine2000 commented Jun 5, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

Summary

Fixes #859. The compile and collections get commands threw ENOENT when --output-path pointed to a directory that hadn't been created yet, forcing users to manually mkdir before running the CLI.

  • compile/handler.ts: added await mkdir(dirname(outputPath), { recursive: true }) before writeFile
  • collections/handler.ts: same fix in the get command's output branch

The execute command's serialize-output.ts already had this pattern — this PR brings the other two commands in line with it.

Test plan

  • openfn compile job.js -o new/nested/dir/out.js — should create new/nested/dir/ and write the file
  • openfn collections get myCollection myKey -o new/nested/dir/out.json — same
  • Both commands still work normally when the output directory already exists

Closes #859

@josephjclark

josephjclark commented Jun 5, 2026

Copy link
Copy Markdown
Collaborator

Thanks @lamine2000 . There's a failing test here that needs resolving. Also this branch includes your other work. Please rebase against main so that this PR is nice and clean. Thank you!

@lamine2000
fix(cli): create output directory if it doesn't exist
5686653 
The compile and collections commands threw ENOENT when --output-path
pointed to a directory that hadn't been created yet. Add
mkdir({ recursive: true }) before writeFile in both handlers, matching
the pattern already used in the execute command's serialize-output.ts.

Fixes OpenFn#859
@lamine2000 lamine2000 force-pushed the fix/output-path-mkdir-859 branch from e34452a to 5686653 Compare June 6, 2026 09:16
@josephjclark josephjclark changed the base branch from main to release/next June 9, 2026 14:56
@josephjclark josephjclark changed the base branch from release/next to main June 9, 2026 14:57
@josephjclark josephjclark changed the base branch from main to lamine-1 June 9, 2026 14:59
josephjclark
josephjclark approved these changes Jun 9, 2026
View reviewed changes

@josephjclark josephjclark left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @lamine2000 !

@josephjclark josephjclark merged commit 56ab757 into OpenFn:lamine-1 Jun 9, 2026
7 checks passed
josephjclark pushed a commit that referenced this pull request Jun 9, 2026
@lamine2000 @josephjclark
fix(cli): create output directory if it doesn't exist (#1445)
7e748b1 
The compile and collections commands threw ENOENT when --output-path
pointed to a directory that hadn't been created yet. Add
mkdir({ recursive: true }) before writeFile in both handlers, matching
the pattern already used in the execute command's serialize-output.ts.

Fixes #859
josephjclark pushed a commit that referenced this pull request Jun 9, 2026
@lamine2000 @josephjclark
fix(cli): create output directory if it doesn't exist (#1445)
704cc13 
The compile and collections commands threw ENOENT when --output-path
pointed to a directory that hadn't been created yet. Add
mkdir({ recursive: true }) before writeFile in both handlers, matching
the pattern already used in the execute command's serialize-output.ts.

Fixes #859
josephjclark added a commit that referenced this pull request Jun 9, 2026
@josephjclark @lamine2000
create output directory if it doesn't exist (#1452)
a3cf6e8 
* fix(cli): create output directory if it doesn't exist (#1445)

The compile and collections commands threw ENOENT when --output-path
pointed to a directory that hadn't been created yet. Add
mkdir({ recursive: true }) before writeFile in both handlers, matching
the pattern already used in the execute command's serialize-output.ts.

Fixes #859

* changeset

---------

Co-authored-by: Lamine Gueye <[email protected]>
josephjclark added a commit that referenced this pull request Jun 9, 2026
@josephjclark @lamine2000
create output directory if it doesn't exist (#1452)
8180b70 
* fix(cli): create output directory if it doesn't exist (#1445)

The compile and collections commands threw ENOENT when --output-path
pointed to a directory that hadn't been created yet. Add
mkdir({ recursive: true }) before writeFile in both handlers, matching
the pattern already used in the execute command's serialize-output.ts.

Fixes #859

* changeset

---------

Co-authored-by: Lamine Gueye <[email protected]>
josephjclark added a commit that referenced this pull request Jun 9, 2026
@josephjclark @lamine2000
@claude @doc-han
Release/next (#1454)
89a41ed 
* create output directory if it doesn't exist (#1452)

* fix(cli): create output directory if it doesn't exist (#1445)

The compile and collections commands threw ENOENT when --output-path
pointed to a directory that hadn't been created yet. Add
mkdir({ recursive: true }) before writeFile in both handlers, matching
the pattern already used in the execute command's serialize-output.ts.

Fixes #859

* changeset

---------

Co-authored-by: Lamine Gueye <[email protected]>

* Fix gitignore cache (#1453)

* fix(cli): fix cache .gitignore written to fs root and undefined workflow name (#1444)

* fix(cli): fix cache .gitignore written to fs root and undefined workflow name

- Replace ensureGitIgnore path-walking logic with a direct getCacheRoot
  helper. The old loop used endsWith('.cli-cache') to find the cache
  root, but if the path never contained that segment (custom cachePath)
  it would walk all the way to '/' and write /.gitignore
- Fall back to 'workflow' when plan.workflow.name is undefined, avoiding
  .cli-cache/undefined directories
- Add cachePath to saveToCache/clearCache options types so custom cache
  paths set by workspace projects are correctly forwarded to getCachePath
- Remove spurious await on the now-synchronous getCachePath call
- Add regression tests covering expressionPath + cacheSteps (the exact
  scenario reported in #669, which had no test coverage)

Fixes #669

* fix test: use correct cache subdir name derived from filename

* refactor(cli): address review feedback on cache fix

- Eliminate getCacheRoot helper: getCachePath(options) with no
  workflowName/stepId already returns the CACHE_DIR root naturally
- Use .filter(Boolean) spread into path.resolve so undefined workflowName
  does not cause ERR_INVALID_ARG_TYPE (path.resolve throws on undefined)
- Keep cachePath in saveToCache/clearCache Pick types so custom paths work
- Rename gitignore test name to be more accurate

Co-Authored-By: Claude Sonnet 4.6 <[email protected]>

* style(cli): fix prettier formatting

Co-Authored-By: Claude Sonnet 4.6 <[email protected]>

* Revert "style(cli): fix prettier formatting"

This reverts commit 1e47fad.

* style(cli): fix prettier v2 formatting

Co-Authored-By: Claude Sonnet 4.6 <[email protected]>

* refactor(cli): simplify workflowName fallback per review

Use workflowName ?? '' instead of .filter(Boolean) spread.
path.resolve treats '' as a no-op so undefined workflowName
still resolves to the bare CACHE_DIR root.

Co-Authored-By: Claude Sonnet 4.6 <[email protected]>

---------

Co-authored-by: Claude Sonnet 4.6 <[email protected]>

* clean up test

* changeset

* tidying up

* typing

---------

Co-authored-by: Lamine Gueye <[email protected]>
Co-authored-by: Claude Sonnet 4.6 <[email protected]>

* Merge & Sync improvements (#1450)

* CLI: add --workflows flag to merge and deploy (#1437)

* add --workflows flag

* rename --workflows to --workflow and alias

* changelog

* update tests

* format

* mock: fix an issue where project obejts can get scribbed on

* fix tests

* update integration tests

* improve error messages for invalid workspace

* better diverence message

* Fix incorrect divergence warnings on checkout (#1446)

* improve error messages for invalid workspace

* better diverence message

* add failing test and notes

* project: set the alias on a checked out project

* fix divergence on checkout

* fixes for tests

* fix tests and enable project alias to be null

* update tests

* update more tests

* relax alias lookup to fix tests

* when merging, force-checkout the result

* remove comment

* types

* fix one more test

* update test

* hide merge command

* chore: ignore sentry errors by regexp (#1440)

* feat: ignore sentry errors by regexp

* chore: remove debug

* feat: add severity override to ignored errors

* changeset

---------

Co-authored-by: Joe Clark <[email protected]>

* versions

---------

Co-authored-by: Lamine Gueye <[email protected]>
Co-authored-by: Claude Sonnet 4.6 <[email protected]>
Co-authored-by: Farhan Y. <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@josephjclark josephjclark josephjclark approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

CLI: don't throw if output path doesn't exist

2 participants

@lamine2000 @josephjclark