Faker 2.2.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*

CHANGELOG.md

@@ -1,3 +1,8 @@
+<a name="2.2.0"></a>
+# [2.2.0](https://github.com/faker-javascript/faker) (2022-01-13)
+* Added xo, tsd, c8.
+* Improved tests.
+
 <a name="2.1.0"></a>
 # [2.1.0](https://github.com/faker-javascript/faker) (2022-01-10)
 * Added new method `superhero` to generate fake superhero name value.

index.d.ts

@@ -0,0 +1,47 @@
+interface OptionsInteger {
+    min?: number;
+    max?: number;
+}
+interface OptionsFloat {
+    min?: number;
+    max?: number;
+    fixed?: number;
+}
+interface OptionsAge {
+    type?: string;
+}
+interface OptionsAnimal {
+    type?: string;
+    locale?: string;
+}
+interface OptionsGender {
+    locale?: string;
+    extra?: string[];
+}
+interface OptionsLetter {
+    casing?: string;
+    locale?: string;
+}
+interface OptionsString {
+    length?: number;
+    keyspace?: string;
+}
+interface OptionsProfession {
+    rank?: boolean;
+    locale?: string;
+}
+declare class Faker {
+    boolean(): boolean;
+    integer(options?: OptionsInteger): number;
+    float(options?: OptionsFloat): number;
+    age(options?: OptionsAge): number;
+    animal(options?: OptionsAnimal): string;
+    gender(options?: OptionsGender): string;
+    ip(): string;
+    letter(options?: OptionsLetter): string;
+    string(options?: OptionsString): string;
+    profession(options?: OptionsProfession): string;
+    superhero(): string;
+}
+declare const faker: Faker;
+export default faker;

index.js

@@ -11,18 +11,50 @@ import profession from '@fakerjs/profession';
 import superhero from '@fakerjs/superhero';
 
 class Faker {
-    boolean() { return boolean(); }
-    integer(options) { return integer(options); }
-    float(options) { return float(options); }
-    age(options) { return age(options); }
-    gender(options) { return gender(options); }
-    ip() { return ip(); }
-    letter(options) { return letter(options); }
-    string(options) { return string(options); }
-    profession(options) { return profession(options); }
-    animal(options) { return animal(options); }
-    superhero() { return superhero(); }
+    boolean() {
+        return boolean();
+    }
+
+    integer(options) {
+        return integer(options);
+    }
+
+    float(options) {
+        return float(options);
+    }
+
+    age(options) {
+        return age(options);
+    }
+
+    gender(options) {
+        return gender(options);
+    }
+
+    ip() {
+        return ip();
+    }
+
+    letter(options) {
+        return letter(options);
+    }
+
+    string(options) {
+        return string(options);
+    }
+
+    profession(options) {
+        return profession(options);
+    }
+
+    animal(options) {
+        return animal(options);
+    }
+
+    superhero() {
+        return superhero();
+    }
 }
 
-let faker = new Faker();
+const faker = new Faker();
 export default faker;

index.test-d.ts

@@ -0,0 +1,14 @@
+import {expectType} from 'tsd';
+import faker from './index.js';
+
+expectType<boolean>(faker.boolean());
+expectType<number>(faker.age());
+expectType<string>(faker.animal());
+expectType<string>(faker.gender());
+expectType<string>(faker.string());
+expectType<string>(faker.letter());
+expectType<string>(faker.profession());
+expectType<string>(faker.ip());
+expectType<string>(faker.superhero());
+expectType<number>(faker.integer());
+expectType<number>(faker.float());

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fakerjs/faker",
-  "version": "2.1.0",
+  "version": "2.2.0",
   "description": "A set of javascript packages that generates fake data for you.",
   "license": "MIT",
   "repository": "faker-javascript/faker",
@@ -14,8 +14,18 @@
   "engines": {
     "node": ">=12"
   },
+  "scripts": {
+    "test": "c8 ava; xo --space 4; tsd;"
+  },
+  "devDependencies": {
+    "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

@@ -0,0 +1,50 @@
+import test from 'ava';
+import faker from './index.js';
+
+test('faker return type to be object', t => {
+    t.is(typeof faker, 'object');
+});
+
+test('faker boolean return type to be boolean', t => {
+    t.is(typeof faker.boolean(), 'boolean');
+});
+
+test('faker string return type to be string', t => {
+    t.is(typeof faker.string(), 'string');
+});
+
+test('faker age return type to be number', t => {
+    t.is(typeof faker.age(), 'number');
+});
+
+test('faker animal return type to be string', t => {
+    t.is(typeof faker.animal(), 'string');
+});
+
+test('faker integer return type to be number', t => {
+    t.is(typeof faker.integer(), 'number');
+});
+
+test('faker float return type to be number', t => {
+    t.is(typeof faker.float(), 'number');
+});
+
+test('faker gende return type to be string', t => {
+    t.is(typeof faker.gender(), 'string');
+});
+
+test('faker superhero return type to be string', t => {
+    t.is(typeof faker.superhero(), 'string');
+});
+
+test('faker profession return type to be string', t => {
+    t.is(typeof faker.profession(), 'string');
+});
+
+test('faker ip return type to be string', t => {
+    t.is(typeof faker.ip(), 'string');
+});
+
+test('faker letter return type to be string', t => {
+    t.is(typeof faker.letter(), 'string');
+});