Skip to content
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

Jump to bottom

feat: add Paths type for type safety #1108

Merged
merged 2 commits into from
Jul 17, 2023
Merged

feat: add Paths type for type safety #1108

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
00f9419
feat: add Paths type for type safety
aralroca Jul 17, 2023
8489f69
fix to satisfy the constraint 'string'
aralroca Jul 17, 2023
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
23 changes: 23 additions & 0 deletions examples/with-app-directory/next-translate.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
import type { Paths, I18n, Translate } from 'next-translate'

export interface TranslationsKeys {
common: Paths<typeof import('./locales/en/common.json')>
home: Paths<typeof import('./locales/en/home.json')>
}

export interface TypeSafeTranslate<Namespace extends keyof TranslationsKeys>
extends Omit<I18n, 't'> {
t: {
(
key: TranslationsKeys[Namespace],
...rest: Tail<Parameters<Translate>>
): string
<T extends string>(template: TemplateStringsArray): string
}
}

declare module 'next-translate/useTranslation' {
export default function useTranslation<
Namespace extends keyof TranslationsKeys
>(namespace: Namespace): TypeSafeTranslate<Namespace>
}
53 changes: 53 additions & 0 deletions src/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,6 +143,59 @@ declare global {
}
}

//////// For type safety (next-translate.d.ts): ///////////
/*
*
* import type { Paths, I18n, Translate } from "next-translate";
*
* export interface TranslationsKeys {
* common: Paths<typeof import("./locales/en/common.json")>;
* home: Paths<typeof import("./locales/en/home.json")>;
* }
*
* export interface TypeSafeTranslate<Namespace extends keyof TranslationsKeys>
* extends Omit<I18n, "t"> {
* t: {
* (key: TranslationsKeys[Namespace], ...rest: Tail<Parameters<Translate>>): string;
* <T extends string>(template: TemplateStringsArray): string;
* };
* }
*
* declare module "next-translate/useTranslation" {
* export default function useTranslation<
* Namespace extends keyof TranslationsKeys,
* >(namespace: Namespace): TypeSafeTranslate<Namespace>;
* }
*/

type RemovePlural<Key extends string> = Key extends `${infer Prefix}${
| '_zero'
| '_one'
| '_two'
| '_few'
| '_many'
| '_other'
| `_${infer Num}`}`
? Prefix
: Key

type Join<S1, S2> = S1 extends string
? S2 extends string
? `${S1}.${S2}`
: never
: never

// @ts-ignore
export type Paths<T> = RemovePlural<
// @ts-ignore
{
// @ts-ignore
[K in Extract<keyof T, string>]: T[K] extends Record<string, unknown>
? Join<K, Paths<T[K]>>
: K
}[Extract<keyof T, string>]
>

// TODO: Remove this in future versions > 2.0.0
function nextTranslate(nextConfig: NextConfig = {}): NextConfig {
console.log(`
Expand Down
Loading