feat(remix-dev): flat routes #4880

mcansh · 2022-12-15T17:56:09Z

note: this test is currently failing, but i believe that the "expected" result is actually wrong and should actually be ":$dollabills?/.lol?/what?/$?/*", so i think we have a bug in defineConventionalRoutes where this test originated from.

Closes: #

Docs
Tests

Testing Strategy:

tests and yarn playground:new

changeset-bot · 2022-12-15T17:56:11Z

🦋 Changeset detected

Latest commit: 3f3129e

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

This PR includes changesets to release 17 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/testing	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

Hmm.. the .route suffix is actually in the original spec. Is there a reason this is removed?

kiliman

Hmm.. a lot of the code there was to make it easier to keep the enhanced version in sync with the core one. I think the enhancements will be a good proving ground for including in future core. By stripping all that out, I think it's going to be more difficult to extend in the future.

Closes #4483

Integrates flat routes function into config

Oops!

Signed-off-by: Logan McAnsh <logan@mcan.sh>

Signed-off-by: Logan McAnsh <logan@mcan.sh> chore: use invariant instead of enforcing the type Signed-off-by: Logan McAnsh <logan@mcan.sh> chore: use for...of Signed-off-by: Logan McAnsh <logan@mcan.sh> chore: remove .route Signed-off-by: Logan McAnsh <logan@mcan.sh> chore: use _index for index routes Signed-off-by: Logan McAnsh <logan@mcan.sh> chore: replace magic characters with defined variable Signed-off-by: Logan McAnsh <logan@mcan.sh> fix: update default parentRoutePath Signed-off-by: Logan McAnsh <logan@mcan.sh> test: add test cases from old route convention Signed-off-by: Logan McAnsh <logan@mcan.sh> chore: update handling of special characters Signed-off-by: Logan McAnsh <logan@mcan.sh> chore: export route convention helpers Signed-off-by: Logan McAnsh <logan@mcan.sh> chore(flat-routes): add support for optional and escape route segments Signed-off-by: Logan McAnsh <logan@mcan.sh> chore(flat-routes): add support for optional and escape route segments Signed-off-by: Logan McAnsh <logan@mcan.sh>

Signed-off-by: Logan McAnsh <logan@mcan.sh>

pcattori · 2022-12-22T16:09:13Z

note: this test is currently failing, but i believe that the "expected" result is actually wrong and should actually be ":$dollabills?/.lol?/what?/$?/*", so i think we have a bug in defineConventionalRoutes where this test originated from.

@mcansh I has the same confusion, but I think its actually correct. But its very unintuitive. I'm thinking that we'll probably want to rethink how some of this stuff works at some point to align with intuitions a bit better.

packages/remix-dev/config/flat-routes.ts

Signed-off-by: Logan McAnsh <logan@mcan.sh>

Co-authored-by: Pedro Cattori <pcattori@gmail.com> Signed-off-by: Logan McAnsh <logan@mcan.sh>

Signed-off-by: Logan McAnsh <logan@mcan.sh>

packages/remix-dev/config/flat-routes.ts

Signed-off-by: Logan McAnsh <logan@mcan.sh>

Co-authored-by: Pedro Cattori <pcattori@gmail.com>

packages/remix-dev/config/flat-routes.ts

Co-authored-by: Pedro Cattori <pcattori@gmail.com> Signed-off-by: Logan McAnsh <logan@mcan.sh>

pcattori · 2023-01-05T16:55:28Z

packages/remix-dev/__tests__/defineRoutes-test.ts

-          "parentId": undefined,
+          "parentId": "root",


We should double-check that parentId wasn't intentionally undefined for some reason. Like does parentId get surfaced in the route meta that is available to users? Do users rely on it being undefined? Or is this value solely used for defining routes internally?

Signed-off-by: Logan McAnsh <logan@mcan.sh>

packages/remix-dev/__tests__/flat-routes-test.ts

Signed-off-by: Logan McAnsh <logan@mcan.sh>

packages/remix-dev/__tests__/flat-routes-test.ts

Signed-off-by: Logan McAnsh <logan@mcan.sh>

github-actions · 2023-01-06T07:07:57Z

🤖 Hello there,

We just published version v0.0.0-nightly-45d4491-20230106 which includes this pull request. If you'd like to take it for a test run please try it out and let us know what you think!

Thanks!

manzano78 · 2023-01-08T07:28:54Z

Hey! I tried the nightly release which includes this PR and I think I found an issue, based on the following file structure:

routes/
  app/
      _index.tsx
      primary-nav.tsx
      footer.tsx

footer.tsx exports a default component.

What looks wrong to me is that I can see this footer directly on screen by hitting /app/footer in the URL bar.
But if I understand the principles, only _index.tsx should be treated as a route module, right?

Before you ask, I did activate the future flag :)

kiliman · 2023-01-08T19:26:41Z

@manzano78 You should probably create a new issue instead of commenting on a closed PR.

Anyway, yes. If you are using flat-folders convention (where routes are folder names instead of filenames), then _index.tsx should be treated as the route and everything else as colocated files.

Can you run npx remix routes and paste the result? Please do so in another issue and reference this comment.

Thanks!

remix-cla-bot bot added the CLA Signed label Dec 15, 2022

kiliman reviewed Dec 15, 2022

View reviewed changes

MichaelDeBoey added the package:dev label Dec 15, 2022

mcansh mentioned this pull request Dec 20, 2022

🗺 Flat Routes #4483

Closed

3 tasks

mcansh force-pushed the logan/flat-routes branch from 7e579db to d08c0c0 Compare December 20, 2022 21:41

kiliman and others added 5 commits December 20, 2022 17:12

feat: add flat routes convention

45e1669

Closes #4483

chore: include future v2_routeConvention flag

2a0c205

Integrates flat routes function into config

fix: update readConfig test to include new v2_routeConvention flag

7e08ddb

fix: replace default route dir

30319da

Oops!

chore: slim

c330861

Signed-off-by: Logan McAnsh <logan@mcan.sh>

mcansh force-pushed the logan/flat-routes branch from eeb06f3 to 31450e1 Compare December 20, 2022 22:12

mcansh added 2 commits December 20, 2022 17:21

chore(flat-routes): add support for optional and escape route segments

50a4393

Signed-off-by: Logan McAnsh <logan@mcan.sh>

mcansh force-pushed the logan/flat-routes branch from 31450e1 to 50a4393 Compare December 20, 2022 22:22

mcansh added 7 commits December 21, 2022 17:30

initial import

c525b4c

Signed-off-by: Logan McAnsh <logan@mcan.sh>

chore: index routes use underscores

ba964ae

Signed-off-by: Logan McAnsh <logan@mcan.sh>

feat: add support for optional segments

459030c

Signed-off-by: Logan McAnsh <logan@mcan.sh>

chore: flat routes

1db590d

Signed-off-by: Logan McAnsh <logan@mcan.sh>

feat: nested escaping inside optional

c1df59d

Signed-off-by: Logan McAnsh <logan@mcan.sh>

chore: remove TODO comment

f6a3f94

Signed-off-by: Logan McAnsh <logan@mcan.sh>

feat: handle opting out of parent layout, but keeping url segment

434836f

Signed-off-by: Logan McAnsh <logan@mcan.sh>

pcattori reviewed Dec 22, 2022

View reviewed changes

packages/remix-dev/config/flat-routes.ts Outdated Show resolved Hide resolved

packages/remix-dev/config/flat-routes.ts Show resolved Hide resolved

mcansh added 5 commits December 22, 2022 11:45

chore: use isSegmentSeparator to account for windows paths

940d794

Signed-off-by: Logan McAnsh <logan@mcan.sh>

chore: helpers no longer need to be exported from routesConvention

fae3dfa

Signed-off-by: Logan McAnsh <logan@mcan.sh>

chore: don't return separators from getRouteSegments

a4b0b35

Signed-off-by: Logan McAnsh <logan@mcan.sh>

chore: rename test

bf0ba0a

Signed-off-by: Logan McAnsh <logan@mcan.sh>

chore: don't treat escaped separator as new segment

e64fe6a

Signed-off-by: Logan McAnsh <logan@mcan.sh>

mcansh and others added 3 commits January 5, 2023 11:40

chore: remove comment

0a8edbf

Signed-off-by: Logan McAnsh <logan@mcan.sh>

chore: remove unnecessary else block

7b54735

Co-authored-by: Pedro Cattori <pcattori@gmail.com> Signed-off-by: Logan McAnsh <logan@mcan.sh>

test: update defineRoutes test per 4779e24

be8f00c

Signed-off-by: Logan McAnsh <logan@mcan.sh>

pcattori reviewed Jan 5, 2023

View reviewed changes

packages/remix-dev/config/flat-routes.ts Outdated Show resolved Hide resolved

pcattori reviewed Jan 5, 2023

View reviewed changes

packages/remix-dev/config/flat-routes.ts Outdated Show resolved Hide resolved

mcansh and others added 2 commits January 5, 2023 11:50

chore: add brief description of what each state/substate means

4c9d619

Signed-off-by: Logan McAnsh <logan@mcan.sh>

chore: remove nesting via early return

f521c20

Co-authored-by: Pedro Cattori <pcattori@gmail.com>

pcattori reviewed Jan 5, 2023

View reviewed changes

packages/remix-dev/config/flat-routes.ts Outdated Show resolved Hide resolved

chore: condense state/substate

758a90a

Co-authored-by: Pedro Cattori <pcattori@gmail.com> Signed-off-by: Logan McAnsh <logan@mcan.sh>

pcattori reviewed Jan 5, 2023

View reviewed changes

chore: update routePaths to account for folders

f6e2615

Signed-off-by: Logan McAnsh <logan@mcan.sh>

pcattori approved these changes Jan 5, 2023

View reviewed changes

pcattori reviewed Jan 5, 2023

View reviewed changes

packages/remix-dev/__tests__/flat-routes-test.ts Outdated Show resolved Hide resolved

mcansh added 2 commits January 5, 2023 13:39

chore: error when escaping : or *

d54ba0f

Signed-off-by: Logan McAnsh <logan@mcan.sh>

chore: remove console.log

c4955a6

Signed-off-by: Logan McAnsh <logan@mcan.sh>

pcattori reviewed Jan 5, 2023

View reviewed changes

packages/remix-dev/__tests__/flat-routes-test.ts Outdated Show resolved Hide resolved

mcansh added 3 commits January 5, 2023 13:51

chore: include routeId in error message

7515c19

Signed-off-by: Logan McAnsh <logan@mcan.sh>

chore: error when using : or *, not just escaping

df340a4

Signed-off-by: Logan McAnsh <logan@mcan.sh>

chore: normalize error messages, move tests to getRouteSegments

3f3129e

Signed-off-by: Logan McAnsh <logan@mcan.sh>

pcattori approved these changes Jan 5, 2023

View reviewed changes

mcansh merged commit 561796a into dev Jan 5, 2023

mcansh deleted the logan/flat-routes branch January 5, 2023 20:25

github-actions bot added the awaiting release This issue has been fixed and will be released soon label Jan 5, 2023

mcansh mentioned this pull request Jan 6, 2023

feat: add flat routes convention #4716

Closed

2 tasks

manzano78 mentioned this pull request Jan 9, 2023

Flatten route folders should not consider colocated files as routes #5028

Closed

This was referenced Jan 13, 2023

chore: Update version for release (pre) #5097

Merged

chore: Update version for release #5135

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(remix-dev): flat routes #4880

feat(remix-dev): flat routes #4880

mcansh commented Dec 15, 2022 •

edited

Loading

changeset-bot bot commented Dec 15, 2022 •

edited

Loading

kiliman left a comment

kiliman left a comment

pcattori commented Dec 22, 2022 •

edited

Loading

pcattori Jan 5, 2023

github-actions bot commented Jan 6, 2023

manzano78 commented Jan 8, 2023

kiliman commented Jan 8, 2023

feat(remix-dev): flat routes #4880

feat(remix-dev): flat routes #4880

Conversation

mcansh commented Dec 15, 2022 • edited Loading

changeset-bot bot commented Dec 15, 2022 • edited Loading

🦋 Changeset detected

kiliman left a comment

Choose a reason for hiding this comment

kiliman left a comment

Choose a reason for hiding this comment

pcattori commented Dec 22, 2022 • edited Loading

pcattori Jan 5, 2023

Choose a reason for hiding this comment

github-actions bot commented Jan 6, 2023

manzano78 commented Jan 8, 2023

kiliman commented Jan 8, 2023

mcansh commented Dec 15, 2022 •

edited

Loading

changeset-bot bot commented Dec 15, 2022 •

edited

Loading

pcattori commented Dec 22, 2022 •

edited

Loading