words-global 1.0.0

package/README.md

@@ -0,0 +1,33 @@
+# Words Global
+
+Providing access to alphabets from different languages and dialects. This package aims to solve the problem of lacking access to alphabetic characters for various use cases.
+
+## Usage
+
+```JavaScript
+import { Alphabet } from "./index.js";
+
+const alphabet = new Alphabet("english");
+console.log(alphabet.getLetters());
+console.log(alphabet.language);
+```
+
+## Available Languages
+
+- [**English**](/languages/english.js)
+- [**Russian**](/languages/russian.js) - [source](https://en.wikipedia.org/wiki/Russian_alphabet)
+- [**Arabic**](/languages/russian.js) - [source](https://www.arabichomeschool.com/post/arabic-alphabet-with-words-alif-to-ya-vocabulary-builder-for-kids)
+
+## Contribution Guide
+
+1. Clone this repository.
+2. Refer to the [rules](#rules) below.
+3. Create a separate branch.
+4. Commit your changes and ensure to use good commit messages.
+5. Open a Pull Request.
+6. Wait for feedback (this can take a long time due to quality assurance).
+
+## Rules
+
+1. Only use double-quotes.
+2. Always use semi-colons;

package/example.js

@@ -0,0 +1,4 @@
+import { Alphabet } from "./index.js";
+
+const alphabet = new Alphabet("arabic");
+console.log(alphabet.getLetters());

package/index.js

@@ -0,0 +1,34 @@
+import { arabicAlphabet } from "./languages/arabic.js";
+import { englishAlphabet } from "./languages/english.js";
+import { russianAlphabet } from "./languages/russian.js";
+
+/**
+ * The main class export
+ * @param language - The specified value will determine the returned alphabet
+ */
+export class Alphabet {
+  constructor(language) {
+    this.language = language;
+  }
+
+  preferredLanguage(language) {
+    switch (language) {
+      case "english":
+        return englishAlphabet;
+      case "russian":
+        return russianAlphabet;
+      case "arabic":
+        return arabicAlphabet;
+      default:
+        return "Language not found";
+    }
+  }
+
+  getLetters() {
+    if (this.language) {
+      return this.preferredLanguage(this.language);
+    } else {
+      throw new Error("No language provided");
+    }
+  }
+}

package/languages/arabic.js

@@ -0,0 +1,30 @@
+export const arabicAlphabet = [
+  "ا",
+  "ب",
+  "ت",
+  "ث",
+  "ج",
+  "ح",
+  "خ",
+  "د",
+  "ذ",
+  "ر",
+  "ز",
+  "س",
+  "ش",
+  "ص",
+  "ض",
+  "ط",
+  "ظ",
+  "ع",
+  "غ",
+  "ف",
+  "ق",
+  "ك",
+  "ل",
+  "م",
+  "ن",
+  "هـ",
+  "و",
+  "ي",
+];

package/languages/english.js

@@ -0,0 +1,28 @@
+export const englishAlphabet = [
+  "a",
+  "b",
+  "c",
+  "d",
+  "e",
+  "f",
+  "g",
+  "h",
+  "i",
+  "j",
+  "k",
+  "l",
+  "m",
+  "n",
+  "o",
+  "p",
+  "q",
+  "r",
+  "s",
+  "t",
+  "u",
+  "v",
+  "w",
+  "x",
+  "y",
+  "z",
+];

package/languages/russian.js

@@ -0,0 +1,35 @@
+export const russianAlphabet = [
+  "а",
+  "б",
+  "в",
+  "г",
+  "д",
+  "е",
+  "ё",
+  "ж",
+  "з",
+  "и",
+  "й",
+  "к",
+  "л",
+  "м",
+  "н",
+  "о",
+  "п",
+  "р",
+  "с",
+  "т",
+  "у",
+  "ф",
+  "х",
+  "ц",
+  "ч",
+  "ш",
+  "щ",
+  "ъ",
+  "ы",
+  "ь",
+  "э",
+  "ю",
+  "я",
+];

package/package.json

@@ -0,0 +1,18 @@
+{
+  "name": "words-global",
+  "version": "1.0.0",
+  "description": "Providing access to alphabets from different languages and dialects",
+  "keywords": [
+    "internationalization",
+    "18n",
+    "translation",
+    "alphabet"
+  ],
+  "license": "ISC",
+  "author": "Tawanda Msengezi",
+  "type": "module",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  }
+}