style: run prettier on the entire codebase

.prettierrc

@@ -1,8 +1,8 @@
 {
-    "useTabs": false,
-    "printWidth": 800,
-    "tabWidth": 2,
-    "singleQuote": true,
-    "trailingComma": "es5",
-    "semi": true
-}
+  "useTabs": false,
+  "printWidth": 800,
+  "tabWidth": 2,
+  "singleQuote": true,
+  "trailingComma": "es5",
+  "semi": true
+}

README.md

@@ -5,6 +5,7 @@ A zero-dependency (for the forseen future hopefully), typescript-ready, fast, li
 # Getting started
 
 First get your locale files going. A json file is enough:
+
 ```json
 // en.json
 {
@@ -26,32 +27,34 @@ First get your locale files going. A json file is enough:
 ```
 
 Then, you can use the package like this:
+
 ```ts
-import { Localization } from "shrimple-locales";
-import enLocale from "./en.json";
-import esLocale from "./es.json";
+import { Localization } from 'shrimple-locales';
+import enLocale from './en.json';
+import esLocale from './es.json';
 
 const loc = new Localization({
-    defaultLocale: "en",
-    fallbackLocale: "en",
-    locales: {
-        en: enLocale,
-        es: esLocale
-    }
-})
+  defaultLocale: 'en',
+  fallbackLocale: 'en',
+  locales: {
+    en: enLocale,
+    es: esLocale,
+  },
+});
 
 // ... later in the code
-foo(`${loc.get('salutes.hello')} ${loc.get('world')}`) // Hello World
+foo(`${loc.get('salutes.hello')} ${loc.get('world')}`); // Hello World
 
-loc.setLocale('es')
-foo(`${loc.get('salutes.hello')} ${loc.get('world')}`) // Hola Mundo
+loc.setLocale('es');
+foo(`${loc.get('salutes.hello')} ${loc.get('world')}`); // Hola Mundo
 ```
 
 # Roadmap
+
 - [x] Basic functionality
 - [x] Fallback locales
 - [x] Default locales
 - [x] Set locale
 - [x] Get all locales (`localizationFor()`)
 - [] Make the package read files or a directory  
-... and more to come!
+  ... and more to come!

package.json

@@ -12,7 +12,8 @@
   "scripts": {
     "build": "tsup",
     "dev": "tsup --watch",
-    "test": "vitest --disable-console-intercept"
+    "test": "vitest --disable-console-intercept",
+    "format": "prettier --write ."
   },
   "exports": {
     ".": {
@@ -28,6 +29,7 @@
     "package.json"
   ],
   "devDependencies": {
+    "prettier": "3.4.1",
     "shrimple-locales": "^0.2.0",
     "tsup": "^8.0.1",
     "typescript": "^5.3.3",

src/test.ts

@@ -1,33 +1,33 @@
 // The file is here because tsconfig is set to compile all files in src folder, and not the tests folder
-import { Localization } from "./index";
+import { Localization } from './index';
 
 export const locales = new Localization({
-    defaultLocale: 'en',
-    fallbackLocale: 'en',
-    locales: {
-        en: {
-            hello: 'Hello',
-            inside: {
-                world: 'World',
-                'another/object': {
-                    key: 'key inside'
-                }
-            },
-            interp: {
-                hello: 'Hello {{int}}'
-            }
+  defaultLocale: 'en',
+  fallbackLocale: 'en',
+  locales: {
+    en: {
+      hello: 'Hello',
+      inside: {
+        world: 'World',
+        'another/object': {
+          key: 'key inside',
         },
-        es: {
-            hello: 'Hola',
-            inside: {
-                world: 'Mundo',
-                'another/object': {
-                    key: 'key dentro'
-                }
-            },
-            interp: {
-                hello: 'Hola {{int}}'
-            }
-        }
-    }
-})
+      },
+      interp: {
+        hello: 'Hello {{int}}',
+      },
+    },
+    es: {
+      hello: 'Hola',
+      inside: {
+        world: 'Mundo',
+        'another/object': {
+          key: 'key dentro',
+        },
+      },
+      interp: {
+        hello: 'Hola {{int}}',
+      },
+    },
+  },
+});

src/util/getLocales.ts

@@ -1,5 +1,5 @@
-import { interpolate } from "./interpolate";
-import { Interpolations, LocaleObject, Locales } from "./types";
+import { interpolate } from './interpolate';
+import { Interpolations, LocaleObject, Locales } from './types';
 
 export default function getLocales(args: Args): string | Record<string, string> {
   const { key, locales, defaultLang, fallbackLang, interpolations } = args;
@@ -8,18 +8,18 @@ export default function getLocales(args: Args): string | Record<string, string>
   for (const lang in locales) {
     // Navigate through nested keys
     let value = locales[lang];
-    for (const k of key.split(".")) {
+    for (const k of key.split('.')) {
       value = value[k] as LocaleObject;
       if (!value) break;
     }
 
     // Handle both string values and object values
     if (value) {
-      if (typeof value === "object") {
+      if (typeof value === 'object') {
         const innerKey = Object.keys(value)[0];
         const interpolatedKey = interpolate(innerKey, interpolations);
         translations[lang] = value[interpolatedKey] as string;
-      } else if (typeof value === "string") {
+      } else if (typeof value === 'string') {
         translations[lang] = interpolate(value, interpolations);
       }
     }
@@ -35,9 +35,9 @@ export default function getLocales(args: Args): string | Record<string, string>
 }
 
 type Args = {
-  key: string,
-  locales: Locales,
-  defaultLang?: string,
-  fallbackLang?: string,
-  interpolations?: Interpolations
-}
+  key: string;
+  locales: Locales;
+  defaultLang?: string;
+  fallbackLang?: string;
+  interpolations?: Interpolations;
+};

src/util/sanitize.ts

@@ -3,9 +3,9 @@ export default function sanitize(text: string): string {
     /[&<>]/g,
     (char) =>
       ({
-        "&": "&amp;",
-        "<": "&lt;",
-        ">": "&gt;",
-      })[char] || char,
+        '&': '&amp;',
+        '<': '&lt;',
+        '>': '&gt;',
+      })[char] || char
   );
 }

tests/get.test.ts

@@ -1,9 +1,9 @@
-import { it, expect } from "vitest";
-import { locales } from "../src/test";
+import { it, expect } from 'vitest';
+import { locales } from '../src/test';
 
-it("should give multiple keys correctly for both langs", () => {
-  expect(locales.t("hello", {}, 'en')).toBe("Hello");
-  expect(locales.t("hello", {}, 'es')).toBe("Hola");
-  expect(locales.t("hello")).toBe("Hello");
-  expect(locales.t("inside.world", {}, 'en')).toBe("World");
+it('should give multiple keys correctly for both langs', () => {
+  expect(locales.t('hello', {}, 'en')).toBe('Hello');
+  expect(locales.t('hello', {}, 'es')).toBe('Hola');
+  expect(locales.t('hello')).toBe('Hello');
+  expect(locales.t('inside.world', {}, 'en')).toBe('World');
 });

tests/getInterps.test.ts

@@ -1,12 +1,12 @@
-import { it, expect } from "vitest";
-import { locales } from "../src/test";
+import { it, expect } from 'vitest';
+import { locales } from '../src/test';
 
-it("should return values with interpolations replaced", () => {
-  expect(locales.t("interp.hello", { int: 'noway' }, 'en')).toBe("Hello noway");
+it('should return values with interpolations replaced', () => {
+  expect(locales.t('interp.hello', { int: 'noway' }, 'en')).toBe('Hello noway');
 
   // test to handle nonexistent interpolaitons, should return the normal {{}} string
-  expect(locales.t("interp.hello", {}, 'en')).toBe("Hello {{int}}");
+  expect(locales.t('interp.hello', {}, 'en')).toBe('Hello {{int}}');
 
   // check to prevent XSS
-  expect(locales.t("interp.hello", { int: '<script>alert("XSS")</script>' }, 'en')).toBe(`Hello &lt;script&gt;alert("XSS")&lt;/script&gt;`);
-});
+  expect(locales.t('interp.hello', { int: '<script>alert("XSS")</script>' }, 'en')).toBe(`Hello &lt;script&gt;alert("XSS")&lt;/script&gt;`);
+});

tests/localizationFor.test.ts

@@ -1,17 +1,17 @@
-import { it, expect } from "vitest";
-import { locales } from "../src/test.js";
+import { it, expect } from 'vitest';
+import { locales } from '../src/test.js';
 
-it("should give multiple keys correctly for both langs", () => {
-  expect(locales.localizationFor("hello")).toEqual({
-    en: "Hello",
-    es: "Hola",
+it('should give multiple keys correctly for both langs', () => {
+  expect(locales.localizationFor('hello')).toEqual({
+    en: 'Hello',
+    es: 'Hola',
   });
-  expect(locales.localizationFor("inside.world")).toEqual({
-    en: "World",
-    es: "Mundo",
+  expect(locales.localizationFor('inside.world')).toEqual({
+    en: 'World',
+    es: 'Mundo',
   });
-  expect(locales.localizationFor("inside.another/object.key")).toEqual({
-    en: "key inside",
-    es: "key dentro",
+  expect(locales.localizationFor('inside.another/object.key')).toEqual({
+    en: 'key inside',
+    es: 'key dentro',
   });
 });