>(WrappedComponent: React.ComponentType | React.ElementType): React.ComponentType
| React.ElementType
=> { +export const appWithTranslation =
>( + WrappedComponent: React.ComponentType | React.ElementType): + React.ComponentType
| React.ElementType
=> { const AppWithTranslation = (props: AppProps) => { let i18n = null let locale = null @@ -27,7 +29,7 @@ export const appWithTranslation =
>(WrappedCom
const parsedUserConfig = Function(`'use strict';return(${userConfig})`)()
locale = initialLocale;
-
+
({ i18n } = createClient({
...createConfig({
...parsedUserConfig,
diff --git a/src/config/createConfig.test.ts b/src/config/createConfig.test.ts
index 4d0f313f..21c589a7 100644
--- a/src/config/createConfig.test.ts
+++ b/src/config/createConfig.test.ts
@@ -19,14 +19,14 @@ describe('createConfig', () => {
(fs.existsSync as jest.Mock).mockReturnValue(true);
(fs.readdirSync as jest.Mock).mockReturnValue([])
})
-
+
it('throws when lng is not provided', () => {
expect(createConfig).toThrow('config.lng was not passed into createConfig')
})
-
+
it('returns a valid config when only lng is provided', () => {
const config = createConfig({ lng: 'en' } as UserConfig)
-
+
expect((config.backend as any).addPath).toMatch('/public/locales/{{lng}}/{{ns}}.missing.json')
expect((config.backend as any).loadPath).toMatch('/public/locales/{{lng}}/{{ns}}.json')
expect(config.defaultLocale).toEqual('en')
@@ -49,20 +49,20 @@ describe('createConfig', () => {
it('deep merges backend', () => {
const config = createConfig({
- lng: 'en',
backend: {
hello: 'world',
- }
+ },
+ lng: 'en',
} as UserConfig)
expect((config.backend as any).hello).toEqual('world')
})
it('deep merges detection', () => {
const config = createConfig({
- lng: 'en',
detection: {
hello: 'world',
- }
+ },
+ lng: 'en',
} as UserConfig)
expect((config.detection as any).hello).toEqual('world')
})
@@ -73,7 +73,7 @@ describe('createConfig', () => {
(fs.existsSync as jest.Mock).mockReturnValueOnce(false)
const config = createConfig.bind(null, {
- lng: 'en'
+ lng: 'en',
})
expect(config).toThrow('Default namespace not found at public/locales/en/common.json')
@@ -84,21 +84,21 @@ describe('createConfig', () => {
it('returns a config without calling any fs methods', () => {
(fs.existsSync as jest.Mock).mockReset();
(fs.readdirSync as jest.Mock).mockReset()
-
+
createConfig({
lng: 'en', use: [{
- type: 'backend'
+ type: 'backend',
}] } as UserConfig)
-
+
expect(fs.existsSync).toHaveBeenCalledTimes(0)
expect(fs.readdirSync).toHaveBeenCalledTimes(0)
})
})
- describe('ci mode', () => {
+ describe('ci mode', () => {
it('returns a config without calling any fs methods', () => {
createConfig({ lng: 'cimode' } as UserConfig)
-
+
expect(fs.existsSync).toHaveBeenCalledTimes(0)
expect(fs.readdirSync).toHaveBeenCalledTimes(0)
})
@@ -113,10 +113,10 @@ describe('createConfig', () => {
it('throws when lng is not provided', () => {
expect(createConfig).toThrow('config.lng was not passed into createConfig')
})
-
+
it('returns a valid config when only lng is provided', () => {
const config = createConfig({ lng: 'en' } as UserConfig)
-
+
expect((config.backend as any).addPath).toMatch('/public/locales/{{lng}}/{{ns}}.missing.json')
expect((config.backend as any).loadPath).toMatch('/public/locales/{{lng}}/{{ns}}.json')
expect(config.defaultLocale).toEqual('en')
@@ -129,7 +129,7 @@ describe('createConfig', () => {
expect(config.localeStructure).toEqual('{{lng}}/{{ns}}')
expect(config.locales).toEqual(['en'])
expect(config.ns).toEqual(['common'])
- expect(config.preload).toEqual(undefined)
+ expect(config.preload).toBeUndefined()
expect(config.strictMode).toEqual(true)
expect(config.use).toEqual([])
})
diff --git a/src/config/createConfig.ts b/src/config/createConfig.ts
index dde30fbb..b311f238 100644
--- a/src/config/createConfig.ts
+++ b/src/config/createConfig.ts
@@ -8,9 +8,9 @@ export const createConfig = (userConfig: UserConfig): InternalConfig => {
throw new Error('config.lng was not passed into createConfig')
}
- /*
- Initial merge of default and user-provided config
- */
+ //
+ // Initial merge of default and user-provided config
+ //
const { i18n: userI18n, ...userConfigStripped } = userConfig
const { i18n: defaultI18n, ...defaultConfigStripped } = defaultConfig
const combinedConfig = {
@@ -46,10 +46,10 @@ export const createConfig = (userConfig: UserConfig): InternalConfig => {
const path = require('path')
const serverLocalePath = localePath
- /*
- Validate defaultNS
- https://github.com/isaachinman/next-i18next/issues/358
- */
+ //
+ // Validate defaultNS
+ // https://github.com/isaachinman/next-i18next/issues/358
+ //
if (typeof combinedConfig.defaultNS === 'string') {
const defaultFile = `/${lng}/${combinedConfig.defaultNS}.${localeExtension}`
const defaultNSPath = path.join(localePath, defaultFile)
@@ -59,17 +59,17 @@ export const createConfig = (userConfig: UserConfig): InternalConfig => {
}
}
- /*
- Set server side backend
- */
+ //
+ // Set server side backend
+ //
combinedConfig.backend = {
- loadPath: path.resolve(process.cwd(), `${serverLocalePath}/${localeStructure}.${localeExtension}`),
addPath: path.resolve(process.cwd(), `${serverLocalePath}/${localeStructure}.missing.${localeExtension}`),
+ loadPath: path.resolve(process.cwd(), `${serverLocalePath}/${localeStructure}.${localeExtension}`),
}
- /*
- Set server side preload (namespaces)
- */
+ //
+ // Set server side preload (namespaces)
+ //
if (!combinedConfig.ns) {
const getAllNamespaces = p => fs.readdirSync(p).map(file => file.replace(`.${localeExtension}`, ''))
combinedConfig.ns = getAllNamespaces(path.resolve(process.cwd(), `${serverLocalePath}/${lng}`))
@@ -79,27 +79,27 @@ export const createConfig = (userConfig: UserConfig): InternalConfig => {
let clientLocalePath = localePath
- /*
- Remove public prefix from client site config
- */
+ //
+ // Remove public prefix from client site config
+ //
if (localePath.startsWith('/public/')) {
clientLocalePath = localePath.replace(/^\/public/, '')
}
- /*
- Set client side backend
- */
+ //
+ // Set client side backend
+ //
combinedConfig.backend = {
- loadPath: `${clientLocalePath}/${localeStructure}.${localeExtension}`,
addPath: `${clientLocalePath}/${localeStructure}.missing.${localeExtension}`,
+ loadPath: `${clientLocalePath}/${localeStructure}.${localeExtension}`,
}
combinedConfig.ns = [combinedConfig.defaultNS]
}
- /*
- Deep merge with overwrite - goes last
- */
+ //
+ // Deep merge with overwrite - goes last
+ //
deepMergeObjects.forEach((obj) => {
if (userConfig[obj]) {
combinedConfig[obj] = {
diff --git a/src/config/defaultConfig.ts b/src/config/defaultConfig.ts
index 0c62dc38..0eb78e46 100644
--- a/src/config/defaultConfig.ts
+++ b/src/config/defaultConfig.ts
@@ -6,29 +6,28 @@ const LOCALE_STRUCTURE = '{{lng}}/{{ns}}'
const LOCALE_EXTENSION = 'json'
export const defaultConfig = {
+ defaultNS: DEFAULT_NAMESPACE,
+ errorStackTraceLimit: 0,
i18n: {
defaultLocale: DEFAULT_LOCALE,
locales: LOCALES,
},
-
- load: 'currentOnly',
- localePath: LOCALE_PATH,
- localeStructure: LOCALE_STRUCTURE,
- localeExtension: LOCALE_EXTENSION,
- use: [],
- defaultNS: DEFAULT_NAMESPACE,
+ get initImmediate(): boolean {
+ return process.browser
+ },
interpolation: {
escapeValue: false,
- formatSeparator: ',',
format: (value: string, format: string): string => (format === 'uppercase' ? value.toUpperCase() : value),
+ formatSeparator: ',',
},
+ load: 'currentOnly',
+ localeExtension: LOCALE_EXTENSION,
+ localePath: LOCALE_PATH,
+ localeStructure: LOCALE_STRUCTURE,
react: {
- wait: true,
useSuspense: false,
+ wait: true,
},
strictMode: true,
- errorStackTraceLimit: 0,
- get initImmediate(): boolean {
- return process.browser
- }
+ use: [],
}
diff --git a/src/createClient/.eslintrc.json b/src/createClient/.eslintrc.json
new file mode 100644
index 00000000..cf664baf
--- /dev/null
+++ b/src/createClient/.eslintrc.json
@@ -0,0 +1,5 @@
+{
+ "rules": {
+ "import/no-default-export": "off"
+ }
+}
diff --git a/src/createClient/browser.test.ts b/src/createClient/browser.test.ts
index 7cb27e22..12c67a18 100644
--- a/src/createClient/browser.test.ts
+++ b/src/createClient/browser.test.ts
@@ -13,7 +13,9 @@ describe('createClientBrowser', () => {
expect(typeof client.initPromise.then).toEqual('function')
expect(typeof client.i18n.addResource).toEqual('function')
expect(typeof (client.i18n as any).translator).toEqual('object')
- expect((client.i18n.options as any).defaultLocale).toEqual(config.defaultLocale)
+ expect(
+ (client.i18n.options as any).defaultLocale
+ ).toEqual(config.defaultLocale)
expect((client.i18n.options as any).locales).toEqual(config.locales)
})
})
diff --git a/src/createClient/node.test.ts b/src/createClient/node.test.ts
index 9a7d2d9b..a977efc6 100644
--- a/src/createClient/node.test.ts
+++ b/src/createClient/node.test.ts
@@ -13,7 +13,9 @@ describe('createClientBrowser', () => {
expect(typeof client.initPromise.then).toEqual('function')
expect(typeof client.i18n.addResource).toEqual('function')
expect(typeof (client.i18n as any).translator).toEqual('object')
- expect((client.i18n.options as any).defaultLocale).toEqual(config.defaultLocale)
+ expect(
+ (client.i18n.options as any).defaultLocale
+ ).toEqual(config.defaultLocale)
expect((client.i18n.options as any).locales).toEqual(config.locales)
})
})
diff --git a/src/serverSideTranslations.ts b/src/serverSideTranslations.ts
index feb907d2..32a4151e 100644
--- a/src/serverSideTranslations.ts
+++ b/src/serverSideTranslations.ts
@@ -32,7 +32,7 @@ export const serverSideTranslations = async (
await initPromise
const initialI18nStore = {
- [initialLocale]: {}
+ [initialLocale]: {},
}
namespacesRequired.forEach((ns) => {
@@ -46,6 +46,6 @@ export const serverSideTranslations = async (
initialI18nStore,
initialLocale,
userConfig: serialize(userConfig),
- }
+ },
}
}
diff --git a/src/utils/consoleMessage.test.ts b/src/utils/consoleMessage.test.ts
index f6d25885..af03b4fc 100644
--- a/src/utils/consoleMessage.test.ts
+++ b/src/utils/consoleMessage.test.ts
@@ -1,10 +1,12 @@
+/* eslint-disable no-console */
+
import { consoleMessage } from '../../src/utils'
import { InternalConfig } from '../../types'
const consoleMessageStrictMode = (type, message) =>
consoleMessage(type, message, {
- strictMode: true,
errorStackTraceLimit: 0,
+ strictMode: true,
} as InternalConfig)
const consoleMessageNotStrictMode = (type, message) =>
@@ -90,20 +92,22 @@ describe('consoleMessage utility function', () => {
consoleMessageStrictMode('info', ['An', 'array', 'of', 'message'])
consoleMessageStrictMode('info', () => 'Function message')
- const [[errorObject1], [errorObject2], [errorObject3]] = consoleErrSpy.mock.calls
+ const [
+ [errorObject1], [errorObject2], [errorObject3],
+ ] = consoleErrSpy.mock.calls
expect(errorObject1.name).toBe('Meta')
expect(errorObject1.message).toMatch(
- "Param message needs to be of type: string. Instead, 'object' was provided",
+ 'Param message needs to be of type: string. Instead, \'object\' was provided',
)
expect(errorObject2.name).toBe('Meta')
expect(errorObject2.message).toMatch(
- "Param message needs to be of type: string. Instead, 'object' was provided",
+ 'Param message needs to be of type: string. Instead, \'object\' was provided',
)
expect(errorObject3.name).toBe('Meta')
expect(errorObject3.message).toMatch(
- "Param message needs to be of type: string. Instead, 'function' was provided",
+ 'Param message needs to be of type: string. Instead, \'function\' was provided',
)
})
})
diff --git a/src/utils/consoleMessage.ts b/src/utils/consoleMessage.ts
index 567fdd20..976888a2 100644
--- a/src/utils/consoleMessage.ts
+++ b/src/utils/consoleMessage.ts
@@ -1,6 +1,6 @@
/* eslint-disable no-console */
-import { InternalConfig } from "../../types"
+import { InternalConfig } from '../../types'
type MessageType = 'error' | 'info' | 'warn'
@@ -20,7 +20,11 @@ const logMessage = (messageType: MessageType, message: string) => {
}
}
-export const consoleMessage = (messageType: MessageType, message: string, config: InternalConfig): void => {
+export const consoleMessage = (
+ messageType: MessageType,
+ message: string,
+ config: InternalConfig
+): void => {
const { errorStackTraceLimit, strictMode } = config
@@ -38,20 +42,20 @@ export const consoleMessage = (messageType: MessageType, message: string, config
return
}
- /*
- Temporarily set the stacktrace to 0 or errorStackTraceLimit,
- in order to only display a message
- */
+ //
+ // Temporarily set the stacktrace to 0 or errorStackTraceLimit,
+ // in order to only display a message
+ //
Error.stackTraceLimit = errorStackTraceLimit
- /*
- Make room for new message
- */
+ //
+ // Make room for new message
+ //
console.log()
- /*
- Make sure the message is a string
- */
+ //
+ // Make sure the message is a string
+ //
if (typeof message !== 'string') {
const metaError = new Error()
metaError.name = 'Meta'
@@ -68,14 +72,14 @@ export const consoleMessage = (messageType: MessageType, message: string, config
return
}
- /*
- Log the message to console
- */
+ //
+ // Log the message to console
+ //
logMessage(messageType, message)
- /*
- Reset stack limit
- */
+ //
+ // Reset stack limit
+ //
Error.stackTraceLimit = prevStackLimit
}
diff --git a/types.d.ts b/types.d.ts
index 17fa445a..de66d87c 100644
--- a/types.d.ts
+++ b/types.d.ts
@@ -1,38 +1,36 @@
/* tslint:disable no-explicit-any */
-
-import * as React from 'react'
import {
I18nContext,
useTranslation,
Trans,
withTranslation,
- WithTranslation as ReactI18nextWithTranslation
+ WithTranslation as ReactI18nextWithTranslation,
} from 'react-i18next'
import { InitOptions, i18n, TFunction as I18NextTFunction } from 'i18next'
-import { appWithTranslation } from './src';
+import { appWithTranslation } from './src'
type NextJsI18NConfig = {
- defaultLocale: string;
- locales: string[];
+ defaultLocale: string
+ locales: string[]
}
export type UserConfig = {
- i18n: NextJsI18NConfig;
- localeExtension?: string;
- localePath?: string;
- localeStructure?: string;
- strictMode?: boolean;
- use?: any[];
+ i18n: NextJsI18NConfig
+ localeExtension?: string
+ localePath?: string
+ localeStructure?: string
+ strictMode?: boolean
+ use?: any[]
} & InitOptions
export type InternalConfig = Omit