Skip to content

fix: useI18n wrong type and other type broken #1309

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

Merged
merged 1 commit into from
Jan 11, 2023
Merged

fix: useI18n wrong type and other type broken #1309

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
35 changes: 27 additions & 8 deletions packages/core-base/src/context.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -355,11 +355,22 @@ let _cid = 0
export function createCoreContext<
Message = string,
Options extends CoreOptions<Message> = CoreOptions<Message>,
Messages = Options['messages'] extends object ? Options['messages'] : {},
DateTimeFormats = Options['datetimeFormats'] extends object
Messages extends Record<string, any> = Options['messages'] extends Record<
string,
any
>
? Options['messages']
: {},
DateTimeFormats extends Record<
string,
any
> = Options['datetimeFormats'] extends Record<string, any>
? Options['datetimeFormats']
: {},
NumberFormats = Options['numberFormats'] extends object
NumberFormats extends Record<
string,
any
> = Options['numberFormats'] extends Record<string, any>
? Options['numberFormats']
: {}
>(
Expand All @@ -379,12 +390,20 @@ export function createCoreContext<
SchemaParams<Schema, Message>,
LocaleParams<Locales>
>,
Messages = Options['messages'] extends object ? Options['messages'] : {},
DateTimeFormats = Options['datetimeFormats'] extends object
? Options['datetimeFormats']
Messages extends Record<string, any> = NonNullable<
Options['messages']
> extends Record<string, any>
? NonNullable<Options['messages']>
: {},
NumberFormats = Options['numberFormats'] extends object
? Options['numberFormats']
DateTimeFormats extends Record<string, any> = NonNullable<
Options['datetimeFormats']
> extends Record<string, any>
? NonNullable<Options['datetimeFormats']>
: {},
NumberFormats extends Record<string, any> = NonNullable<
Options['numberFormats']
> extends Record<string, any>
? NonNullable<Options['numberFormats']>
: {}
>(
options: Options
Expand Down
27 changes: 12 additions & 15 deletions packages/vue-i18n-core/src/composer.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1750,23 +1750,20 @@ export function createComposer<
SchemaParams<Schema, VueMessageType>,
LocaleParams<Locales>
>,
Messages extends Record<string, any> = Options['messages'] extends Record<
string,
any
>
? Options['messages']
Messages extends Record<string, any> = NonNullable<
Options['messages']
> extends Record<string, any>
? NonNullable<Options['messages']>
: {},
DateTimeFormats extends Record<
string,
any
> = Options['datetimeFormats'] extends Record<string, any>
? Options['datetimeFormats']
DateTimeFormats extends Record<string, any> = NonNullable<
Options['datetimeFormats']
> extends Record<string, any>
? NonNullable<Options['datetimeFormats']>
: {},
NumberFormats extends Record<
string,
any
> = Options['numberFormats'] extends Record<string, any>
? Options['numberFormats']
NumberFormats extends Record<string, any> = NonNullable<
Options['numberFormats']
> extends Record<string, any>
? NonNullable<Options['numberFormats']>
: {}
>(
options: Options,
Expand Down
31 changes: 14 additions & 17 deletions packages/vue-i18n-core/src/i18n.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -481,23 +481,20 @@ export function createI18n<
SchemaParams<Schema, VueMessageType>,
LocaleParams<Locales>
> = I18nOptions<SchemaParams<Schema, VueMessageType>, LocaleParams<Locales>>,
Messages extends Record<string, unknown> = Options['messages'] extends Record<
string,
unknown
>
? Options['messages']
Messages extends Record<string, unknown> = NonNullable<
Options['messages']
> extends Record<string, unknown>
? NonNullable<Options['messages']>
: {},
DateTimeFormats extends Record<
string,
unknown
> = Options['datetimeFormats'] extends Record<string, unknown>
? Options['datetimeFormats']
DateTimeFormats extends Record<string, unknown> = NonNullable<
Options['datetimeFormats']
> extends Record<string, unknown>
? NonNullable<Options['datetimeFormats']>
: {},
NumberFormats extends Record<
string,
unknown
> = Options['numberFormats'] extends Record<string, unknown>
? Options['numberFormats']
NumberFormats extends Record<string, unknown> = NonNullable<
Options['numberFormats']
> extends Record<string, unknown>
? NonNullable<Options['numberFormats']>
: {},
OptionLocale = Options['locale'] extends string ? Options['locale'] : Locale
>(
Expand Down Expand Up @@ -731,7 +728,7 @@ export function useI18n<Options extends UseI18nOptions = UseI18nOptions>(
NonNullable<Options['messages']>,
NonNullable<Options['datetimeFormats']>,
NonNullable<Options['numberFormats']>,
NonNullable<Options['locale']>
Options['locale'] extends unknown ? string : Options['locale']
>

/**
Expand Down Expand Up @@ -803,7 +800,7 @@ export function useI18n<
NonNullable<Options['messages']>,
NonNullable<Options['datetimeFormats']>,
NonNullable<Options['numberFormats']>,
NonNullable<Options['locale']>
Options['locale'] extends unknown ? string : Options['locale']
>
// eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
export function useI18n<
Expand Down
27 changes: 12 additions & 15 deletions packages/vue-i18n-core/src/legacy.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1439,23 +1439,20 @@ export function createVueI18n<
SchemaParams<Schema, VueMessageType>,
LocaleParams<Locales>
>,
Messages extends Record<string, any> = Options['messages'] extends Record<
string,
any
>
? Options['messages']
Messages extends Record<string, any> = NonNullable<
Options['messages']
> extends Record<string, any>
? NonNullable<Options['messages']>
: {},
DateTimeFormats extends Record<
string,
any
> = Options['datetimeFormats'] extends Record<string, any>
? Options['datetimeFormats']
DateTimeFormats extends Record<string, any> = NonNullable<
Options['datetimeFormats']
> extends Record<string, any>
? NonNullable<Options['datetimeFormats']>
: {},
NumberFormats extends Record<
string,
any
> = Options['numberFormats'] extends Record<string, any>
? Options['numberFormats']
NumberFormats extends Record<string, any> = NonNullable<
Options['numberFormats']
> extends Record<string, any>
? NonNullable<Options['numberFormats']>
: {}
>(
options?: Options,
Expand Down
21 changes: 8 additions & 13 deletions pnpm-lock.yaml
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions test-d/runtime.test-d.ts → test-d/core-base/runtime.test-d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/* eslint-disable @typescript-eslint/no-explicit-any */
import { expectType } from './index'
import { MessageType } from '../packages/runtime/dist/runtime'
import { expectType } from '../index'
import { MessageType } from '../../packages/core-base/src'

/**
* Message Type
Expand Down
7 changes: 7 additions & 0 deletions test-d/vue-i18n/i18n.test-d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -249,6 +249,13 @@ const globalComposer = useI18n<[ResourceSchema], 'en' | 'ja'>({
useScope: 'global'
})
expect<string>(globalComposer.t('nest.bar', { foo: 1 }, { locale: 'ja' }))
expect<'en' | 'ja'>(globalComposer.locale.value)

// no annotation
const localComposer = useI18n({
useScope: 'local'
})
expect<string>(localComposer.locale.value)

expectType<I18nOptions>(looseOptions)
expectType<
Expand Down