Remove deprecated composables

.changeset/new-turkeys-pump.md

@@ -0,0 +1,27 @@
+---
+'@vintl/vintl': major
+---
+
+Remove deprecated composables
+
+Composables, such as `useI18n`, `useTranslate` and `useFormatters` were previously deprecated with the warning that they will be removed in the next major version. They now get removed as scheduled.
+
+Migration steps:
+
+- Use `useVIntl` everywhere you used `useI18n`, the latter was just an alias for `useVIntl` in previous versions.
+
+- To retrieve translate function previously returned by `useTranslate`, destructure `formatMessage` function from the controller:
+
+  ```js
+  const { formatMessage } = useVIntl
+  ```
+
+  It is bound to the controller and as such is safe to use on its own.
+
+- To retrieve formatters previously returned by `useFormatters`, destructure `formats` property from the controller:
+
+  ```js
+  const { formats } = useVIntl
+  ```
+
+  It is reactively updated object and also safe to use on its own.

src/runtime/index.ts

@@ -1,3 +1 @@
-export { useI18n, useVIntl } from './useI18n.js'
-export { useFormatters } from './useFormatters.js'
-export { useTranslate } from './useTranslate.js'
+export { useVIntl } from './useVIntl.js'

src/runtime/useI18n.ts → src/runtime/useVIntl.ts

@@ -20,13 +20,3 @@ export function useVIntl<ControllerType = MessageValueType>() {
 
   return controller as IntlController<ControllerType>
 }
-
-/**
- * Alias for {@link useVIntl}.
- *
- * @deprecated This composable name is deprecated and will be removed in next
- *   major version. Please use {@link useVIntl} instead.
- */
-export function useI18n<ControllerType = MessageValueType>() {
-  return useVIntl<ControllerType>()
-}

test/index.test.ts

@@ -3,7 +3,7 @@ import { describe, expect, test, vi } from 'vitest'
 import { type App, createApp, defineComponent } from 'vue'
 import {
   type PreferredLocalesSource,
-  useI18n,
+  useVIntl,
   type LocaleDescriptor,
 } from '../dist'
 import { type IntlController, createController } from '../dist/controller'
@@ -35,7 +35,7 @@ let controller: IntlController<string>
 const appComponent = defineComponent({
   name: 'App',
   setup() {
-    const i18nResult = useI18n()
+    const i18nResult = useVIntl()
     return { i18nResult }
   },
 })