refactor(h3): change middleware name

Author: kazupon

packages/h3/README.md

@@ -117,34 +117,6 @@ app.get('/', async event => {
 createServer(toNodeListener(app)).listen(3000)
 ```
 
-## 🚀 Usage (Nitro)
-
-For usage with [Nitro](https://nitro.build/) you need to create a plugin instead, create file `plugins/i18n.ts`:
-
-```ts
-import { defineNitroPlugin } from 'nitropack/runtime'
-import { defineI18nMiddleware, detectLocaleFromAcceptLanguageHeader } from '@intlify/h3'
-
-export default defineNitroPlugin(nitroApp => {
-  const { onRequest, onAfterResponse } = defineI18nMiddleware({
-    // detect locale with `accept-language` header
-    locale: detectLocaleFromAcceptLanguageHeader,
-    // resource messages
-    messages: {
-      en: {
-        hello: 'Hello {name}!'
-      },
-      ja: {
-        hello: 'こんにちは、{name}！'
-      }
-    }
-  })
-
-  nitroApp.hooks.hook('request', onRequest)
-  nitroApp.hooks.hook('afterResponse', onAfterResponse)
-})
-```
-
 ## 🛠️ Custom locale detection
 
 You can detect locale with your custom logic from current `H3Event`.
@@ -204,16 +176,16 @@ const messages: Record<string, () => ReturnType<typeof loader>> = {
 // define custom locale detector and lazy loading
 const localeDetector = async (
   event: H3Event,
-  i18n: CoreContext<string, DefineLocaleMessage>
+  intlify: CoreContext<string, DefineLocaleMessage>
 ): Promise<string> => {
   // detect locale
   const locale = getCookieLocale(event.req).toString()
 
   // resource lazy loading
   const loader = messages[locale]
-  if (loader && !i18n.messages[locale]) {
+  if (loader && !intlify.messages[locale]) {
     const message = await loader()
-    i18n.messages[locale] = message
+    intlify.messages[locale] = message
   }
 
   return locale

packages/h3/docs/functions/detectLocaleFromAcceptLanguageHeader.md

@@ -28,9 +28,9 @@ A locale string, which will be detected of **first** from `Accept-Language` head
 
 ```js
 import { H3 } from 'h3'
-import { defineI18nMiddleware, detectLocaleFromAcceptLanguageHeader } from '@intlify/h3'
+import { defineIntlifyMiddleware, detectLocaleFromAcceptLanguageHeader } from '@intlify/h3'
 
-const i18nMiddleware = defineI18nMiddleware({
+const intlifyMiddleware = defineIntlifyMiddleware({
   messages: {
     en: {
       hello: 'Hello {name}!',
@@ -43,6 +43,6 @@ const i18nMiddleware = defineI18nMiddleware({
 })
 
 const app = new H3()
-  .use(i18nMiddleware.onRequest)
-  .use(i18nMiddleware.onResponse)
+  .use(intlifyMiddleware.onRequest)
+  .use(intlifyMiddleware.onResponse)
 ```

packages/h3/docs/index.md

@@ -38,11 +38,11 @@ Internationalization middleware & utilities for h3
 | Interface | Description |
 | ------ | ------ |
 | [DefineLocaleMessage](interfaces/DefineLocaleMessage.md) | The type definition of Locale Message for `@intlify/h3` package |
-| [I18nMiddleware](interfaces/I18nMiddleware.md) | Internationalization middleware for H3 |
+| [IntlifyMiddleware](interfaces/IntlifyMiddleware.md) | Internationalization middleware for H3 |
 
 ## Type Aliases
 
 | Type Alias | Description |
 | ------ | ------ |
 | [CoreContext](type-aliases/CoreContext.md) | - |
-| [I18nPluginOptions](type-aliases/I18nPluginOptions.md) | Internationalization plugin options for H3 |
+| [IntlifyPluginOptions](type-aliases/IntlifyPluginOptions.md) | Internationalization plugin options for H3 |

packages/h3/docs/interfaces/I18nMiddleware.md renamed to packages/h3/docs/interfaces/IntlifyMiddleware.md

@@ -2,9 +2,9 @@
 
 ***
 
-[@intlify/h3](../index.md) / I18nMiddleware
+[@intlify/h3](../index.md) / IntlifyMiddleware
 
-# Interface: I18nMiddleware
+# Interface: IntlifyMiddleware
 
 Internationalization middleware for H3
 

packages/h3/docs/type-aliases/I18nPluginOptions.md renamed to packages/h3/docs/type-aliases/IntlifyPluginOptions.md

@@ -2,12 +2,12 @@
 
 ***
 
-[@intlify/h3](../index.md) / I18nPluginOptions
+[@intlify/h3](../index.md) / IntlifyPluginOptions
 
-# Type Alias: I18nPluginOptions\<Schema, Locales, Message\>
+# Type Alias: IntlifyPluginOptions\<Schema, Locales, Message\>
 
 ```ts
-type I18nPluginOptions<Schema, Locales, Message> = CoreOptions<Message, SchemaParams<Schema, Message>, LocaleParams<Locales>>;
+type IntlifyPluginOptions<Schema, Locales, Message> = CoreOptions<Message, SchemaParams<Schema, Message>, LocaleParams<Locales>>;
 ```
 
 Internationalization plugin options for H3

packages/h3/docs/variables/intlify.md

@@ -16,7 +16,7 @@ Internationalization plugin for H3
 
 | Parameter | Type |
 | ------ | ------ |
-| `options` | [`I18nPluginOptions`](../type-aliases/I18nPluginOptions.md) |
+| `options` | [`IntlifyPluginOptions`](../type-aliases/IntlifyPluginOptions.md) |
 
 ## Returns
 
@@ -26,11 +26,11 @@ Internationalization plugin for H3
 
 ```ts
 import { H3 } from 'h3'
-import { plugin as i18n } from '@intlify/h3'
+import { intlify } from '@intlify/h3'
 
 const app = new H3({
   plugins: [
-    i18n({
+    intlify({
       messages: {
         en: {
           hello: 'Hello {name}!',

packages/h3/src/index.test-d.ts

@@ -1,5 +1,5 @@
 import { expectTypeOf, test } from 'vitest'
-import { defineI18nMiddleware, useTranslation } from './index.ts'
+import { defineIntlifyMiddleware, useTranslation } from './index.ts'
 
 import type { H3Event } from 'h3'
 
@@ -18,12 +18,12 @@ declare module './index.ts' {
   }
 }
 
-test('defineI18nMiddleware', () => {
+test('defineIntlifyMiddleware', () => {
   const _en = {
     hello: 'worked'
   }
   type ResourceSchema = typeof _en
-  defineI18nMiddleware<[ResourceSchema], 'en' | 'ja'>({
+  defineIntlifyMiddleware<[ResourceSchema], 'en' | 'ja'>({
     messages: {
       en: { hello: 'world' },
       ja: { hello: '世界' }

packages/h3/src/index.test.ts

@@ -1,9 +1,9 @@
 import { createCoreContext } from '@intlify/core'
 import { describe, expect, test } from 'vitest'
-import { SYMBOL_I18N, SYMBOL_I18N_LOCALE } from './symbols.ts'
+import { SYMBOL_INTLIFY, SYMBOL_INTLIFY_LOCALE } from './symbols.ts'
 
 import {
-  defineI18nMiddleware,
+  defineIntlifyMiddleware,
   detectLocaleFromAcceptLanguageHeader,
   getDetectorLocale,
   useTranslation
@@ -23,8 +23,8 @@ test('detectLocaleFromAcceptLanguageHeader', () => {
   expect(detectLocaleFromAcceptLanguageHeader(eventMock)).toBe('en-US')
 })
 
-test('defineI18nMiddleware', () => {
-  const middleware = defineI18nMiddleware({
+test('defineIntlifyMiddleware', () => {
+  const middleware = defineIntlifyMiddleware({
     locale: detectLocaleFromAcceptLanguageHeader,
     messages: {
       en: {
@@ -62,14 +62,14 @@ describe('useTranslation', () => {
         }
       },
       context: {
-        [SYMBOL_I18N]: context as CoreContext
+        [SYMBOL_INTLIFY]: context as CoreContext
       }
     } as H3Event
     const locale = context.locale as unknown
     const bindLocaleDetector = (locale as LocaleDetector).bind(null, eventMock)
     // @ts-ignore ignore type error because this is test
     context.locale = bindLocaleDetector
-    eventMock.context[SYMBOL_I18N_LOCALE] = bindLocaleDetector
+    eventMock.context[SYMBOL_INTLIFY_LOCALE] = bindLocaleDetector
 
     // test `useTranslation`
     const t = await useTranslation(eventMock)
@@ -101,14 +101,14 @@ test('getDetectorLocale', async () => {
       }
     },
     context: {
-      [SYMBOL_I18N]: context as CoreContext
+      [SYMBOL_INTLIFY]: context as CoreContext
     }
   } as H3Event
   const _locale = context.locale as unknown
   const bindLocaleDetector = (_locale as LocaleDetector).bind(null, eventMock)
   // @ts-ignore ignore type error because this is test
   context.locale = bindLocaleDetector
-  eventMock.context[SYMBOL_I18N_LOCALE] = bindLocaleDetector
+  eventMock.context[SYMBOL_INTLIFY_LOCALE] = bindLocaleDetector
 
   const locale = await getDetectorLocale(eventMock)
   expect(locale.language).toEqual('ja')