Skip to content

update winterCG to winterTC #694

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+11 −11
Open

update winterCG to winterTC #694

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/blog.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ head:
title: 'Introducing Elysia 0.6 - This Game',
href: '/blog/elysia-06',
cover: 'this-game.webp',
detail: 'Introducing re-imagined plugin model, dynamic mode, better developer experience with declarative custom error, customizable loose and strict path mapping, TypeBox 0.30 and WinterCG framework interlop. Pushing the boundary of what is possible once again'
detail: 'Introducing re-imagined plugin model, dynamic mode, better developer experience with declarative custom error, customizable loose and strict path mapping, TypeBox 0.30 and WinterTC framework interlop. Pushing the boundary of what is possible once again'
},
{
title: 'Accelerate your next Prisma server with Elysia',
Expand Down
6 changes: 3 additions & 3 deletions docs/integrations/astro.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ head:

- - meta
- name: 'description'
content: You can run Elysia on Astro. Elysia will work normally as expected because of WinterCG compliance.
content: You can run Elysia on Astro. Elysia will work normally as expected because of WinterTC compliance.

- - meta
- property: 'og:description'
Expand Down Expand Up @@ -52,12 +52,12 @@ export const GET = handle // [!code ++]
export const POST = handle // [!code ++]
```

Elysia will work normally as expected because of WinterCG compliance.
Elysia will work normally as expected because of WinterTC compliance.

We recommend running [Astro on Bun](https://docs.astro.build/en/recipes/bun) as Elysia is designed to be run on Bun.

::: tip
You can run Elysia server without running Astro on Bun thanks to WinterCG support.
You can run Elysia server without running Astro on Bun thanks to WinterTC support.
:::

With this approach, you can have co-location of both frontend and backend in a single repository and have End-to-end type-safety with Eden.
Expand Down
2 changes: 1 addition & 1 deletion docs/integrations/expo.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ head:

- - meta
- name: 'description'
content: With Expo App Router, you can run Elysia on Expo route. Elysia will work normally as expected thanks to WinterCG compliance.
content: With Expo App Router, you can run Elysia on Expo route. Elysia will work normally as expected thanks to WinterTC compliance.

- - meta
- property: 'og:description'
Expand Down
4 changes: 2 additions & 2 deletions docs/integrations/nextjs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ head:

- - meta
- name: 'description'
content: With Next.js App Router, you can run Elysia on Next.js routes. Elysia will work normally as expected because of WinterCG compliance.
content: With Next.js App Router, you can run Elysia on Next.js routes. Elysia will work normally as expected because of WinterTC compliance.

- - meta
- property: 'og:description'
Expand Down Expand Up @@ -41,7 +41,7 @@ export const POST = app.fetch // [!code ++]

:::

Elysia will work normally as expected because of WinterCG compliance.
Elysia will work normally as expected because of WinterTC compliance.

You can treat the Elysia server as a normal Next.js API route.

Expand Down
4 changes: 2 additions & 2 deletions docs/patterns/mount.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ head:

- - meta
- name: 'description'
content: Applying WinterCG interoperable code to run with Elysia or vice-versa.
content: Applying WinterTC interoperable code to run with Elysia or vice-versa.

- - meta
- property: 'og:description'
Expand All @@ -21,7 +21,7 @@ It allows web servers to run interoperably across runtimes by using [Request](ht

Elysia is WinterTC compliant. Optimized to run on Bun, but also support other runtimes if possible.

This allows any framework or code that is WinterCG compliant to be run together, allowing frameworks like Elysia, Hono, Remix, Itty Router to run together in a simple function.
This allows any framework or code that is WinterTC compliant to be run together, allowing frameworks like Elysia, Hono, Remix, Itty Router to run together in a simple function.

## Mount
To use **.mount**, [simply pass a `fetch` function](https://twitter.com/saltyAom/status/1684786233594290176):
Expand Down
2 changes: 1 addition & 1 deletion docs/patterns/unit-test.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ head:

# Unit Test

Being WinterCG compliant, we can use Request / Response classes to test an Elysia server.
Being WinterTC compliant, we can use Request / Response classes to test an Elysia server.

Elysia provides the **Elysia.handle** method, which accepts a Web Standard [Request](https://developer.mozilla.org/en-US/docs/Web/API/Request) and returns [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response), simulating an HTTP Request.

Expand Down
2 changes: 1 addition & 1 deletion docs/quick-start.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -348,7 +348,7 @@ Don't forget to update `tsconfig.json` to include `compilerOptions.strict` to `t

<template v-slot:web-standard>

Elysia is a WinterCG compliance library, which means if a framework or runtime supports Web Standard Request/Response, it can run Elysia.
Elysia is a WinterTC compliant library, which means if a framework or runtime supports Web Standard Request/Response, it can run Elysia.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Apply hyphenation to compound adjective.

Line 351 reads "WinterTC compliant library". When a compound adjective precedes a noun, it should be hyphenated: "WinterTC-compliant library".

Apply this diff to fix the grammar:

-Elysia is a WinterTC compliant library, which means if a framework or runtime supports Web Standard Request/Response, it can run Elysia.
+Elysia is a WinterTC-compliant library, which means if a framework or runtime supports Web Standard Request/Response, it can run Elysia.

Note: This same pattern ("WinterTC compliant" used as adjective before noun) appears in other files and should also be hyphenated for consistency. Check docs/integrations/astro.md line 55 and docs/integrations/nextjs.md line 44.

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
Elysia is a WinterTC compliant library, which means if a framework or runtime supports Web Standard Request/Response, it can run Elysia.
Elysia is a WinterTC-compliant library, which means if a framework or runtime supports Web Standard Request/Response, it can run Elysia.
🧰 Tools
🪛 LanguageTool

[grammar] ~351-~351: Use a hyphen to join words.
Context: ...slot:web-standard> Elysia is a WinterTC compliant library, which means if a fram...

(QB_NEW_EN_HYPHEN)

🤖 Prompt for AI Agents 
In docs/quick-start.md around line 351, change the phrase "WinterTC compliant
library" to "WinterTC-compliant library" (hyphenate the compound adjective
before the noun); also update the same pattern for consistency in
docs/integrations/astro.md around line 55 and docs/integrations/nextjs.md around
line 44 by replacing "WinterTC compliant" with "WinterTC-compliant".


First, install Elysia with the command below:

Expand Down