tsc test interop vs non-interop

Author: rosskevin

.prettierrc

@@ -0,0 +1,8 @@
+{
+  "bracketSpacing": true,
+  "jsxBracketSameLine": false,
+  "printWidth": 100,
+  "semi": true,
+  "singleQuote": true,
+  "trailingComma": "all"
+}

test/typescript/nonEsModuleInterop/usageNonInterop.ts

@@ -0,0 +1,60 @@
+import LngDetector, { CustomDetector, DetectorOptions } from 'i18next-browser-languagedetector';
+import * as i18next from 'i18next';
+
+/**
+ * NOTE: only the imports should differ in these `usage*.ts` files
+ */
+
+const options: DetectorOptions = {
+  // order and from where user language should be detected
+  order: ['querystring', 'cookie', 'localStorage', 'navigator', 'htmlTag'],
+
+  // keys or params to lookup language from
+  lookupQuerystring: 'lng',
+  lookupCookie: 'i18next',
+  lookupLocalStorage: 'i18nextLng',
+
+  // cache user language on
+  caches: ['localStorage', 'cookie'],
+  excludeCacheFor: ['cimode'], // languages to not persist (cookie, localStorage)
+
+  // optional expire and domain for set cookie
+  cookieMinutes: 10,
+  cookieDomain: 'myDomain',
+
+  // optional htmlTag with lang attribute, the default is:
+  htmlTag: document.documentElement,
+};
+
+const customDetector: CustomDetector = {
+  name: 'myDetectorsName',
+
+  lookup(options: DetectorOptions) {
+    // options -> are passed in options
+    return 'en';
+  },
+
+  cacheUserLanguage(lng: string, options: DetectorOptions) {
+    // options -> are passed in options
+    // lng -> current language, will be called after init and on changeLanguage
+    // store it
+  },
+};
+
+const customDetector2: CustomDetector = {
+  name: 'myDetectorsName',
+  lookup(options: DetectorOptions) {
+    return undefined;
+  },
+};
+
+const lngDetector = new LngDetector(null, options);
+
+lngDetector.init(options);
+lngDetector.addDetector(customDetector);
+
+// instance based
+i18next.use(lngDetector).init({});
+
+// class based
+i18next.use(LngDetector).init({});

test/typescript/i18next-browser-languageDetector.ts test/typescript/usageInterop.ts

@@ -1,52 +1,60 @@
-import LngDetector, {
-  CustomDetector,
-  DetectorOptions
-} from "i18next-browser-languagedetector";
+import LngDetector, { CustomDetector, DetectorOptions } from 'i18next-browser-languagedetector';
+import i18next from 'i18next';
+
+/**
+ * NOTE: only the imports should differ in these `usage*.ts` files
+ */
 
 const options: DetectorOptions = {
   // order and from where user language should be detected
-  order: ["querystring", "cookie", "localStorage", "navigator", "htmlTag"],
+  order: ['querystring', 'cookie', 'localStorage', 'navigator', 'htmlTag'],
 
   // keys or params to lookup language from
-  lookupQuerystring: "lng",
-  lookupCookie: "i18next",
-  lookupLocalStorage: "i18nextLng",
+  lookupQuerystring: 'lng',
+  lookupCookie: 'i18next',
+  lookupLocalStorage: 'i18nextLng',
 
   // cache user language on
-  caches: ["localStorage", "cookie"],
-  excludeCacheFor: ["cimode"], // languages to not persist (cookie, localStorage)
+  caches: ['localStorage', 'cookie'],
+  excludeCacheFor: ['cimode'], // languages to not persist (cookie, localStorage)
 
   // optional expire and domain for set cookie
   cookieMinutes: 10,
-  cookieDomain: "myDomain",
+  cookieDomain: 'myDomain',
 
   // optional htmlTag with lang attribute, the default is:
-  htmlTag: document.documentElement
+  htmlTag: document.documentElement,
 };
 
 const customDetector: CustomDetector = {
-  name: "myDetectorsName",
+  name: 'myDetectorsName',
 
   lookup(options: DetectorOptions) {
     // options -> are passed in options
-    return "en";
+    return 'en';
   },
 
   cacheUserLanguage(lng: string, options: DetectorOptions) {
     // options -> are passed in options
     // lng -> current language, will be called after init and on changeLanguage
     // store it
-  }
+  },
 };
 
 const customDetector2: CustomDetector = {
-  name: "myDetectorsName",
+  name: 'myDetectorsName',
   lookup(options: DetectorOptions) {
     return undefined;
-  }
+  },
 };
 
 const lngDetector = new LngDetector(null, options);
 
 lngDetector.init(options);
 lngDetector.addDetector(customDetector);
+
+// instance based
+i18next.use(lngDetector).init({});
+
+// class based
+i18next.use(LngDetector).init({});

test/typescript/usageLegacy.ts

@@ -0,0 +1,60 @@
+import LngDetector, { CustomDetector, DetectorOptions } from 'i18next-browser-languagedetector';
+import * as i18next from 'i18next';
+
+/**
+ * NOTE: only the imports should differ in these `usage*.ts` files
+ */
+
+const options: DetectorOptions = {
+  // order and from where user language should be detected
+  order: ['querystring', 'cookie', 'localStorage', 'navigator', 'htmlTag'],
+
+  // keys or params to lookup language from
+  lookupQuerystring: 'lng',
+  lookupCookie: 'i18next',
+  lookupLocalStorage: 'i18nextLng',
+
+  // cache user language on
+  caches: ['localStorage', 'cookie'],
+  excludeCacheFor: ['cimode'], // languages to not persist (cookie, localStorage)
+
+  // optional expire and domain for set cookie
+  cookieMinutes: 10,
+  cookieDomain: 'myDomain',
+
+  // optional htmlTag with lang attribute, the default is:
+  htmlTag: document.documentElement,
+};
+
+const customDetector: CustomDetector = {
+  name: 'myDetectorsName',
+
+  lookup(options: DetectorOptions) {
+    // options -> are passed in options
+    return 'en';
+  },
+
+  cacheUserLanguage(lng: string, options: DetectorOptions) {
+    // options -> are passed in options
+    // lng -> current language, will be called after init and on changeLanguage
+    // store it
+  },
+};
+
+const customDetector2: CustomDetector = {
+  name: 'myDetectorsName',
+  lookup(options: DetectorOptions) {
+    return undefined;
+  },
+};
+
+const lngDetector = new LngDetector(null, options);
+
+lngDetector.init(options);
+lngDetector.addDetector(customDetector);
+
+// instance based
+i18next.use(lngDetector).init({});
+
+// class based
+i18next.use(LngDetector).init({});

tsconfig.json

@@ -9,7 +9,12 @@
     "strict": true,
     "noEmit": true,
     "baseUrl": ".",
+
+    "esModuleInterop": true,
+    "allowSyntheticDefaultImports": true,
+
     "paths": { "i18next-browser-languagedetector": ["./index.d.ts"] }
   },
-  "include": ["./indext.d.ts", "./test/**/*.ts*"]
+  "include": ["./indext.d.ts", "./test/**/*.ts*"],
+  "exclude": ["test/typescript/nonEsModuleInterop/**/*.ts"]
 }

tsconfig.nonEsModuleInterop.json

@@ -0,0 +1,10 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    // typescript defaults to these
+    "esModuleInterop": false,
+    "allowSyntheticDefaultImports": false
+  },
+  "include": ["./test/typescript/nonEsModuleInterop/**/*.ts"],
+  "exclude": []
+}