Merge pull request #7 from opencollective/dev/add-tests-and-ci

Add tests + prettier and configure CI

.github/workflows/test.yml

@@ -0,0 +1,43 @@
+name: Tests
+
+on:
+  push:
+    branches: ["main"]
+  pull_request:
+    branches: ["main"]
+
+jobs:
+  prettier:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Setup Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: 20.x
+          cache: "npm"
+      - name: Install dependencies
+        run: npm ci
+      - name: Prettier
+        run: npm run prettier:check
+
+  test:
+    name: Unit tests
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [16.x, 18.x, 20.x]
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.node-version }}
+          cache: "npm"
+      - name: Install dependencies
+        run: npm ci
+      - name: Run tests
+        run: npm test

.prettierrc

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

README.md

@@ -1,7 +1,7 @@
 ## country-currency-emoji-flags
 
 This small package helps to obtain emojis based on the currency
-code ([ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)).
+code ([ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)) or country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
 
 ### Install
 
@@ -10,14 +10,19 @@ code ([ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)).
 ### Usage
 
 ```js
-import {getEmojiByCountryCode, getEmojiByCurrencyCode, countryData, currencyData} from 'country-currency-emoji-flags';
+import {
+  getEmojiByCountryCode,
+  getEmojiByCurrencyCode,
+  countryData,
+  currencyData,
+} from "country-currency-emoji-flags";
 
 // Currency lookup
-emojiFlags.getEmojiByCurrencyCode('CAD');
+emojiFlags.getEmojiByCurrencyCode("CAD");
 // => "🇨🇦"
 
 // Country lookup
-emojiFlags.getEmojiByCountryCode('CA');
+emojiFlags.getEmojiByCountryCode("CA");
 // => "🇨🇦"
 
 // entire currency code set

country-data.json

@@ -250,4 +250,3 @@
   "ZM": "🇿🇲",
   "ZW": "🇿🇼"
 }
-

currency-data.json

@@ -34,7 +34,7 @@
   "COP": "🇨🇴",
   "CRC": "🇨🇷",
   "CUC": "🇨🇺",
-	"CUP": "🇨🇺",
+  "CUP": "🇨🇺",
   "CVE": "🇨🇻",
   "CZK": "🇨🇿",
   "DJF": "🇩🇯",
@@ -85,7 +85,7 @@
   "LSL": "🇱🇸",
   "LTL": "🇱🇹",
   "LVL": "🇱🇻",
-	"LYD": "🇱🇾",
+  "LYD": "🇱🇾",
   "MAD": "🇲🇦",
   "MDL": "🇲🇩",
   "MGA": "🇲🇬",

index.js

@@ -1,18 +1,18 @@
-'use strict';
+"use strict";
 
-const currencyData = require('./currency-data.json');
-const countryData = require('./country-data.json');
+const currencyData = require("./currency-data.json");
+const countryData = require("./country-data.json");
 
 const methods = {
-  getEmojiByCountryCode: countryCode => {
+  getEmojiByCountryCode: (countryCode) => {
     if (!countryCode) {
       return null;
     }
 
     return countryData[countryCode.toUpperCase()];
   },
 
-  getEmojiByCurrencyCode: currencyCode => {
+  getEmojiByCurrencyCode: (currencyCode) => {
     if (!currencyCode) {
       return null;
     }

index.test.js

@@ -0,0 +1,26 @@
+const { getEmojiByCountryCode } = require("./index");
+const { getEmojiByCurrencyCode } = require("./index");
+
+describe("getEmojiByCountryCode", () => {
+  it("should return null if no country code is passed", () => {
+    expect(getEmojiByCountryCode()).toBeNull();
+  });
+
+  it("should return the emoji for the country code passed", () => {
+    expect(getEmojiByCountryCode("us")).toBe("🇺🇸");
+    expect(getEmojiByCountryCode("US")).toBe("🇺🇸");
+    expect(getEmojiByCountryCode("FR")).toBe("🇫🇷");
+  });
+});
+
+describe("getEmojiByCurrencyCode", () => {
+  it("should return null if no currency code is passed", () => {
+    expect(getEmojiByCurrencyCode()).toBeNull();
+  });
+
+  it("should return the emoji for the currency code passed", () => {
+    expect(getEmojiByCurrencyCode("usd")).toBe("🇺🇸");
+    expect(getEmojiByCurrencyCode("EUR")).toBe("🇪🇺");
+    expect(getEmojiByCurrencyCode("GBP")).toBe("🇬🇧");
+  });
+});