🤖 Merge PR DefinitelyTyped#72666 feat(gettext.js): bump version, fix incorrect types, add tests by @hkleungai

Author: hkleungai

types/gettext.js/gettext.js-tests.ts

@@ -2,23 +2,92 @@ import Gettext = require("gettext.js");
 
 const instance = Gettext();
 
-const json: Gettext.JsonData = {
-    "": {
+{
+    const messages = {
         language: "fr",
         "plural-forms": "nplurals=2; plural=n>1;",
-    },
-    Welcome: "Bienvenue",
-    "There is %1 apple": [
-        "Il y a %1 pomme",
-        "Il y a %1 pommes",
-    ],
-};
-
-instance.loadJSON(json, "messages");
-instance.setLocale("fr");
-if (instance.ngettext("There is %1 apple", "There are %1 apples", 0) !== "Il y a 0 pomme") {
-    throw new Error("Failed test");
-}
-if (instance.strfmt("There are %1 apples", 0) !== "There are 0 apples") {
-    throw new Error("Failed test");
+    } satisfies Gettext.JsonDataMessages;
+
+    // $ExpectType Gettext
+    instance
+        .setMessages("domain", "fr", messages)
+        .setMessages("domain", "fr", messages, "nplurals=2; plural=n>1;");
+}
+
+{
+    const json = {
+        "": {
+            language: "fr",
+            "plural-forms": "nplurals=2; plural=n>1;",
+        },
+        Welcome: "Bienvenue",
+        "There is %1 apple": [
+            "Il y a %1 pomme",
+            "Il y a %1 pommes",
+        ],
+    } satisfies Gettext.JsonData;
+
+    // $ExpectType Gettext
+    instance
+        .loadJSON(json)
+        .loadJSON(json, "messages");
+}
+
+{
+    // $ExpectType Gettext
+    instance.setLocale("fr");
+}
+
+{
+    // $ExpectType string
+    instance.getLocale();
+}
+
+{
+    // $ExpectType Gettext | string
+    instance.textdomain();
+    // $ExpectType Gettext | string
+    instance.textdomain("domain");
+}
+
+{
+    // $ExpectType string
+    instance.gettext("message id");
+    // $ExpectType string
+    instance.gettext("message id", "arg 1", "arg 2");
+}
+
+{
+    // $ExpectType string
+    instance.ngettext("There is %1 apple", "There are %1 apples", 0);
+    // $ExpectType string
+    instance.ngettext("There is %1 apple", "There are %1 apples", 0, "arg 1", "arg 2");
+}
+
+{
+    // $ExpectType string
+    instance.pgettext("There is %1 apple", "There are %1 apples");
+    // $ExpectType string
+    instance.pgettext("There is %1 apple", "There are %1 apples", "arg 1", "arg 2");
+}
+
+declare const nullableStr: string | null | undefined;
+declare const nullableNum: number | null | undefined;
+{
+    // $ExpectType string
+    instance.dcnpgettext(nullableStr, nullableStr, "There are %1 apples", nullableStr, nullableNum);
+    // $ExpectType string
+    instance.dcnpgettext(nullableStr, nullableStr, "There are %1 apples", nullableStr, nullableNum, "arg 1", "arg 2");
+}
+
+{
+    // $ExpectType string
+    instance.strfmt("There is %1 apple");
+    // $ExpectType string
+    instance.strfmt("There is %1 apple", "arg 1", "arg 2");
+}
+
+{
+    // $ExpectType string[]
+    instance.expand_locale("fr");
 }

types/gettext.js/index.d.ts

@@ -24,8 +24,13 @@ declare namespace i18n {
     }
 
     interface Gettext {
-        setMessages(domain: string, locale: string, messages: JsonDataMessages, plural_forms?: PluralForm): Gettext;
-        loadJSON(jsonData: JsonData, domain?: string): Gettext;
+        setMessages(
+            domain: string,
+            locale: string,
+            messages: JsonDataMessages,
+            plural_forms?: string,
+        ): Gettext;
+        loadJSON(jsonData: JsonData | string, domain?: string): Gettext;
         setLocale(locale: string): Gettext;
         getLocale(): string;
         textdomain(domain?: string): Gettext | string;

types/gettext.js/package.json

@@ -1,7 +1,7 @@
 {
     "private": true,
     "name": "@types/gettext.js",
-    "version": "1.0.9999",
+    "version": "2.0.9999",
     "projects": [
         "https://github.com/guillaumepotier/gettext.js"
     ],