Letter 2.1.0

Author: Awilum

.editorconfig

@@ -1,18 +1,17 @@
-# EditorConfig: http://EditorConfig.org
+# EditorConfig is awesome: https://EditorConfig.org
 
-# top-most EditorConfig file
 root = true
 
-# Unix-style newlines with a newline ending every file
 [*]
-charset = utf-8
 end_of_line = lf
-trim_trailing_whitespace = true
 insert_final_newline = true
+
+[*.{js,d.ts,ts}]
+charset = utf-8
+trim_trailing_whitespace = true
 indent_style = space
 indent_size = 4
 
-# 2 space indentation
-[*.yaml, *.yml]
+[package.json,*.yaml]
 indent_style = space
 indent_size = 2

.gitattributes

@@ -0,0 +1 @@
+* text=auto eol=lf

.gitignore

@@ -1,5 +1,6 @@
 # Global
 node_modules/
+coverage
 
 # OS Generated
 .DS_Store*

index.d.ts

@@ -0,0 +1,5 @@
+interface Options {
+    casing?: string;
+    locale?: string;
+}
+export default function letter(options?: Options): string;

index.js

@@ -1,10 +1,11 @@
+/* eslint camelcase: ["error", {properties: "never"}] */
 export default function letter(options) {
     options = options || {};
-    let keyspace = {
-        "en_US": "abcdefghijklmnopqrstuvwxyz",
-        "ru_RU": "абвгдеёжзийклмнопрстуфхцчшщъыьэюя"
+    const keyspace = {
+        en_US: 'abcdefghijklmnopqrstuvwxyz',
+        ru_RU: 'абвгдеёжзийклмнопрстуфхцчшщъыьэюя',
     };
-    let locale = options.locale || 'en_US';
-    let letter = keyspace[locale].charAt(Math.floor(Math.random() * keyspace[locale].length));
+    const locale = options.locale || 'en_US';
+    const letter = keyspace[locale].charAt(Math.floor(Math.random() * keyspace[locale].length));
     return (options.casing === 'upper' ? letter.toUpperCase() : letter);
-};
+}

index.test-d.ts

@@ -0,0 +1,6 @@
+import {expectType} from 'tsd';
+import letter from './index.js';
+
+expectType<string>(letter());
+expectType<string>(letter({casing: 'upper'}));
+expectType<string>(letter({casing: 'upper', locale: 'en_US'}));

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fakerjs/letter",
-  "version": "2.0.1",
+  "version": "2.1.0",
   "description": "Letter package provides functionality to generate a fake letter value.",
   "license": "MIT",
   "repository": "faker-javascript/letter",
@@ -15,13 +15,17 @@
     "node": ">=12"
   },
   "scripts": {
-    "test": "ava"
+    "test": "c8 ava; xo --space 4; tsd;"
   },
   "devDependencies": {
-    "ava": "^3.15.0"
+    "ava": "^4.0.0",
+    "c8": "^7.11.0",
+		"tsd": "^0.19.1",
+		"xo": "^0.47.0"
   },
   "files": [
-    "index.js"
+    "index.js",
+    "index.d.ts"
   ],
   "keywords": [
     "fakerjs",

test.js

@@ -1,28 +1,28 @@
-import letter from './index.js';
 import test from 'ava';
+import letter from './index.js';
 
 test('letter return type to be string', t => {
-	t.is(typeof letter(), 'string');
+    t.is(typeof letter(), 'string');
 });
 
 test('letter length casing eq 1', t => {
-	t.is(letter().length, 1);
-	t.is(letter({ casing: 'upper' }).length, 1);
-	t.is(letter({ casing: 'lower' }).length, 1);
+    t.is(letter().length, 1);
+    t.is(letter({casing: 'upper'}).length, 1);
+    t.is(letter({casing: 'lower'}).length, 1);
 });
 
 test('letter with locale ru_RU includes', t => {
-	t.true('абвгдеёжзийклмнопрстуфхцчшщъыьэюя'.includes(letter({ locale: 'ru_RU' })));
-	t.false('абвгдеёжзийклмнопрстуфхцчшщъыьэюя'.includes('z'));
+    t.true('абвгдеёжзийклмнопрстуфхцчшщъыьэюя'.includes(letter({locale: 'ru_RU'})));
+    t.false('абвгдеёжзийклмнопрстуфхцчшщъыьэюя'.includes('z'));
 });
 
 test('letter with locale en_US includes', t => {
-	t.true('abcdefghijklmnopqrstuvwxyz'.includes(letter({ locale: 'en_US' })));
-	t.false('abcdefghijklmnopqrstuvwxyz'.includes('я'));
+    t.true('abcdefghijklmnopqrstuvwxyz'.includes(letter({locale: 'en_US'})));
+    t.false('abcdefghijklmnopqrstuvwxyz'.includes('я'));
 });
 
 test('letter with casing and locale ru_RU length eq 1', t => {
-	t.is(letter().length, 1);
-	t.is(letter({ casing: 'upper', locale: 'ru_RU' }).length, 1);
-	t.is(letter({ casing: 'lower', locale: 'ru_RU' }).length, 1);
-});
+    t.is(letter().length, 1);
+    t.is(letter({casing: 'upper', locale: 'ru_RU'}).length, 1);
+    t.is(letter({casing: 'lower', locale: 'ru_RU'}).length, 1);
+});