feat: support for a custom OpenNext config path

[james-elicx]

Changes

• adds a --openNextConfigPath cli flag that lets you use a custom config path (e.g. if you had a cli that internally called opennext, you could have your own build dir have the config path instead of it leaking out).
• deprecates the --configPath flag for wrangler configs, in favour of --config.
• renames the variable passed around internally to wranglerConfigPath for clarity.

depends on opennextjs/opennextjs-aws#972 for absolute paths.

Note: both --openNextConfigPath and --config treat path starting with / as absolute paths.

outcome of #853

[changeset-bot]

🦋 Changeset detected

Latest commit: 2da636d

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package

Name	Type
@opennextjs/cloudflare	Minor

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

[pkg-pr-new]

Open in StackBlitz

npm i https://pkg.pr.new/@opennextjs/cloudflare@862

commit: 2da636d

[vicb]

Changes look good to me. Thanks!

One question: This PR uses a relative path. Quickly looking at the code, it looks like an absolute path would work. If that is the case, can you please update the code (and maybe aws). If absolute paths do not work, we probably should add a check to fail early.

[vicb]

Let's discuss the open point in opennextjs/opennextjs-aws#972 before we merge this

[vicb]

@james-elicx could you please update the PR description to include:

• dependencies - Is refactor: compileOpenNextConfig now take a path to the config file opennextjs-aws#972 still a dependency needing to be merged/released before we can merge this
• the list of changes in this PR (i.e. support for custom Open Next config path, deprecation of --configPath, anything else?)

We can keep #871 around until we remove --configPath in a coming major release (or close it and create a separate issue)

Thanks!

[james-elicx]

Yes, that's a dependency for absolute paths to work with the cloudflare cli. Updated the PR desc.

[vicb]

@james-elicx I have added a proposal as a fixup commit.

Main changes:

• Added a hack to avoid having to wait for the aws PR to be merged
• Do not offer to create a config file when a custom path is used (assuming it's user error then)

Looking at the comments/changes in compileConfig is probably the best way grasp the changes.

What do you think?

[james-elicx]

• Added a hack to avoid having to wait for the aws PR to be merged

This is why I used to keep asking when we'd get a monorepo :(

Personally, I prefer not adding hacks simply because we're using polyrepos, even if that means it might take longer to ship something.

• Do not offer to create a config file when a custom path is used (assuming it's user error then)

Makes sense, looks fine.

[vicb]

Thanks for working on this James!

This is why I used to keep asking when we'd get a monorepo :(

Personally, I prefer not adding hacks simply because we're using polyrepos, even if that means it might take longer to ship something.

It's not always easy to balance priority across features, fixes, customer wishes, and resources.

The hack is tested and should not be here for long so I think it's safe to merge this for now.

As for the mono-repo, definitely something we should think about before jumping into the Adapters API effort.
It might be the right time.