Merge branch 'main' into fix-typos-and-grammar-landing

SaltyAom · web-flow · commit a51c2216bb3f · 2023-09-01T23:12:01.000+07:00
diff --git a/components/landing/components/simple.vue b/components/landing/components/simple.vue
@@ -26,9 +26,9 @@
                     everyone
                 </p>
                 <p class="text-xl text-gray-400 w-full max-w-lg">
-                    From built-in strict-type validaiton to unified types
+                    From built-in strict-type validaiton to a unified type
                     system, and documentation generation, making an ideal
-                    framework for building server with TypeScript.
+                    framework for building servers with TypeScript.
                 </p>
             </div>
         </section>
diff --git a/components/midori/community.vue b/components/midori/community.vue
@@ -16,7 +16,7 @@
                 </h2>
             </header>
             <p class="text-xl text-gray-400 w-full max-w-lg mb-4">
-                Elysia is one of the biggest community base for Bun first web framework.
+                Elysia is one of the biggest communities for Bun first web frameworks.
             </p>
             <p class="text-xl text-gray-400 w-full max-w-lg">
                 You can ask your questions / propose a new feature / file a bug with our community and mainters.
diff --git a/components/midori/just-return.vue b/components/midori/just-return.vue
@@ -29,8 +29,8 @@ new Elysia()
             <p
                 class="text-xl leading-normal text-gray-400 w-full max-w-lg mb-4"
             >
-                No need for additional method, just return a value to send data
-                back to client
+                No need for an additional method, just return the value to send data
+                back to the client.
             </p>
             <p
                 class="text-xl leading-normal text-gray-400 w-full max-w-lg mb-4"
diff --git a/components/midori/openapi.vue b/components/midori/openapi.vue
@@ -37,7 +37,7 @@ new Elysia()
                 class="text-xl leading-normal text-gray-400 w-full max-w-lg mb-4"
             >
                 Thanks to OpenAPI compliance, Elysia can generate Swagger in one
-                line with Swagger plugin
+                line with the Swagger plugin.
             </p>
         </header>
     </article>
diff --git a/components/midori/plugins.vue b/components/midori/plugins.vue
@@ -65,12 +65,12 @@ onMounted(() => {
                 </h2>
             </header>
             <p class="text-xl text-gray-400 w-full max-w-lg mb-4">
-                Being one of the most popular choice for Bun web framework,
+                Being one of the most popular choices for a Bun web framework,
                 likely there is a plugin for what you want.
             </p>
             <p class="text-xl text-gray-400 w-full max-w-lg">
-                If there's no plugin you need, it's easy to create one and share
-                with community.
+                If the plugin you need is not there, it's easy to create one and share
+                it with the community.
             </p>
             <div class="mt-8">
                 <a
diff --git a/components/midori/simple.vue b/components/midori/simple.vue
@@ -31,9 +31,9 @@
                     everyone
                 </p>
                 <p class="text-xl text-gray-400 w-full max-w-lg">
-                    From built-in strict-type validaiton to unified types
+                    From built-in strict-type validaiton to a unified type
                     system, and documentation generation, making an ideal
-                    framework for building server with TypeScript.
+                    framework for building servers with TypeScript.
                 </p>
             </div>
         </section>
diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts
@@ -128,6 +128,10 @@ export default defineConfig({
                         text: 'Derive',
                         link: '/concept/derive'
                     },
+                    {
+                        text: 'Plugin',
+                        link: '/concept/plugin'
+                    },
                     {
                         text: 'Group',
                         link: '/concept/group'
@@ -152,10 +156,6 @@ export default defineConfig({
                         text: 'Config',
                         link: '/concept/config'
                     },
-                    {
-                        text: 'Plugin',
-                        link: '/concept/plugin'
-                    },
                     {
                         text: 'Explicit Body',
                         link: '/concept/explicit-body'
diff --git a/docs/concept/group.md b/docs/concept/group.md
@@ -50,7 +50,7 @@ You can separate group into an instance and register the group as plugin for cod
 import { Elysia } from 'elysia'
 
 const users = new Elysia({ prefix: '/user' })
-    .post('/sign-in, signIn)
+    .post('/sign-in', signIn)
     .post('/sign-up', signUp)
     .post('/profile', getProfile)
 
diff --git a/docs/concept/plugin.md b/docs/concept/plugin.md
@@ -74,9 +74,9 @@ You can customize plugin by creating function to return callback which accepts E
 ```typescript
 import { Elysia } from 'elysia'
 
-const plugin = ({
+const plugin = <const Prefix>({
     prefix = '/v1'
-}) => (app: Elysia) => app
+}: { prefix: Prefix }) => new Elysia({ prefix })
     .get(`/${prefix}/hi`, () => 'Hi')
 
 const app = new Elysia()
diff --git a/docs/concept/schema.md b/docs/concept/schema.md
@@ -59,7 +59,7 @@ interface Body {
 This means that you will get strict type defining once from a schema and get inferred type to TypeScript without needing to write a single TypeScript.
 
 ## Global and scope
-The global schema will define all types of a handler in the scope.
+The global schema will define all types within the scope of a handler.
 
 ```typescript
 app.guard({
@@ -73,7 +73,7 @@ app.guard({
 
 The global type will be overwritten by the nearest schema to the handler.
 
-In another word, inherits schema is rewritten by the inner scope.
+In other words, the inherited schema is rewritten within the inner scope.
 ```typescript
 app.guard({
     response: t.String()
@@ -87,7 +87,7 @@ app.guard({
 )
 ```
 
-`group` and `guard` will define the scope limit, so the type will not get out of the scope handler.
+`group` and `guard` will define the scope limits, so the type will not get out of the scope handler.
 
 ## Multiple Status Response
 By default `schema.response` can accept either a schema definition or a map or stringified status code with schema.
@@ -110,9 +110,9 @@ new Elysia()
 ```
 
 ## Reference Models
-Sometime you might find yourself re-use the same type multiple time.
+Sometimes you might find yourself reusing the same type multiple times.
 
-Using [reference models](/patterns/reference-models), you can named your model and use it by referencing the name:
+Using [reference models](/patterns/reference-models), you can name your model and use it by referencing the name:
 ```typescript
 // auth.model.ts
 import { Elysia } from 'elysia'
@@ -135,4 +135,4 @@ const app = new Elysia()
     })
 ```
 
-For more explaination, see [Reference Models](/patterns/reference-models).
+For more explanation, see [Reference Models](/patterns/reference-models).
diff --git a/docs/patterns/dependency-injection.md b/docs/patterns/dependency-injection.md
@@ -27,7 +27,7 @@ const app = new Elysia()
     // and so on...
 
 // routes/authen.ts
-const authen = (app: Elysia) => app
+const authen = new Elysia()
     .post('/sign-in', signIn)
     .post('/sign-up', signUp)
 ```
@@ -43,7 +43,7 @@ const app = new Elysia()
     // and so on...
 
 // routes/authen.ts
-const authen = (app: Elysia) => app
+const authen = new Elysia()
     .post('/sign-in', signIn)
     .post('/sign-up', signUp)
     // But then there is no type
@@ -56,7 +56,7 @@ const authen = (app: Elysia) => app
 
 If you hovered over the main `app` in `index.ts`, you can see that it has some type auto-generated for your main server which might look something like this:
 ```typescript
-const app: Elysia<{
+const app: Elysia<'', {
     store: {
         redis: Redis;
      };
@@ -72,12 +72,12 @@ But this type isn't applied to sub-modules.
 To apply the type to sub-modules, you can create a plugin which only contains `state` and `decorate` which caused **type side-effect** as dependency, and apply to the module you want to use.
 
 ```typescript
-const setup = (app: Elysia) => app
+const setup = new Elysia({ name: 'setup' })
     .decorate('signOut', signOut)
     .state('redis', redis)
 
 // routes/authen.ts
-const authen = (app: Elysia) => app
+const authen = new Elysia()
     .use(setup)
     .post('/sign-in', signIn)
     .post('/sign-up', signUp)
diff --git a/docs/patterns/reference-models.md b/docs/patterns/reference-models.md
@@ -84,14 +84,13 @@ Now when we need to quickly access the model's group, we can separate a `setMode
 // auth.model.ts
 import { Elysia } from 'elysia'
 
-export const authModel = (app: Elysia) => 
-    app
-        .model({
-            sign: t.Object({
-                username: t.String(),
-                password: t.String()
-            })
+export const authModel = new Elysia()
+    .model({
+        sign: t.Object({
+            username: t.String(),
+            password: t.String()
         })
+    })
 
 // index.ts
 import { Elysia } from 'elysia'
@@ -113,15 +112,14 @@ const app = new Elysia()
 // auth.model.ts
 import { Elysia } from 'elysia'
 
-export const authModel = (app: Elysia) => 
-    app
-        .model({
-            sign: t.Object({
-                username: t.String(),
-                password: t.String()
-            }),
-            number: t.Number()
-        })
+export const authModel = new Elysia()
+    .model({
+        sign: t.Object({
+            username: t.String(),
+            password: t.String()
+        }),
+        number: t.Number()
+    })
 ```
 
 ## Naming Convention
@@ -133,24 +131,22 @@ Let's say that you have all models stored at `models/<name>.ts`, you can declare
 
 ```typescript
 // admin.model.ts
-export const authModel = (app: Elysia) => 
-    app
-        .model({
-            'admin.auth': t.Object({
-                username: t.String(),
-                password: t.String()
-            })
+export const authModel = new Elysia()
+    .model({
+        'admin.auth': t.Object({
+            username: t.String(),
+            password: t.String()
         })
+    })
 
 // user.model.ts
-export const authModel = (app: Elysia) => 
-    app
-        .model({
-            'user.auth': t.Object({
-                username: t.String(),
-                password: t.String()
-            })
+export const authModel = new Elysia()
+    .model({
+        'user.auth': t.Object({
+            username: t.String(),
+            password: t.String()
         })
+    })
 ```
 
 This can prevent naming duplication at some level, but in the end, it's best to let the naming convention decision up to your team's agreement is the best option.

Original file line number	Diff line number	Diff line change
`@@ -37,7 +37,7 @@ new Elysia()`
`37`	`37`	`class="text-xl leading-normal text-gray-400 w-full max-w-lg mb-4"`
`38`	`38`	`>`
`39`	`39`	`Thanks to OpenAPI compliance, Elysia can generate Swagger in one`
`40`		`- line with Swagger plugin`
	`40`	`+ line with the Swagger plugin.`
`41`	`41`	`</p>`
`42`	`42`	`</header>`
`43`	`43`	`</article>`