fix(h3): change plugin name

Author: kazupon

packages/h3/README.md

@@ -76,18 +76,18 @@ app.get('/', event => {
 
 ### Translation
 
-If you want to use translation, you need to install plugin. As a result, you can use `useTranslation` within the handler:
+If you want to use translation, you need to install `intlify` plugin. As a result, you can use `useTranslation` within the handler:
 
 ```ts
 import { createServer } from 'node:http'
 import { H3, toNodeListener } from 'h3'
-import { plugin as i18n, detectLocaleFromAcceptLanguageHeader, useTranslation } from '@intlify/h3'
+import { intlify, detectLocaleFromAcceptLanguageHeader, useTranslation } from '@intlify/h3'
 
-// install plugin with `H3` constructor
+// install `intlify` plugin with `H3` constructor
 const app = new H3({
   plugins: [
     // configure plugin options
-    i18n({
+    intlify({
       // detect locale with `accept-language` header
       locale: detectLocaleFromAcceptLanguageHeader,
       // resource messages
@@ -150,7 +150,7 @@ example for detecting locale from url query:
 
 ```ts
 import { H3 } from 'h3'
-import { plugin as i18n, getQueryLocale } from '@intlify/h3'
+import { intlify, getQueryLocale } from '@intlify/h3'
 
 import type { H3Event } from 'h3'
 
@@ -161,7 +161,7 @@ const localeDetector = (event: H3Event): string => {
 
 const app = new H3({
   plugins: [
-    i18n({
+    intlify({
       // set your custom locale detector
       locale: localeDetector
       // something options
@@ -182,7 +182,7 @@ You can make that function asynchronous. This is useful when loading resources a
 
 ```ts
 import { H3 } from 'h3'
-import { plugin as i18n, getCookieLocale } from '@intlify/h3'
+import { intlify, getCookieLocale } from '@intlify/h3'
 
 import type { H3Event } from 'h3'
 import type { DefineLocaleMessage, CoreContext } from '@intlify/h3'
@@ -213,7 +213,7 @@ const localeDetector = async (
 
 const app = new H3({
   plugins: [
-    i18n({
+    intlify({
       // set your custom locale detector
       locale: localeDetector
       // something options
@@ -223,77 +223,6 @@ const app = new H3({
 })
 ```
 
-## 🧩 Type-safe resources
-
-<!-- eslint-disable markdown/no-missing-label-refs -- NOTE(kazupon): ignore github alert -->
-
-> [!WARNING]
-> **This is experimental feature (inspired from [vue-i18n](https://vue-i18n.intlify.dev/guide/advanced/typescript.html#typescript-support)).**
-> We would like to get feedback from you 🙂.
-
-> [!NOTE]
-> The example code is [here](https://github.com/intlify/h3/tree/main/playground/typesafe-schema)
-
-<!-- eslint-enable markdown/no-missing-label-refs -- NOTE(kazupon): ignore github alert -->
-
-You can support the type-safe resources with schema using TypeScript on `defineI18nMiddleware` options.
-
-Locale messages resource:
-
-```ts
-export default {
-  hello: 'hello, {name}!'
-}
-```
-
-your application code:
-
-```ts
-import { defineI18nMiddleware } from '@intlify/h3'
-import { H3 } from 'h3'
-import en from './locales/en.ts'
-
-// define resource schema, as 'en' is master resource schema
-type ResourceSchema = typeof en
-
-const i18nMiddleware = defineI18nMiddleware<[ResourceSchema], 'en' | 'ja'>({
-  messages: {
-    en: { hello: 'Hello, {name}' }
-  }
-  // something options
-  // ...
-})
-
-const app = new H3()
-app.use(i18nMiddleware.onRequest)
-app.use(i18nMiddleware.onResponse)
-
-// something your implementation code ...
-// ...
-```
-
-Result of type checking with `tsc`:
-
-```sh
-npx tsc --noEmit
-index.ts:13:3 - error TS2741: Property 'ja' is missing in type '{ en: { hello: string; }; }' but required in type '{ en: ResourceSchema; ja: ResourceSchema; }'.
-
-13   messages: {
-     ~~~~~~~~
-
-  ../../node_modules/@intlify/core/node_modules/@intlify/core-base/dist/core-base.d.ts:125:5
-    125     messages?: {
-            ~~~~~~~~
-    The expected type comes from property 'messages' which is declared here on type 'CoreOptions<string, { message: ResourceSchema; datetime: DateTimeFormat; number: NumberFormat; }, { messages: "en"; datetimeFormats: "en"; numberFormats: "en"; } | { ...; }, ... 8 more ..., NumberFormats<...>>'
-
-
-Found 1 error in index.ts:13
-```
-
-If you are using [Visual Studio Code](https://code.visualstudio.com/) as an editor, you can notice that there is a resource definition omission in the editor with the following error before you run the typescript compilation.
-
-![Type-safe resources](assets/typesafe-schema.png)
-
 ## 🖌️ Resource keys completion
 
 <!-- eslint-disable markdown/no-missing-label-refs -- NOTE(kazupon): ignore github alert -->

packages/h3/playground/basic/index.ts

@@ -1,14 +1,10 @@
 import { H3 } from 'h3'
 import { serve } from 'srvx'
-import {
-  detectLocaleFromAcceptLanguageHeader,
-  plugin as i18n,
-  useTranslation
-} from '../../src/index.ts' // `@intlify/h3`
+import { detectLocaleFromAcceptLanguageHeader, intlify, useTranslation } from '../../src/index.ts' // `@intlify/h3`
 
 const app = new H3({
   plugins: [
-    i18n({
+    intlify({
       locale: detectLocaleFromAcceptLanguageHeader,
       messages: {
         en: {

packages/h3/playground/global-schema/index.ts

@@ -1,10 +1,6 @@
 import { H3 } from 'h3'
 import { serve } from 'srvx'
-import {
-  detectLocaleFromAcceptLanguageHeader,
-  plugin as i18n,
-  useTranslation
-} from '../../src/index.ts' // in your project, `import { ... } from '@intlify/h3'`
+import { detectLocaleFromAcceptLanguageHeader, intlify, useTranslation } from '../../src/index.ts' // in your project, `import { ... } from '@intlify/h3'`
 
 import en from './locales/en.ts'
 import ja from './locales/ja.ts'
@@ -20,7 +16,7 @@ declare module '../../src/index.ts' {
 
 const app = new H3({
   plugins: [
-    i18n({
+    intlify({
       locale: detectLocaleFromAcceptLanguageHeader,
       messages: {
         en,

packages/h3/playground/local-schema/index.ts

@@ -1,17 +1,13 @@
 import { H3 } from 'h3'
 import { serve } from 'srvx'
-import {
-  detectLocaleFromAcceptLanguageHeader,
-  plugin as i18n,
-  useTranslation
-} from '../../src/index.ts' // in your project, `import { ... } from '@intlify/h3'`
+import { detectLocaleFromAcceptLanguageHeader, intlify, useTranslation } from '../../src/index.ts' // in your project, `import { ... } from '@intlify/h3'`
 
 import en from './locales/en.ts'
 import ja from './locales/ja.ts'
 
 const app = new H3({
   plugins: [
-    i18n({
+    intlify({
       locale: detectLocaleFromAcceptLanguageHeader,
       messages: {
         en,

packages/h3/playground/typesafe-schema/index.ts

@@ -5,7 +5,7 @@ import { delay as sleep } from '../../shared/src/index.ts'
 import {
   detectLocaleFromAcceptLanguageHeader,
   getQueryLocale,
-  plugin as i18n,
+  intlify,
   useTranslation
 } from '../src/index.ts'
 
@@ -22,7 +22,7 @@ afterEach(() => {
 test('translation', async () => {
   app = new H3({
     plugins: [
-      i18n({
+      intlify({
         locale: detectLocaleFromAcceptLanguageHeader,
         messages: {
           en: {
@@ -62,7 +62,7 @@ describe('custom locale detection', () => {
 
     app = new H3({
       plugins: [
-        i18n({
+        intlify({
           locale: localeDetector,
           messages: {
             en: {
@@ -115,7 +115,7 @@ describe('custom locale detection', () => {
 
     app = new H3({
       plugins: [
-        i18n({
+        intlify({
           locale: localeDetector,
           messages: {
             en: {
@@ -156,21 +156,21 @@ describe('custom locale detection', () => {
     // async locale detector
     const localeDetector = async (
       event: H3Event,
-      i18n: CoreContext<string, DefineLocaleMessage>
+      intlify: CoreContext<string, DefineLocaleMessage>
     ) => {
       const locale = getQueryLocale(event.req).toString()
       await sleep(100)
       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
     }
 
     app = new H3({
       plugins: [
-        i18n({
+        intlify({
           locale: localeDetector,
           messages: {
             en: {

packages/h3/playground/typesafe-schema/locales/en.ts

@@ -119,7 +119,7 @@ export type I18nPluginOptions<
  *   ]
  * })
  */
-export const plugin = definePlugin<I18nPluginOptions>((h3, options) => {
+export const intlify = definePlugin<I18nPluginOptions>((h3, options) => {
   const { onRequest, onResponse } = defineI18nMiddleware(options)
   h3.use(onRequest)
   h3.use(onResponse)