Animal 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

CHANGELOG.md

@@ -1,3 +1,8 @@
+<a name="2.1.0"></a>
+# [2.1.0](https://github.com/faker-javascript/animal) (2022-01-11)
+* Added xo, tsd, c8.
+* Improved tests.
+
 <a name="2.0.1"></a>
 # [2.0.1](https://github.com/faker-javascript/animal) (2022-01-10)
 * GitHub docs updates.

index.d.ts

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

index.js

@@ -0,0 +1,7 @@
+import {expectType} from 'tsd';
+import animal from './index.js';
+
+expectType<string>(animal());
+expectType<string>(animal({type: 'zoo'}));
+expectType<string>(animal({locale: 'en_US'}));
+expectType<string>(animal({type: 'zoo', locale: 'en_US'}));

index.test-d.ts

@@ -1,6 +1,6 @@
 {
   "name": "@fakerjs/animal",
-  "version": "2.0.1",
+  "version": "2.1.0",
   "description": "Animal package provides functionality to generate a fake animal value.",
   "license": "MIT",
   "repository": "faker-javascript/animal",
@@ -15,14 +15,17 @@
     "node": ">=12"
   },
   "scripts": {
-    "test": "c8 ava"
+    "test": "c8 ava; xo --space 4; tsd;"
   },
   "devDependencies": {
-    "ava": "^3.15.0",
-    "c8": "^7.11.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",

package.json

@@ -1,10 +1,10 @@
-import animal from './index.js';
 import test from 'ava';
+import animal from './index.js';
 
 test('animal return type to be string', t => {
-	t.is(typeof animal(), 'string');
+    t.is(typeof animal(), 'string');
 });
 
 test('animal with type and locale return type to be string', t => {
-	t.is(typeof animal({type: 'zoo', locale: 'en_US'}), 'string');
-});
+    t.is(typeof animal({type: 'zoo', locale: 'en_US'}), 'string');
+});