Merge pull request #39 from agilebits/ry/upgrades

Upgrade packages and add Prettier

Author: robyoder

.github/workflows/build-and-test.yml

@@ -11,3 +11,4 @@ jobs:
       - run: npm ci
       - run: npm run build
       - run: npm test
+      - run: npm run prettier-check

.prettierignore

@@ -0,0 +1,3 @@
+dist
+package-lock.json
+**/*.js

CREDITS.md

@@ -2,10 +2,10 @@
 
 While this library does not bundle third-party code, we're grateful to the following projects for both inspiration and the feature integrations they make possible:
 
-* Parts of the API were inspired by [format-message](https://github.com/format-message/format-message), Copyright (c) 2015 Andy VanWagoner.
+- Parts of the API were inspired by [format-message](https://github.com/format-message/format-message), Copyright (c) 2015 Andy VanWagoner.
 
-* Build-time compilation of ICU messages is provided by [MessageFormat](https://messageformat.github.io/messageformat/), Copyright (c) 2012-2018 Alex Sexton, Eemeli Aro, and Contributors.
+- Build-time compilation of ICU messages is provided by [MessageFormat](https://messageformat.github.io/messageformat/), Copyright (c) 2012-2018 Alex Sexton, Eemeli Aro, and Contributors.
 
-* [ICU](http://site.icu-project.org/) (International Components for Unicode) and its syntax are Copyright (c) 1991-2018 Unicode.
+- [ICU](http://site.icu-project.org/) (International Components for Unicode) and its syntax are Copyright (c) 1991-2018 Unicode.
 
-* [React](https://github.com/reactjs/reactjs.org) is Copyright (c) 2013-2018 Facebook.
+- [React](https://github.com/reactjs/reactjs.org) is Copyright (c) 2013-2018 Facebook.

LICENSE.md

@@ -5,4 +5,3 @@ Permission is hereby granted, free of charge, to any person obtaining a copy of
 The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
 
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-

README.md

@@ -8,9 +8,9 @@ Just wrap your user-facing strings in `T`. Don't worry about IDs.
 
 ```js
 // Import T as a singleton
-import {T} from "t-i18n"
+import { T } from "t-i18n";
 
-T("Hello world")
+T("Hello world");
 ```
 
 Extract the strings from your code:
@@ -30,12 +30,12 @@ Then load the translations, pass them to `T` and set the locale.
 
 ```js
 T.set({
-    locale: "es",
-    messages: {
-        en: englishJSON,
-        es: spanishJSON
-    }
-})
+	locale: "es",
+	messages: {
+		en: englishJSON,
+		es: spanishJSON,
+	},
+});
 ```
 
 And that's it. You're localized.
@@ -46,10 +46,10 @@ Formatting is provided courtesy of the [Intl](https://developer.mozilla.org/en-U
 
 ```js
 // Get a localized, formatted date
-T.date(Date.now(), "short")
+T.date(Date.now(), "short");
 
 // Or a number
-T.number(5, "currency")
+T.number(5, "currency");
 ```
 
 Formatters cache themselves automatically, so you don't have to.
@@ -60,20 +60,17 @@ Basic values are easy to replace.
 
 ```js
 // "First name: Wendy"
-T("First name: {userName}", { userName: "Wendy"})
+T("First name: {userName}", { userName: "Wendy" });
 ```
 
 Non-string values (like React components) can be interpolated using an XML syntax.
 
 ```jsx
 // ["There's a ", <button>button</button>, " in my sentence!"]
-T.$(
-    "There's a <myButton /> in my {text}!",
-    {
-        myButton: () => <button>button</button>,
-        text: "sentence",
-    }
-)
+T.$("There's a <myButton /> in my {text}!", {
+	myButton: () => <button>button</button>,
+	text: "sentence",
+});
 ```
 
 If your components have string children, you can translate them inline.
@@ -84,12 +81,12 @@ If your components have string children, you can translate them inline.
 //     " to change your profile picture."
 // ]
 T.$(
-    "<link>Visit your <strong>profile</strong></link> to change your profile picture.",
-    {
-        link: (...children) => <a href={"/user/" + user.uuid}>{...children}</a>,
-        strong: (...children) => <strong>{...children}</strong>,
-    }
-)
+	"<link>Visit your <strong>profile</strong></link> to change your profile picture.",
+	{
+		link: (...children) => <a href={"/user/" + user.uuid}>{...children}</a>,
+		strong: (...children) => <strong>{...children}</strong>,
+	},
+);
 ```
 
 ## Pluralization and advanced ICU syntax
@@ -98,5 +95,5 @@ To get locale-aware pluralization, you should [precompile your translations](htt
 
 ```js
 // Pluralization with ICU syntax
-T("You have { plural, numCats, =0 {0 cats} other {# cats} }", {numCats: 4})
-```
+T("You have { plural, numCats, =0 {0 cats} other {# cats} }", { numCats: 4 });
+```

dist/es6/format.d.ts

@@ -1,36 +1,36 @@
-export declare type IntlFormat = Intl.DateTimeFormat | Intl.NumberFormat;
-export declare type IntlFormatType<X extends IntlFormat> = X extends Intl.DateTimeFormat ? typeof Intl.DateTimeFormat : typeof Intl.NumberFormat;
-export declare type IntlFormatOptions<X extends IntlFormat> = X extends Intl.DateTimeFormat ? Intl.DateTimeFormatOptions : Intl.NumberFormatOptions;
-export declare type CachedFormatter<X extends IntlFormat> = (locale: string, formatOptions?: IntlFormatOptions<X>) => X;
+export type IntlFormat = Intl.DateTimeFormat | Intl.NumberFormat;
+export type IntlFormatType<X extends IntlFormat> = X extends Intl.DateTimeFormat ? typeof Intl.DateTimeFormat : typeof Intl.NumberFormat;
+export type IntlFormatOptions<X extends IntlFormat> = X extends Intl.DateTimeFormat ? Intl.DateTimeFormatOptions : Intl.NumberFormatOptions;
+export type CachedFormatter<X extends IntlFormat> = (locale: string, formatOptions?: IntlFormatOptions<X>) => X;
 export declare const dateTimeFormats: {
-    short: {
-        month: string;
-        day: string;
-        year: string;
+    readonly short: {
+        readonly month: "short";
+        readonly day: "numeric";
+        readonly year: "numeric";
     };
-    long: {
-        month: string;
-        day: string;
-        year: string;
+    readonly long: {
+        readonly month: "long";
+        readonly day: "numeric";
+        readonly year: "numeric";
     };
-    dateTime: {
-        month: string;
-        day: string;
-        year: string;
-        hour: string;
-        minute: string;
+    readonly dateTime: {
+        readonly month: "short";
+        readonly day: "numeric";
+        readonly year: "numeric";
+        readonly hour: "numeric";
+        readonly minute: "numeric";
     };
 };
 export declare const numberFormats: {
-    currency: {
-        style: string;
-        currency: string;
+    readonly currency: {
+        readonly style: "currency";
+        readonly currency: "USD";
     };
-    decimal: {
-        style: string;
+    readonly decimal: {
+        readonly style: "decimal";
     };
-    percent: {
-        style: string;
+    readonly percent: {
+        readonly style: "percent";
     };
 };
 export default function createCachedFormatter<X extends IntlFormat>(intlFormat: IntlFormatType<X>): CachedFormatter<X>;

dist/es6/t-i18n.d.ts

@@ -12,7 +12,7 @@ export interface IntlFormatters {
     date: (value: Date | number, formatName?: keyof typeof dateTimeFormats, locale?: string) => string;
     number: (value: number, formatName?: keyof typeof numberFormats, locale?: string) => string;
 }
-export declare type TFunc = BasicTFunc & IntlFormatters;
+export type TFunc = BasicTFunc & IntlFormatters;
 export declare const makeBasicT: () => BasicTFunc;
 export declare const makeT: () => TFunc;
 declare const _default: TFunc;

dist/es6/t-i18n.js

@@ -24,10 +24,10 @@ const makeIntlFormatters = (locale) => {
     const getDateTimeFormat = () => {
         const delegate = Intl.DateTimeFormat;
         function DateTimeFormat() {
-            var _a, _b, _c;
+            var _a;
             const args = Array.prototype.slice.apply(arguments);
-            const lang = typeof ((_a = args) === null || _a === void 0 ? void 0 : _a[0]) === "string" ? args[0] : "en-US";
-            const timeZone = typeof ((_c = (_b = args) === null || _b === void 0 ? void 0 : _b[1]) === null || _c === void 0 ? void 0 : _c.timeZone) === "string" ? args[1].timeZone : "America/Toronto";
+            const lang = typeof (args === null || args === void 0 ? void 0 : args[0]) === "string" ? args[0] : "en-US";
+            const timeZone = typeof ((_a = args === null || args === void 0 ? void 0 : args[1]) === null || _a === void 0 ? void 0 : _a.timeZone) === "string" ? args[1].timeZone : "America/Toronto";
             return delegate.apply(this, [lang, timeZone]);
         }
         DateTimeFormat.prototype = delegate.prototype;

dist/es6/types.d.ts

@@ -1,5 +1,5 @@
-export declare type MFunc = (replacements?: IcuReplacements) => string;
-export declare type Compiler = (message: string) => MFunc;
+export type MFunc = (replacements?: IcuReplacements) => string;
+export type Compiler = (message: string) => MFunc;
 export interface Messages {
     [s: string]: {
         [s: string]: string | MFunc;
@@ -10,8 +10,8 @@ export interface Config {
     locale: string;
     idGenerator: (message: string) => string;
 }
-export declare type Mutable<X> = {
-    [P in keyof X]: X[P];
+export type Mutable<X> = {
+    -readonly [P in keyof X]: X[P];
 };
 export interface IcuReplacements {
     readonly [s: string]: string | number;

dist/es6/types.js

@@ -0,0 +1 @@
+export {};