OpenFn / OpenFn/kit

describe-package: update the watch command

Open
#305 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

tech debt
Dominant language
TypeScript
Stars
21
Forks
23
Avg merge
1d 22h
Merged PRs (30d)
17

Description

Having updated esbuild to v18, the watched build in describe-package has broken.

This isn't a problem immediately and isn't worth my time to address right now. It's slightly complicated because there are two bundles which need to get built.

But when we next work on describe-package (and a bit stretch of work has got to be coming up), one of the first jobs will be to update the watch.

See this migration guide from esbuild: https://github.com/evanw/esbuild/blob/main/CHANGELOG.md#0170

Note that we used to have a build:watch, which simply passed an argument called "watch" into the script, which triggered watch mode.

const watch = process.argv[2] === 'watch' ? watchOptions : false;

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the describe-package build:watch entry point and the esbuild migration guide linked in the issue. Trace how watchOptions is selected and how the two bundles are built; done means the watch command works again for both bundles after the esbuild v18 update.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
build-system
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.