feat: add flat routes convention

[kiliman]

Closes: #4483

• Docs
• Tests

This is the initial PR to add flat routes convention

Testing Strategy:

[changeset-bot]

🦋 Changeset detected

Latest commit: 5811b13

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

This PR includes changesets to release 16 packages

Name	Type
@remix-run/dev	Patch
create-remix	Patch
remix	Patch
@remix-run/architect	Patch
@remix-run/cloudflare	Patch
@remix-run/cloudflare-pages	Patch
@remix-run/cloudflare-workers	Patch
@remix-run/deno	Patch
@remix-run/eslint-config	Patch
@remix-run/express	Patch
@remix-run/netlify	Patch
@remix-run/node	Patch
@remix-run/react	Patch
@remix-run/serve	Patch
@remix-run/server-runtime	Patch
@remix-run/vercel	Patch

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

[kiliman]

Ok, here's my initial PR. I simply copied over my flatRoutes function. I will work on integrating with existing config and updating the tests.

[ryanflorence]

We'll want it behind a future flag, too. Let's go with:

// remix.config.js
{
  future: {
    v2_routeConvention: true
  }
}

Future flags were merged here: #4566

If you run into questions about future flags, reach out to @chaance :)

[machour]

@ryanflorence regarding the flag name, did you reach a conclusion regarding keeping or removing the current convention in V2? (Question raised in the RFC)

We may want to change the flag name to v2_flatRoutesConvention if we keep both.

[kiliman]

@ryanflorence ok so the plan is if the feature flag is true for flat routes, then this will automatically use the flat routes convention instead of the default (i.e., no need to specify the routes config option). Correct?

[ryanflorence]

Let's move forward as if this is the only built-in convention for v2, so let's use v2_routeConvention.

As folks start updating we can revisit if it maybe shouldn't be the only convention, or even the default. I suspect people will prefer it, though.

[kiliman]

Ok, I've pushed the latest version. This also includes the hybrid routes.

I think this gives you the best of both worlds. You can still organize with nested folders, but you also get colocation.

[machour]

@kiliman Tested hybrid routes on 0.5.0, works like a charm 👌🏼 Thank you so much for this.

[mcansh]

closed in favor of #4880 (which includes these commits)