feat: Quick parameters rename as naming is confusing

tolgee · Mar 11, 2022 · df62d9a · df62d9a
1 parent 7ccbdb3
commit df62d9a
Show file tree

Hide file tree

Showing 11 changed files with 19 additions and 16 deletions.
diff --git a/packages/core/src/Properties.test.ts b/packages/core/src/Properties.test.ts
@@ -61,8 +61,8 @@ describe('Properties', () => {
       const defaultLanguage = 'cs';
       properties.config = new TolgeeConfig({
         defaultLanguage,
-        languageStore: false,
-        languageDetect: false,
+        enableLanguageStore: false,
+        enableLanguageDetection: false,
       });
       expect(properties.currentLanguage).toEqual(defaultLanguage);
 

diff --git a/packages/core/src/Properties.ts b/packages/core/src/Properties.ts
@@ -19,14 +19,14 @@ export class Properties {
       return this._currentLanguage;
     }
 
-    if (this.config.languageStore) {
+    if (this.config.enableLanguageStore) {
       const storedLanguage = this.getStoredLanguage();
       if (storedLanguage) {
         return storedLanguage;
       }
     }
 
-    if (this.config.languageDetect) {
+    if (this.config.enableLanguageDetection) {
       const detectedLanguage = this.getLanguageByNavigator();
       if (detectedLanguage) {
         return detectedLanguage;
@@ -42,7 +42,10 @@ export class Properties {
     }
     this._currentLanguage = language;
 
-    if (this.config?.languageStore && typeof localStorage !== 'undefined') {
+    if (
+      this.config?.enableLanguageStore &&
+      typeof localStorage !== 'undefined'
+    ) {
       localStorage.setItem(CURRENT_LANGUAGE_LOCAL_STORAGE_KEY, language);
     }
   }

diff --git a/packages/core/src/TolgeeConfig.ts b/packages/core/src/TolgeeConfig.ts
@@ -37,11 +37,11 @@ export class TolgeeConfig {
   /**
    * Store user language in localStorage (default: true)
    */
-  languageStore?: boolean = true;
+  enableLanguageStore?: boolean = true;
   /**
    * Use auto language detection by browser locale (default: true)
    */
-  languageDetect?: boolean = true;
+  enableLanguageDetection?: boolean = true;
   filesUrlPrefix?: string = 'i18n/';
   watch?: boolean;
   ui?: (new (...args) => any) | (() => Promise<new (...args) => any>);

diff --git a/packages/i18next/src/withTolgee.ts b/packages/i18next/src/withTolgee.ts
@@ -8,8 +8,8 @@ import { tolgeeProcessor } from './tolgeeProcessor';
 export const withTolgee = (i18n: i18n, config: TolgeeConfig) => {
   const tolgee = Tolgee.init({
     wrapperMode: 'invisible',
-    languageDetect: false,
-    languageStore: false,
+    enableLanguageDetection: false,
+    enableLanguageStore: false,
     ...config,
   });
   i18n.use(tolgeeBackend(tolgee));

diff --git a/testapps/gatsby/src/views/AppWrapper.tsx b/testapps/gatsby/src/views/AppWrapper.tsx
@@ -15,7 +15,7 @@ export const AppWrapper: React.FC = ({ children }) => {
       wrapperMode="invisible"
       fallbackLanguage="en"
       // remove this to enable language auto detection
-      languageDetect={false}
+      enableLanguageDetection={false}
       staticData={{
         de: () => import('../i18n/de.json'),
         cs: () => import('../i18n/cs.json'),

diff --git a/testapps/next-internal/pages/index.tsx b/testapps/next-internal/pages/index.tsx
@@ -29,7 +29,7 @@ const Home: NextPage = () => {
         de: deLocale,
       }}
       // remove this to enable language auto detection
-      languageDetect={false}
+      enableLanguageDetection={false}
     >
       <div className={styles.container}>
         <Head>

diff --git a/testapps/next/src/pages/_app.tsx b/testapps/next/src/pages/_app.tsx
@@ -22,7 +22,7 @@ function MyApp({ Component, pageProps, locales }: AppProps & { locales: any }) {
         ...locales,
       }}
       // remove this to enable language auto detection
-      languageDetect={false}
+      enableLanguageDetection={false}
       loadingFallback={<div>Loading...</div>}
       ui={apiKey ? require('@tolgee/ui').UI : undefined}
     >

diff --git a/testapps/ngx/projects/sampleapp/src/app/app-routing.module.ts b/testapps/ngx/projects/sampleapp/src/app/app-routing.module.ts
@@ -36,7 +36,7 @@ const routes: Routes = [
         fr: () => import('../i18n/fr.json'),
       },
       // remove this to enable language auto detection
-      languageDetect: false,
+      enableLanguageDetection: false,
       preloadFallback: true,
       apiUrl: environment.tolgeeApiUrl,
       apiKey: environment.tolgeeApiKey,

diff --git a/testapps/react/src/App.tsx b/testapps/react/src/App.tsx
@@ -18,7 +18,7 @@ export const App = () => {
       apiKey={process.env.REACT_APP_TOLGEE_API_KEY}
       loadingFallback={<div>Loading...</div>}
       // remove this to enable language auto detection
-      languageDetect={false}
+      enableLanguageDetection={false}
       ui={
         process.env.REACT_APP_TOLGEE_API_KEY
           ? require('@tolgee/ui').UI

diff --git a/testapps/svelte/src/routes/__layout.svelte b/testapps/svelte/src/routes/__layout.svelte
@@ -8,7 +8,7 @@
     apiKey: import.meta.env.VITE_TOLGEE_API_KEY,
     ui: import.meta.env.VITE_TOLGEE_API_KEY ? UI : undefined,
     // remove this to enable language auto detection
-    languageDetect: false,
+    enableLanguageDetection: false,
     staticData: {
       en: () => import('../i18n/en.json').then((m) => m.default),
       de: () => import('../i18n/de.json').then((m) => m.default),

diff --git a/testapps/vue/src/App.vue b/testapps/vue/src/App.vue
@@ -35,7 +35,7 @@ export default defineComponent({
           cs: () => import('../i18n/cs.json'),
         },
         // remove this to enable language auto detection
-        languageDetect: false,
+        enableLanguageDetection: false,
         apiUrl: process.env.VUE_APP_TOLGEE_API_URL,
         apiKey: process.env.VUE_APP_TOLGEE_API_KEY,
         ui: process.env.VUE_APP_TOLGEE_API_KEY