Skip to content

Commit 81ca545

Browse files
committed
fix: rename next to remix
1 parent 7dece0e commit 81ca545

File tree

125 files changed

+353
-353
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

125 files changed

+353
-353
lines changed

Diff for: .github/workflows/nightly.yml

+13-13
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ jobs:
2424
runs-on: ubuntu-latest
2525
outputs:
2626
# allows this to be used in the `comment` job below - will be undefined if there's no release necessary
27-
NEXT_VERSION: ${{ steps.version.outputs.NEXT_VERSION }}
27+
REMIX_VERSION: ${{ steps.version.outputs.REMIX_VERSION }}
2828
steps:
2929
- name: ⬇️ Checkout repo
3030
uses: actions/checkout@v4
@@ -63,44 +63,44 @@ jobs:
6363
# yyyyMMdd format (e.g. 20221207)
6464
DATE=$(date '+%Y%m%d')
6565
# v0.0.0-nightly-<short sha>-<date>
66-
NEXT_VERSION=0.0.0-nightly-${SHORT_SHA}-${DATE}
66+
REMIX_VERSION=0.0.0-nightly-${SHORT_SHA}-${DATE}
6767
# set output so it can be used in other jobs
68-
echo "NEXT_VERSION=${NEXT_VERSION}" >> $GITHUB_OUTPUT
68+
echo "REMIX_VERSION=${REMIX_VERSION}" >> $GITHUB_OUTPUT
6969
fi
7070
7171
- name: ⤴️ Update version
72-
if: steps.version.outputs.NEXT_VERSION
72+
if: steps.version.outputs.REMIX_VERSION
7373
run: |
7474
git config --local user.email "[email protected]"
7575
git config --local user.name "Remix Run Bot"
76-
git checkout -b nightly/${{ steps.version.outputs.NEXT_VERSION }}
77-
pnpm run version ${{steps.version.outputs.NEXT_VERSION}} --skip-prompt
76+
git checkout -b nightly/${{ steps.version.outputs.REMIX_VERSION }}
77+
pnpm run version ${{steps.version.outputs.REMIX_VERSION}} --skip-prompt
7878
git push origin --tags
7979
8080
- name: 🏗 Build
81-
if: steps.version.outputs.NEXT_VERSION
81+
if: steps.version.outputs.REMIX_VERSION
8282
run: pnpm build
8383

8484
- name: 🔐 Setup npm auth
85-
if: steps.version.outputs.NEXT_VERSION
85+
if: steps.version.outputs.REMIX_VERSION
8686
run: |
8787
echo "registry=https://registry.npmjs.org" >> ~/.npmrc
8888
echo "//registry.npmjs.org/:_authToken=${{ secrets.NPM_TOKEN }}" >> ~/.npmrc
8989
9090
- name: 🚀 Publish
91-
if: steps.version.outputs.NEXT_VERSION
91+
if: steps.version.outputs.REMIX_VERSION
9292
run: npm run publish
9393

9494
comment:
9595
needs: [nightly]
9696
name: 📝 Comment on related issues and pull requests
97-
if: github.repository == 'remix-run/remix' && needs.nightly.outputs.NEXT_VERSION
97+
if: github.repository == 'remix-run/remix' && needs.nightly.outputs.REMIX_VERSION
9898
uses: ./.github/workflows/release-comments.yml
9999

100100
deployments:
101101
needs: [nightly]
102102
name: 🚀 Deployment Tests
103-
if: github.repository == 'remix-run/remix' && needs.nightly.outputs.NEXT_VERSION
103+
if: github.repository == 'remix-run/remix' && needs.nightly.outputs.REMIX_VERSION
104104
uses: remix-run/remix/.github/workflows/deployments.yml@main
105105
secrets:
106106
TEST_AWS_ACCESS_KEY_ID: ${{ secrets.TEST_AWS_ACCESS_KEY_ID }}
@@ -116,7 +116,7 @@ jobs:
116116
stacks:
117117
needs: [nightly]
118118
name: 🥞 Remix Stacks Test
119-
if: github.repository == 'remix-run/remix' && needs.nightly.outputs.NEXT_VERSION
119+
if: github.repository == 'remix-run/remix' && needs.nightly.outputs.REMIX_VERSION
120120
uses: remix-run/remix/.github/workflows/stacks.yml@main
121121
with:
122-
version: "${{ needs.nightly.outputs.NEXT_VERSION }}"
122+
version: "${{ needs.nightly.outputs.REMIX_VERSION }}"

Diff for: .github/workflows/release-experimental.yml

+3-3
Original file line numberDiff line numberDiff line change
@@ -42,9 +42,9 @@ jobs:
4242
git config --local user.email "[email protected]"
4343
git config --local user.name "Remix Run Bot"
4444
SHORT_SHA=$(git rev-parse --short HEAD)
45-
NEXT_VERSION=0.0.0-experimental-${SHORT_SHA}
46-
git checkout -b experimental/${NEXT_VERSION}
47-
pnpm run version ${NEXT_VERSION} --skip-prompt
45+
REMIX_VERSION=0.0.0-experimental-${SHORT_SHA}
46+
git checkout -b experimental/${REMIX_VERSION}
47+
pnpm run version ${REMIX_VERSION} --skip-prompt
4848
git push origin --tags
4949
5050
- name: 🏗 Build

Diff for: CHANGELOG.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -263,7 +263,7 @@ We found that the `future.unstable_fogOfWar` flag name could be a bit confusing
263263

264264
The original Single Fetch approach was based on an assumption that an eventual `middleware` implementation would require something like the `ResponseStub` API so users could mutate `status`/`headers` in `middleware` before/after handlers as well as during handlers. As part of Single Fetch, we wanted to align how response headers would be merged between document and data requests. Thinking `response` was the future API, we aligned document requests to use the `response` stub that data requests were using, and we stopped using the `headers()` function.
265265

266-
However, the realization/alignment between Michael and Ryan on the recent [roadmap planning](https://www.youtube.com/watch?v=f5z_axCofW0) made us realize that the original assumption was incorrect. `middleware` won't need a `response` stub - as users can just mutate the `Response` they get from `await next()` directly.
266+
However, the realization/alignment between Michael and Ryan on the recent [roadmap planning](https://www.youtube.com/watch?v=f5z_axCofW0) made us realize that the original assumption was incorrect. `middleware` won't need a `response` stub - as users can just mutate the `Response` they get from `await remix()` directly.
267267

268268
Removing that assumption, and still wanting to align how headers get merged between document and data requests, it makes more sense to stick with the current `headers()` API and align Single Fetch data requests to use that existing API. This was we don't need to introduce any new header-related APIs which will make the adoption of Single Fetch much easier.
269269

@@ -275,7 +275,7 @@ With this change:
275275
-`return { data: "whatever" };`
276276
- If you _were_ returning a custom `status` or `headers` via `json`/`defer`:
277277
- We've added a new API-compatible [`unstable_data`](https://remix.run/docs/utils/data) utility that will let you send back `status`/`headers` alongside your raw data without having to encode it into a `Response`
278-
- We will be removing both `json` and `defer` in the next major version, but both _should_ still work in Single Fetch in v2 to allow for incremental adoption of the new behavior
278+
- We will be removing both `json` and `defer` in the remix major version, but both _should_ still work in Single Fetch in v2 to allow for incremental adoption of the new behavior
279279

280280
⚠️ If you've already adopted Single Fetch in it's unstable state and converted to `response` stub, you'll need to move those changes back to leveraging the `headers()` API.
281281

Diff for: DEVELOPMENT.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ New releases should be created from release branches originating from the `dev`
4343
- If needed, bump the dependencies to the correct React Router release
4444
- `./scripts/bump-router-versions.sh [pre|latest]`
4545
- Create a new release branch with the `release-` prefix
46-
- `git checkout -b release-next`
46+
- `git checkout -b release-remix`
4747
- **IMPORTANT:** The `release-` prefix is important, as this is what triggers our GitHub CI workflow that will ultimately publish the release
4848
- Merge `main` into the release branch
4949

@@ -93,9 +93,9 @@ You may need to make changes to a pre-release prior to publishing a final stable
9393
- Once the release is published:
9494
- Pull the latest `release-*` branch containing the PR you just merged
9595
- Merge the `release-*` branch into `main` **using a non-fast-forward merge** and push it up to GitHub
96-
- `git checkout main; git merge --no-ff release-next`
96+
- `git checkout main; git merge --no-ff release-remix`
9797
- Merge the `release-*` branch into `dev` **using a non-fast-forward merge** and push it up to GitHub
98-
- `git checkout dev; git merge --no-ff release-next`
98+
- `git checkout dev; git merge --no-ff release-remix`
9999
- Convert the `[email protected]` tag to a Release on GitHub with the name `v2.x.y` and add a deep-link to the release heading in `CHANGELOG.md`
100100

101101
### Hotfix releases

Diff for: decisions/0005-remixing-react-router.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ In [Remixing React Router][remixing router], Ryan gives an overview of the work
3030

3131
### Move the bulk of logic to a framework-agnostic router
3232

33-
Thankfully this decision was sort of already made by Ryan. Maybe a surprise to some, maybe not, the current transition manager doesn't import or reference `react` or `react-router` a single time. This is by design because the logic being handled has nothing to do with how to render the UI layer. It's all about "what route am I on?", "what route am I going to?", "how do I load data for the next route?", "how do I interrupt ongoing navigations?" etc. None of these decisions actually _care_ about how the route and its data will eventually be rendered. Instead, the router simply needs to know whether given routes _have_ components and/or error boundaries - but it doesn't need to know about them or how to render them.
33+
Thankfully this decision was sort of already made by Ryan. Maybe a surprise to some, maybe not, the current transition manager doesn't import or reference `react` or `react-router` a single time. This is by design because the logic being handled has nothing to do with how to render the UI layer. It's all about "what route am I on?", "what route am I going to?", "how do I load data for the remix route?", "how do I interrupt ongoing navigations?" etc. None of these decisions actually _care_ about how the route and its data will eventually be rendered. Instead, the router simply needs to know whether given routes _have_ components and/or error boundaries - but it doesn't need to know about them or how to render them.
3434

3535
This is a huge advantage since it's a strict requirement in order to eventually support UI libraries other than React (namely Preact and Vue). So in the end, we have a `@remix-run/router` package with _zero_ dependencies 🔥.
3636

@@ -82,7 +82,7 @@ We plan to export `useNavigation` in Remix and encourage folks to switch, but we
8282
In Remix, the `useTransition` hook returned a Transition object which had a `state` property of `"idle" | "loading" | "submitting"`. It also had a `type` property which represented sort of "sub-states" such as `"normalLoad" | "actionReload" | "loaderRedirect"` etc. In React Router we chose to get rid of the `type` field for 2 reasons:
8383

8484
1. In practice, we found that the _vast_ majority of the time all you needed to reference was the `state`
85-
2. For scenarios in which you really do need to distinguish, we are pretty sure that in all cases, you can deduce the `type` from `state`, current location (`useLocation`), next location (`useNavigation().location`), and submission info (`useNavigation().formData`).
85+
2. For scenarios in which you really do need to distinguish, we are pretty sure that in all cases, you can deduce the `type` from `state`, current location (`useLocation`), remix location (`useNavigation().location`), and submission info (`useNavigation().formData`).
8686

8787
**`useTransition().submission` is flattened**
8888

Diff for: decisions/0006-linear-workflow.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ This document will use many of the following Linear terms:
1717
- **Project** - A group of issues that comprise a larger scope of work (for example, a new feature)
1818
- Projects will almost always span multiple Cycles.
1919
- **Status** - The state of a given Issue (Todo, In Progress, Done, etc.)
20-
- **Assignee** - The person the Issue is currently assigned to - this indicates who is expected to take the next action to move the Issue forward
20+
- **Assignee** - The person the Issue is currently assigned to - this indicates who is expected to take the remix action to move the Issue forward
2121
- **Label** - Linear Issues can be assigned one or more Labels for filtering/searching
2222

2323
## Decision

Diff for: docs/components/link.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -168,7 +168,7 @@ A -> C
168168

169169
### `state`
170170

171-
Adds persistent client side routing state to the next location.
171+
Adds persistent client side routing state to the remix location.
172172

173173
```tsx
174174
<Link to="/somewhere/else" state={{ some: "value" }} />

Diff for: docs/discussion/form-vs-fetcher.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ These actions typically reflect significant changes to the user's context or sta
3333

3434
- **Creating a New Record**: After creating a new record, it's common to redirect users to a page dedicated to that new record, where they can view or further modify it.
3535

36-
- **Deleting a Record**: If a user is on a page dedicated to a specific record and decides to delete it, the logical next step is to redirect them to a general page, such as a list of all records.
36+
- **Deleting a Record**: If a user is on a page dedicated to a specific record and decides to delete it, the logical remix step is to redirect them to a general page, such as a list of all records.
3737

3838
For these cases, developers should consider using a combination of [`<Form>`][form_component], [`useActionData`][use_action_data], and [`useNavigation`][use_navigation]. Each of these tools can be coordinated to handle form submission, invoke specific actions, retrieve action-related data, and manage navigation respectively.
3939

Diff for: docs/discussion/hot-module-replacement.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ export const myValue = "some value";
8787

8888
### Changing Hooks
8989

90-
React Fast Refresh cannot track changes for a component when hooks are being added or removed from it, causing full reloads just for the next render. After the hooks have been updated, changes should result in hot updates again. For example, if you add [`useLoaderData`][use-loader-data] to your component, you may lose state local to that component for that render.
90+
React Fast Refresh cannot track changes for a component when hooks are being added or removed from it, causing full reloads just for the remix render. After the hooks have been updated, changes should result in hot updates again. For example, if you add [`useLoaderData`][use-loader-data] to your component, you may lose state local to that component for that render.
9191

9292
Additionally, if you are destructuring a hook's return value, React Fast Refresh will not be able to preserve state for the component if the destructured key is removed or renamed.
9393
For example:
@@ -169,7 +169,7 @@ Now if you change the key `stuff` to `things`:
169169
}
170170
```
171171

172-
Then React Fast Refresh will preserve state for the `<input />`, though you may need to use component keys as described in the next section if the stateful element (e.g. `<input />`) is a sibling of the changed element.
172+
Then React Fast Refresh will preserve state for the `<input />`, though you may need to use component keys as described in the remix section if the stateful element (e.g. `<input />`) is a sibling of the changed element.
173173

174174
### Component Keys
175175

Diff for: docs/discussion/introduction.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -148,7 +148,7 @@ If you're not familiar with traditional back-end web frameworks, you can think o
148148

149149
Once Remix has served the document to the browser, it "hydrates" the page with the browser build's JavaScript modules. This is where we talk a lot about Remix "emulating the browser".
150150

151-
When the user clicks a link, instead of making a round trip to the server for the entire document and all the assets, Remix simply fetches the data for the next page and updates the UI.
151+
When the user clicks a link, instead of making a round trip to the server for the entire document and all the assets, Remix simply fetches the data for the remix page and updates the UI.
152152

153153
Additionally, when users submit a `<Form>` to update data, instead of doing a normal HTML document request, the browser runtime will make a fetch to the server instead and automatically revalidate all data on the page and updating it with React.
154154

@@ -163,7 +163,7 @@ Remix also has some built in optimizations for client-side navigation. It knows
163163

164164
This approach also has UX benefits like not resetting the scroll position of a sidebar nav and allowing you to move focus to something that makes more sense than the top of the document.
165165

166-
Remix can also prefetch all resources for a page when the user is about to click a link. The browser framework knows about the compiler's asset manifest. It can match the URL of the link, read the manifest, and then prefetch all data, JavaScript modules, and even CSS resources for the next page. This is how Remix apps feel fast even when networks are slow.
166+
Remix can also prefetch all resources for a page when the user is about to click a link. The browser framework knows about the compiler's asset manifest. It can match the URL of the link, read the manifest, and then prefetch all data, JavaScript modules, and even CSS resources for the remix page. This is how Remix apps feel fast even when networks are slow.
167167

168168
Remix then provides client side APIs, so you can create rich user experiences without changing the fundamental model of HTML and browsers.
169169

Diff for: docs/discussion/pending-ui.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -19,13 +19,13 @@ The difference between a great user experience on the web and mediocre one is ho
1919

2020
Use Optimistic UI:
2121

22-
- **Next State Predictability**: The application can accurately predict the next state of the UI based on the user's action.
22+
- **Remix State Predictability**: The application can accurately predict the remix state of the UI based on the user's action.
2323
- **Error Handling**: Robust error handling mechanisms are in place to address potential errors that may occur during the process.
2424
- **URL Stability**: The action does not result in a change of the URL, ensuring that the user remains within the same page.
2525

2626
Use Busy Indicators:
2727

28-
- **Next State Uncertainty**: The outcome of the action cannot be reliably predicted, necessitating waiting for the server's response.
28+
- **Remix State Uncertainty**: The outcome of the action cannot be reliably predicted, necessitating waiting for the server's response.
2929
- **URL Change**: The action leads to a change in the URL, indicating navigation to a new page or section.
3030
- **Error Boundaries**: The error handling approach primarily relies on error boundaries that manage exceptions and unexpected behavior.
3131
- **Side Effects**: The action triggers side effects that involve critical processes, such as sending email, processing payments, etc.
@@ -79,7 +79,7 @@ export function ProjectList({ projects }) {
7979
}
8080
```
8181

82-
Or add a spinner next to it by inspecting params:
82+
Or add a spinner remix to it by inspecting params:
8383

8484
```tsx lines=[1,4,10-12]
8585
import { useParams } from "@remix-run/react";
@@ -243,7 +243,7 @@ When creating skeleton fallbacks, consider the following principles:
243243
- **Consistent Size:** Ensure that the skeleton fallbacks match the dimensions of the actual content. This prevents sudden layout shifts, providing a smoother and more visually cohesive loading experience. In terms of web performance, this trade-off minimizes [Cumulative Layout Shift][cumulative_layout_shift] (CLS) in favor of improving [First Contentful Paint][first_contentful_paint] (FCP). You can minimize the trade with accurate dimensions in the fallback.
244244
- **Critical Data:** Avoid using fallbacks for essential information—the main content of the page. This is especially important for SEO and meta tags. If you delay showing critical data, accurate meta tags can't be provided, and search engines won't correctly index your page.
245245
- **App-Like Feel**: For web application UI that doesn't have SEO concerns, it can be beneficial to use skeleton fallbacks more extensively. This creates an interface that resembles the behavior of a standalone app. When users click on links, they get an instantaneous transition to the skeleton fallbacks.
246-
- **Link Prefetching:** Using [`<Link prefetch="intent">`][link-component-prefetch] can often skip the fallbacks completely. When users hover or focus on the link, this method preloads the needed data, allowing the network a quick moment to fetch content before the user clicks. This often results in an immediate navigation to the next page.
246+
- **Link Prefetching:** Using [`<Link prefetch="intent">`][link-component-prefetch] can often skip the fallbacks completely. When users hover or focus on the link, this method preloads the needed data, allowing the network a quick moment to fetch content before the user clicks. This often results in an immediate navigation to the remix page.
247247

248248
## Conclusion
249249

0 commit comments

Comments
 (0)