Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

templates: update CacheStorage type reference #10316

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

caprolactam
Copy link

Problem

The type of caches references CacheStorage from lib.dom.d.ts, but this is incompatible with the actual implementation on the Cloudflare network.
The first one is from lib.dom.d.ts, and the other is from @cloudflare/workers-types.

This is because "DOM" is specified as the lib in tsconfig.json, which is correct in itself, but some adjustments are needed.

Solution

I think there are two approaches. [Source for the fix]

First, import and declare CacheStorage type from @cloudflare/workers-types in the file where caches is defined.

Second, separate the tsconfig.json for server.ts and the app folder. While this approach allows for more accurate types, it makes the project more complicated.

.
├── tsconfig.app.json
├── tsconfig.cloudflare.json
└── tsconfig.json

// tsconfig.app.json
{
 "include": ["app"],
}
// tsconfig.cloudflare.json
{
 "include": ["server.ts"],
 "compilerOptions": {
    "target": "esnext",
    "module": "esnext",
    "lib": ["esnext"],
    "types": ["@cloudflare/workers-types"]
  }
}
// tsconfig.json
{
 "files": [],
  "references": [
    { "path": "./tsconfig.app.json" },
    { "path": "./tsconfig.cloudflare.json" }
  ]
}

If you handle the server outside of Remix (e.g. Remix + Hono), the second approach is better. However, the first approach works well in most cases.

Copy link

changeset-bot bot commented Dec 9, 2024

⚠️ No Changeset found

Latest commit: 8176fb1

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

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

@remix-cla-bot
Copy link
Contributor

remix-cla-bot bot commented Dec 9, 2024

Hi @caprolactam,

Welcome, and thank you for contributing to Remix!

Before we consider your pull request, we ask that you sign our Contributor License Agreement (CLA). We require this only once.

You may review the CLA and sign it by adding your name to contributors.yml.

Once the CLA is signed, the CLA Signed label will be added to the pull request.

If you have already signed the CLA and received this response in error, or if you have any questions, please contact us at [email protected].

Thanks!

- The Remix team

@remix-cla-bot
Copy link
Contributor

remix-cla-bot bot commented Dec 9, 2024

Thank you for signing the Contributor License Agreement. Let's get this merged! 🥳

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant