From ced5f3d11630914bf489bd4906b8c114a72d587b Mon Sep 17 00:00:00 2001 From: Shinigami Date: Tue, 1 Mar 2022 19:10:52 +0100 Subject: [PATCH 1/4] chore(deps): add prettier-plugin-organize-imports (#552) --- .prettierrc.cjs | 4 +--- docs/.vitepress/theme/components/index.mjs | 2 +- docs/.vitepress/theme/index.mjs | 4 ++-- package.json | 1 + pnpm-lock.yaml | 12 ++++++++++++ scripts/verifyCommit.ts | 2 +- src/definitions/index.ts | 2 +- src/image.ts | 2 +- src/internet.ts | 1 - src/locale/en_AU.ts | 2 +- src/locale/en_AU_ocker.ts | 2 +- src/locale/en_BORK.ts | 2 +- src/locale/en_CA.ts | 2 +- src/locale/en_GB.ts | 2 +- src/locale/en_GH.ts | 2 +- src/locale/en_IE.ts | 2 +- src/locale/en_IND.ts | 2 +- src/locale/en_NG.ts | 2 +- src/locale/en_US.ts | 2 +- src/locale/en_ZA.ts | 2 +- src/locale/es.ts | 2 +- src/locale/es_MX.ts | 2 +- src/locale/fa.ts | 2 +- src/locale/fi.ts | 2 +- src/locale/fr.ts | 2 +- src/locale/fr_BE.ts | 2 +- src/locale/fr_CA.ts | 2 +- src/locale/fr_CH.ts | 2 +- src/locale/ge.ts | 2 +- src/locale/he.ts | 2 +- src/locale/hr.ts | 2 +- src/locale/hy.ts | 2 +- src/locale/id_ID.ts | 2 +- src/locale/it.ts | 2 +- src/locale/ja.ts | 2 +- src/locale/ko.ts | 2 +- src/locale/lv.ts | 2 +- src/locale/mk.ts | 2 +- src/locale/nb_NO.ts | 2 +- src/locale/ne.ts | 2 +- src/locale/nl.ts | 2 +- src/locale/nl_BE.ts | 2 +- src/locale/pl.ts | 2 +- src/locale/pt_BR.ts | 2 +- src/locale/pt_PT.ts | 2 +- src/locale/ro.ts | 2 +- src/locale/ru.ts | 2 +- src/locale/sk.ts | 2 +- src/locale/sv.ts | 2 +- src/locale/tr.ts | 2 +- src/locale/uk.ts | 2 +- src/locale/ur.ts | 2 +- src/locale/vi.ts | 2 +- src/locale/zh_CN.ts | 2 +- src/locale/zh_TW.ts | 2 +- src/locale/zu_ZA.ts | 2 +- src/unique.ts | 2 +- test/system.spec.ts | 2 +- 58 files changed, 69 insertions(+), 59 deletions(-) diff --git a/.prettierrc.cjs b/.prettierrc.cjs index 3446ec1aa97..105e7f0bf45 100644 --- a/.prettierrc.cjs +++ b/.prettierrc.cjs @@ -4,9 +4,7 @@ * @type {import('prettier').Options} */ module.exports = { - plugins: [ - /* require.resolve("prettier-plugin-organize-imports") */ - ], + plugins: [require.resolve('prettier-plugin-organize-imports')], singleQuote: true, overrides: [ { diff --git a/docs/.vitepress/theme/components/index.mjs b/docs/.vitepress/theme/components/index.mjs index 6a1c639d88b..4b77998a968 100644 --- a/docs/.vitepress/theme/components/index.mjs +++ b/docs/.vitepress/theme/components/index.mjs @@ -1,5 +1,5 @@ -import Playground from './Playground.vue'; import Badge from './Badge.vue'; +import Playground from './Playground.vue'; export default { Playground, diff --git a/docs/.vitepress/theme/index.mjs b/docs/.vitepress/theme/index.mjs index b6bfbb86097..e4f3534f3fe 100644 --- a/docs/.vitepress/theme/index.mjs +++ b/docs/.vitepress/theme/index.mjs @@ -1,6 +1,6 @@ -import './index.css'; -import GlobalComponents from './components'; import DefaultTheme from 'vitepress/theme'; +import GlobalComponents from './components'; +import './index.css'; export default { ...DefaultTheme, diff --git a/package.json b/package.json index 58505cc3684..877a01a63b0 100644 --- a/package.json +++ b/package.json @@ -112,6 +112,7 @@ "npm-run-all": "~4.1.5", "picocolors": "~1.0.0", "prettier": "2.5.1", + "prettier-plugin-organize-imports": "~2.3.4", "rimraf": "~3.0.2", "sanitize-html": "~2.7.0", "simple-git-hooks": "~2.7.0", diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index eb898a78dfb..cb0f10553b1 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -24,6 +24,7 @@ specifiers: npm-run-all: ~4.1.5 picocolors: ~1.0.0 prettier: 2.5.1 + prettier-plugin-organize-imports: ~2.3.4 rimraf: ~3.0.2 sanitize-html: ~2.7.0 simple-git-hooks: ~2.7.0 @@ -60,6 +61,7 @@ devDependencies: npm-run-all: 4.1.5 picocolors: 1.0.0 prettier: 2.5.1 + prettier-plugin-organize-imports: 2.3.4_prettier@2.5.1+typescript@4.5.5 rimraf: 3.0.2 sanitize-html: 2.7.0 simple-git-hooks: 2.7.0 @@ -3505,6 +3507,16 @@ packages: fast-diff: 1.2.0 dev: true + /prettier-plugin-organize-imports/2.3.4_prettier@2.5.1+typescript@4.5.5: + resolution: {integrity: sha512-R8o23sf5iVL/U71h9SFUdhdOEPsi3nm42FD/oDYIZ2PQa4TNWWuWecxln6jlIQzpZTDMUeO1NicJP6lLn2TtRw==} + peerDependencies: + prettier: '>=2.0' + typescript: '>=2.9' + dependencies: + prettier: 2.5.1 + typescript: 4.5.5 + dev: true + /prettier/2.5.1: resolution: {integrity: sha512-vBZcPRUR5MZJwoyi3ZoyQlc1rXeEck8KgeC9AwwOn+exuxLxq5toTRDTSaVrXHxelDMHy9zlicw8u66yxoSUFg==} engines: {node: '>=10.13.0'} diff --git a/scripts/verifyCommit.ts b/scripts/verifyCommit.ts index 1b25235c160..e2c4ae700af 100644 --- a/scripts/verifyCommit.ts +++ b/scripts/verifyCommit.ts @@ -3,8 +3,8 @@ // Invoked on the commit-msg git hook by simple-git-hooks. -import colors from 'picocolors'; import { readFileSync } from 'fs'; +import colors from 'picocolors'; // get $1 from commit-msg script const msgPath = process.argv[2]; diff --git a/src/definitions/index.ts b/src/definitions/index.ts index e4659e0afe6..9eb4c3f3ea1 100644 --- a/src/definitions/index.ts +++ b/src/definitions/index.ts @@ -7,8 +7,8 @@ export type { export type { CompanyDefinitions } from './company'; export type { DatabaseDefinitions } from './database'; export type { DateDefinitions, DateEntryDefinition } from './date'; -export type { DefinitionTypes, LocaleDefinition } from './definitions'; export { DEFINITIONS } from './definitions'; +export type { DefinitionTypes, LocaleDefinition } from './definitions'; export type { FinanceCurrencyEntryDefinitions, FinanceDefinitions, diff --git a/src/image.ts b/src/image.ts index 72cceb121a0..31f8d651d7a 100644 --- a/src/image.ts +++ b/src/image.ts @@ -1,7 +1,7 @@ import type { Faker } from '.'; +import { LoremPicsum } from './image_providers/lorempicsum'; import { Lorempixel } from './image_providers/lorempixel'; import { Unsplash } from './image_providers/unsplash'; -import { LoremPicsum } from './image_providers/lorempicsum'; /** * Module to generate placeholder images. diff --git a/src/internet.ts b/src/internet.ts index 5e253c47fb9..027195c0611 100644 --- a/src/internet.ts +++ b/src/internet.ts @@ -1,5 +1,4 @@ import type { Faker } from '.'; - import * as random_ua from './vendor/user-agent'; /** diff --git a/src/locale/en_AU.ts b/src/locale/en_AU.ts index df1ca1d180b..2e6afe5a259 100644 --- a/src/locale/en_AU.ts +++ b/src/locale/en_AU.ts @@ -4,8 +4,8 @@ */ import { Faker } from '../faker'; -import en_AU from '../locales/en_AU'; import en from '../locales/en'; +import en_AU from '../locales/en_AU'; const faker = new Faker({ locale: 'en_AU', diff --git a/src/locale/en_AU_ocker.ts b/src/locale/en_AU_ocker.ts index 8966380e6c7..4330f6ed550 100644 --- a/src/locale/en_AU_ocker.ts +++ b/src/locale/en_AU_ocker.ts @@ -4,8 +4,8 @@ */ import { Faker } from '../faker'; -import en_AU_ocker from '../locales/en_AU_ocker'; import en from '../locales/en'; +import en_AU_ocker from '../locales/en_AU_ocker'; const faker = new Faker({ locale: 'en_AU_ocker', diff --git a/src/locale/en_BORK.ts b/src/locale/en_BORK.ts index 5ddd3998423..3089a61d583 100644 --- a/src/locale/en_BORK.ts +++ b/src/locale/en_BORK.ts @@ -4,8 +4,8 @@ */ import { Faker } from '../faker'; -import en_BORK from '../locales/en_BORK'; import en from '../locales/en'; +import en_BORK from '../locales/en_BORK'; const faker = new Faker({ locale: 'en_BORK', diff --git a/src/locale/en_CA.ts b/src/locale/en_CA.ts index 064cfb85881..6fbb6db25df 100644 --- a/src/locale/en_CA.ts +++ b/src/locale/en_CA.ts @@ -4,8 +4,8 @@ */ import { Faker } from '../faker'; -import en_CA from '../locales/en_CA'; import en from '../locales/en'; +import en_CA from '../locales/en_CA'; const faker = new Faker({ locale: 'en_CA', diff --git a/src/locale/en_GB.ts b/src/locale/en_GB.ts index 15d87e2851d..baed972d054 100644 --- a/src/locale/en_GB.ts +++ b/src/locale/en_GB.ts @@ -4,8 +4,8 @@ */ import { Faker } from '../faker'; -import en_GB from '../locales/en_GB'; import en from '../locales/en'; +import en_GB from '../locales/en_GB'; const faker = new Faker({ locale: 'en_GB', diff --git a/src/locale/en_GH.ts b/src/locale/en_GH.ts index 91ca84a2e6d..da396c5aea1 100644 --- a/src/locale/en_GH.ts +++ b/src/locale/en_GH.ts @@ -4,8 +4,8 @@ */ import { Faker } from '../faker'; -import en_GH from '../locales/en_GH'; import en from '../locales/en'; +import en_GH from '../locales/en_GH'; const faker = new Faker({ locale: 'en_GH', diff --git a/src/locale/en_IE.ts b/src/locale/en_IE.ts index d10d4d5b6c7..2b0f92b8a99 100644 --- a/src/locale/en_IE.ts +++ b/src/locale/en_IE.ts @@ -4,8 +4,8 @@ */ import { Faker } from '../faker'; -import en_IE from '../locales/en_IE'; import en from '../locales/en'; +import en_IE from '../locales/en_IE'; const faker = new Faker({ locale: 'en_IE', diff --git a/src/locale/en_IND.ts b/src/locale/en_IND.ts index 5659530e218..16a753be517 100644 --- a/src/locale/en_IND.ts +++ b/src/locale/en_IND.ts @@ -4,8 +4,8 @@ */ import { Faker } from '../faker'; -import en_IND from '../locales/en_IND'; import en from '../locales/en'; +import en_IND from '../locales/en_IND'; const faker = new Faker({ locale: 'en_IND', diff --git a/src/locale/en_NG.ts b/src/locale/en_NG.ts index 181ae108c00..f9d49152865 100644 --- a/src/locale/en_NG.ts +++ b/src/locale/en_NG.ts @@ -4,8 +4,8 @@ */ import { Faker } from '../faker'; -import en_NG from '../locales/en_NG'; import en from '../locales/en'; +import en_NG from '../locales/en_NG'; const faker = new Faker({ locale: 'en_NG', diff --git a/src/locale/en_US.ts b/src/locale/en_US.ts index 598f6bca1d4..ec6a6cc0bec 100644 --- a/src/locale/en_US.ts +++ b/src/locale/en_US.ts @@ -4,8 +4,8 @@ */ import { Faker } from '../faker'; -import en_US from '../locales/en_US'; import en from '../locales/en'; +import en_US from '../locales/en_US'; const faker = new Faker({ locale: 'en_US', diff --git a/src/locale/en_ZA.ts b/src/locale/en_ZA.ts index e2c7db6ac2a..2eb13622429 100644 --- a/src/locale/en_ZA.ts +++ b/src/locale/en_ZA.ts @@ -4,8 +4,8 @@ */ import { Faker } from '../faker'; -import en_ZA from '../locales/en_ZA'; import en from '../locales/en'; +import en_ZA from '../locales/en_ZA'; const faker = new Faker({ locale: 'en_ZA', diff --git a/src/locale/es.ts b/src/locale/es.ts index 751f4b6efb0..b5485698ca6 100644 --- a/src/locale/es.ts +++ b/src/locale/es.ts @@ -4,8 +4,8 @@ */ import { Faker } from '../faker'; -import es from '../locales/es'; import en from '../locales/en'; +import es from '../locales/es'; const faker = new Faker({ locale: 'es', diff --git a/src/locale/es_MX.ts b/src/locale/es_MX.ts index 6f8b1a89d1e..ff954d8c415 100644 --- a/src/locale/es_MX.ts +++ b/src/locale/es_MX.ts @@ -4,8 +4,8 @@ */ import { Faker } from '../faker'; -import es_MX from '../locales/es_MX'; import en from '../locales/en'; +import es_MX from '../locales/es_MX'; const faker = new Faker({ locale: 'es_MX', diff --git a/src/locale/fa.ts b/src/locale/fa.ts index 92b7c2c77e9..62e63d8ded6 100644 --- a/src/locale/fa.ts +++ b/src/locale/fa.ts @@ -4,8 +4,8 @@ */ import { Faker } from '../faker'; -import fa from '../locales/fa'; import en from '../locales/en'; +import fa from '../locales/fa'; const faker = new Faker({ locale: 'fa', diff --git a/src/locale/fi.ts b/src/locale/fi.ts index 33b064a1505..ecdecb88b15 100644 --- a/src/locale/fi.ts +++ b/src/locale/fi.ts @@ -4,8 +4,8 @@ */ import { Faker } from '../faker'; -import fi from '../locales/fi'; import en from '../locales/en'; +import fi from '../locales/fi'; const faker = new Faker({ locale: 'fi', diff --git a/src/locale/fr.ts b/src/locale/fr.ts index 3927ff97422..e767c582397 100644 --- a/src/locale/fr.ts +++ b/src/locale/fr.ts @@ -4,8 +4,8 @@ */ import { Faker } from '../faker'; -import fr from '../locales/fr'; import en from '../locales/en'; +import fr from '../locales/fr'; const faker = new Faker({ locale: 'fr', diff --git a/src/locale/fr_BE.ts b/src/locale/fr_BE.ts index 0e56bff574a..f98b7c8c5aa 100644 --- a/src/locale/fr_BE.ts +++ b/src/locale/fr_BE.ts @@ -4,8 +4,8 @@ */ import { Faker } from '../faker'; -import fr_BE from '../locales/fr_BE'; import en from '../locales/en'; +import fr_BE from '../locales/fr_BE'; const faker = new Faker({ locale: 'fr_BE', diff --git a/src/locale/fr_CA.ts b/src/locale/fr_CA.ts index 4fd967daf40..30e73bdbdbd 100644 --- a/src/locale/fr_CA.ts +++ b/src/locale/fr_CA.ts @@ -4,8 +4,8 @@ */ import { Faker } from '../faker'; -import fr_CA from '../locales/fr_CA'; import en from '../locales/en'; +import fr_CA from '../locales/fr_CA'; const faker = new Faker({ locale: 'fr_CA', diff --git a/src/locale/fr_CH.ts b/src/locale/fr_CH.ts index abc16114d99..f04588b54cd 100644 --- a/src/locale/fr_CH.ts +++ b/src/locale/fr_CH.ts @@ -4,8 +4,8 @@ */ import { Faker } from '../faker'; -import fr_CH from '../locales/fr_CH'; import en from '../locales/en'; +import fr_CH from '../locales/fr_CH'; const faker = new Faker({ locale: 'fr_CH', diff --git a/src/locale/ge.ts b/src/locale/ge.ts index ba589722af1..7734e2d33a1 100644 --- a/src/locale/ge.ts +++ b/src/locale/ge.ts @@ -4,8 +4,8 @@ */ import { Faker } from '../faker'; -import ge from '../locales/ge'; import en from '../locales/en'; +import ge from '../locales/ge'; const faker = new Faker({ locale: 'ge', diff --git a/src/locale/he.ts b/src/locale/he.ts index ad63ed71e6e..a029ea62114 100644 --- a/src/locale/he.ts +++ b/src/locale/he.ts @@ -4,8 +4,8 @@ */ import { Faker } from '../faker'; -import he from '../locales/he'; import en from '../locales/en'; +import he from '../locales/he'; const faker = new Faker({ locale: 'he', diff --git a/src/locale/hr.ts b/src/locale/hr.ts index b756d750a3f..1a8447155fb 100644 --- a/src/locale/hr.ts +++ b/src/locale/hr.ts @@ -4,8 +4,8 @@ */ import { Faker } from '../faker'; -import hr from '../locales/hr'; import en from '../locales/en'; +import hr from '../locales/hr'; const faker = new Faker({ locale: 'hr', diff --git a/src/locale/hy.ts b/src/locale/hy.ts index 93bd7021597..ae584be3529 100644 --- a/src/locale/hy.ts +++ b/src/locale/hy.ts @@ -4,8 +4,8 @@ */ import { Faker } from '../faker'; -import hy from '../locales/hy'; import en from '../locales/en'; +import hy from '../locales/hy'; const faker = new Faker({ locale: 'hy', diff --git a/src/locale/id_ID.ts b/src/locale/id_ID.ts index ae17061f0fa..026086611df 100644 --- a/src/locale/id_ID.ts +++ b/src/locale/id_ID.ts @@ -4,8 +4,8 @@ */ import { Faker } from '../faker'; -import id_ID from '../locales/id_ID'; import en from '../locales/en'; +import id_ID from '../locales/id_ID'; const faker = new Faker({ locale: 'id_ID', diff --git a/src/locale/it.ts b/src/locale/it.ts index bde435d43d2..40daaa65432 100644 --- a/src/locale/it.ts +++ b/src/locale/it.ts @@ -4,8 +4,8 @@ */ import { Faker } from '../faker'; -import it from '../locales/it'; import en from '../locales/en'; +import it from '../locales/it'; const faker = new Faker({ locale: 'it', diff --git a/src/locale/ja.ts b/src/locale/ja.ts index dea9ff684a0..4866ad92ead 100644 --- a/src/locale/ja.ts +++ b/src/locale/ja.ts @@ -4,8 +4,8 @@ */ import { Faker } from '../faker'; -import ja from '../locales/ja'; import en from '../locales/en'; +import ja from '../locales/ja'; const faker = new Faker({ locale: 'ja', diff --git a/src/locale/ko.ts b/src/locale/ko.ts index 209b1a575a7..b6d975893b2 100644 --- a/src/locale/ko.ts +++ b/src/locale/ko.ts @@ -4,8 +4,8 @@ */ import { Faker } from '../faker'; -import ko from '../locales/ko'; import en from '../locales/en'; +import ko from '../locales/ko'; const faker = new Faker({ locale: 'ko', diff --git a/src/locale/lv.ts b/src/locale/lv.ts index 0dd032ad1d2..89349b51e96 100644 --- a/src/locale/lv.ts +++ b/src/locale/lv.ts @@ -4,8 +4,8 @@ */ import { Faker } from '../faker'; -import lv from '../locales/lv'; import en from '../locales/en'; +import lv from '../locales/lv'; const faker = new Faker({ locale: 'lv', diff --git a/src/locale/mk.ts b/src/locale/mk.ts index 169598df52b..c5b9a584002 100644 --- a/src/locale/mk.ts +++ b/src/locale/mk.ts @@ -4,8 +4,8 @@ */ import { Faker } from '../faker'; -import mk from '../locales/mk'; import en from '../locales/en'; +import mk from '../locales/mk'; const faker = new Faker({ locale: 'mk', diff --git a/src/locale/nb_NO.ts b/src/locale/nb_NO.ts index 77b10c4ccc4..9c768999e40 100644 --- a/src/locale/nb_NO.ts +++ b/src/locale/nb_NO.ts @@ -4,8 +4,8 @@ */ import { Faker } from '../faker'; -import nb_NO from '../locales/nb_NO'; import en from '../locales/en'; +import nb_NO from '../locales/nb_NO'; const faker = new Faker({ locale: 'nb_NO', diff --git a/src/locale/ne.ts b/src/locale/ne.ts index 3a8a62d24fa..1527d4136ac 100644 --- a/src/locale/ne.ts +++ b/src/locale/ne.ts @@ -4,8 +4,8 @@ */ import { Faker } from '../faker'; -import ne from '../locales/ne'; import en from '../locales/en'; +import ne from '../locales/ne'; const faker = new Faker({ locale: 'ne', diff --git a/src/locale/nl.ts b/src/locale/nl.ts index 9d25bd6b3a5..c4adac22204 100644 --- a/src/locale/nl.ts +++ b/src/locale/nl.ts @@ -4,8 +4,8 @@ */ import { Faker } from '../faker'; -import nl from '../locales/nl'; import en from '../locales/en'; +import nl from '../locales/nl'; const faker = new Faker({ locale: 'nl', diff --git a/src/locale/nl_BE.ts b/src/locale/nl_BE.ts index d7d087ef87e..57c23f2e08d 100644 --- a/src/locale/nl_BE.ts +++ b/src/locale/nl_BE.ts @@ -4,8 +4,8 @@ */ import { Faker } from '../faker'; -import nl_BE from '../locales/nl_BE'; import en from '../locales/en'; +import nl_BE from '../locales/nl_BE'; const faker = new Faker({ locale: 'nl_BE', diff --git a/src/locale/pl.ts b/src/locale/pl.ts index b4412b7d0ec..32489ea9484 100644 --- a/src/locale/pl.ts +++ b/src/locale/pl.ts @@ -4,8 +4,8 @@ */ import { Faker } from '../faker'; -import pl from '../locales/pl'; import en from '../locales/en'; +import pl from '../locales/pl'; const faker = new Faker({ locale: 'pl', diff --git a/src/locale/pt_BR.ts b/src/locale/pt_BR.ts index d93e11b48d3..fd91879ec23 100644 --- a/src/locale/pt_BR.ts +++ b/src/locale/pt_BR.ts @@ -4,8 +4,8 @@ */ import { Faker } from '../faker'; -import pt_BR from '../locales/pt_BR'; import en from '../locales/en'; +import pt_BR from '../locales/pt_BR'; const faker = new Faker({ locale: 'pt_BR', diff --git a/src/locale/pt_PT.ts b/src/locale/pt_PT.ts index ba7d778176b..8233d8cd746 100644 --- a/src/locale/pt_PT.ts +++ b/src/locale/pt_PT.ts @@ -4,8 +4,8 @@ */ import { Faker } from '../faker'; -import pt_PT from '../locales/pt_PT'; import en from '../locales/en'; +import pt_PT from '../locales/pt_PT'; const faker = new Faker({ locale: 'pt_PT', diff --git a/src/locale/ro.ts b/src/locale/ro.ts index af693cb22ff..45d97cbf990 100644 --- a/src/locale/ro.ts +++ b/src/locale/ro.ts @@ -4,8 +4,8 @@ */ import { Faker } from '../faker'; -import ro from '../locales/ro'; import en from '../locales/en'; +import ro from '../locales/ro'; const faker = new Faker({ locale: 'ro', diff --git a/src/locale/ru.ts b/src/locale/ru.ts index 7aa9d8e5a64..753d218f7fa 100644 --- a/src/locale/ru.ts +++ b/src/locale/ru.ts @@ -4,8 +4,8 @@ */ import { Faker } from '../faker'; -import ru from '../locales/ru'; import en from '../locales/en'; +import ru from '../locales/ru'; const faker = new Faker({ locale: 'ru', diff --git a/src/locale/sk.ts b/src/locale/sk.ts index 1816b149a42..ce8bc05a547 100644 --- a/src/locale/sk.ts +++ b/src/locale/sk.ts @@ -4,8 +4,8 @@ */ import { Faker } from '../faker'; -import sk from '../locales/sk'; import en from '../locales/en'; +import sk from '../locales/sk'; const faker = new Faker({ locale: 'sk', diff --git a/src/locale/sv.ts b/src/locale/sv.ts index 98a7ef0d417..30706dfa8a1 100644 --- a/src/locale/sv.ts +++ b/src/locale/sv.ts @@ -4,8 +4,8 @@ */ import { Faker } from '../faker'; -import sv from '../locales/sv'; import en from '../locales/en'; +import sv from '../locales/sv'; const faker = new Faker({ locale: 'sv', diff --git a/src/locale/tr.ts b/src/locale/tr.ts index ededd3c7589..c68fe76f156 100644 --- a/src/locale/tr.ts +++ b/src/locale/tr.ts @@ -4,8 +4,8 @@ */ import { Faker } from '../faker'; -import tr from '../locales/tr'; import en from '../locales/en'; +import tr from '../locales/tr'; const faker = new Faker({ locale: 'tr', diff --git a/src/locale/uk.ts b/src/locale/uk.ts index c3e71b4ff51..a6b1c1bc1dd 100644 --- a/src/locale/uk.ts +++ b/src/locale/uk.ts @@ -4,8 +4,8 @@ */ import { Faker } from '../faker'; -import uk from '../locales/uk'; import en from '../locales/en'; +import uk from '../locales/uk'; const faker = new Faker({ locale: 'uk', diff --git a/src/locale/ur.ts b/src/locale/ur.ts index 3c8c3cdbdb4..249c4011b9c 100644 --- a/src/locale/ur.ts +++ b/src/locale/ur.ts @@ -4,8 +4,8 @@ */ import { Faker } from '../faker'; -import ur from '../locales/ur'; import en from '../locales/en'; +import ur from '../locales/ur'; const faker = new Faker({ locale: 'ur', diff --git a/src/locale/vi.ts b/src/locale/vi.ts index a01a216bc04..62c1e367f96 100644 --- a/src/locale/vi.ts +++ b/src/locale/vi.ts @@ -4,8 +4,8 @@ */ import { Faker } from '../faker'; -import vi from '../locales/vi'; import en from '../locales/en'; +import vi from '../locales/vi'; const faker = new Faker({ locale: 'vi', diff --git a/src/locale/zh_CN.ts b/src/locale/zh_CN.ts index 4c2e3b98cd2..d7fddf293e5 100644 --- a/src/locale/zh_CN.ts +++ b/src/locale/zh_CN.ts @@ -4,8 +4,8 @@ */ import { Faker } from '../faker'; -import zh_CN from '../locales/zh_CN'; import en from '../locales/en'; +import zh_CN from '../locales/zh_CN'; const faker = new Faker({ locale: 'zh_CN', diff --git a/src/locale/zh_TW.ts b/src/locale/zh_TW.ts index 781c421a315..5a9b3e31583 100644 --- a/src/locale/zh_TW.ts +++ b/src/locale/zh_TW.ts @@ -4,8 +4,8 @@ */ import { Faker } from '../faker'; -import zh_TW from '../locales/zh_TW'; import en from '../locales/en'; +import zh_TW from '../locales/zh_TW'; const faker = new Faker({ locale: 'zh_TW', diff --git a/src/locale/zu_ZA.ts b/src/locale/zu_ZA.ts index 9c37d0b54d9..f75bf2871f1 100644 --- a/src/locale/zu_ZA.ts +++ b/src/locale/zu_ZA.ts @@ -4,8 +4,8 @@ */ import { Faker } from '../faker'; -import zu_ZA from '../locales/zu_ZA'; import en from '../locales/en'; +import zu_ZA from '../locales/zu_ZA'; const faker = new Faker({ locale: 'zu_ZA', diff --git a/src/unique.ts b/src/unique.ts index 62402df077a..acb6931fb01 100644 --- a/src/unique.ts +++ b/src/unique.ts @@ -1,5 +1,5 @@ -import * as uniqueExec from './vendor/unique'; import type { RecordKey } from './vendor/unique'; +import * as uniqueExec from './vendor/unique'; /** * Module to generate unique entries. diff --git a/test/system.spec.ts b/test/system.spec.ts index 7088f754f95..731402cb30d 100644 --- a/test/system.spec.ts +++ b/test/system.spec.ts @@ -1,5 +1,5 @@ -import { afterEach, describe, expect, it } from 'vitest'; import validator from 'validator'; +import { afterEach, describe, expect, it } from 'vitest'; import { faker } from '../src'; // TODO @prisis 2022-01-31: Add multiple seed based expectations. From 748086bff08b59cb3f78c5e2555977b6a7f7eeb4 Mon Sep 17 00:00:00 2001 From: ST-DDT Date: Tue, 1 Mar 2022 19:20:06 +0100 Subject: [PATCH 2/4] chore: refactor datatype array function (#566) Co-authored-by: Shinigami --- src/datatype.ts | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/src/datatype.ts b/src/datatype.ts index 8803f8bc10c..3da8e2a4154 100644 --- a/src/datatype.ts +++ b/src/datatype.ts @@ -269,13 +269,11 @@ export class Datatype { * faker.datatype.array(3) // [ 61845, 'SK7H$W3:d*', 'm[%7N8*GVK' ] */ array(length = 10): Array { - const returnArray = new Array(length); - for (let i = 0; i < length; i++) { - returnArray[i] = this.faker.datatype.boolean() + return Array.from({ length }).map(() => + this.faker.datatype.boolean() ? this.faker.datatype.string() - : this.faker.datatype.number(); - } - return returnArray; + : this.faker.datatype.number() + ); } /** From 9b559402e06eb3c615d6d7dccefd7c8fe20a67eb Mon Sep 17 00:00:00 2001 From: Shinigami Date: Tue, 1 Mar 2022 19:29:04 +0100 Subject: [PATCH 3/4] chore(type): type seedValue (#567) --- src/datatype.ts | 4 ++-- src/faker.ts | 4 ++-- src/random.ts | 4 ++-- test/address.spec.ts | 4 +++- test/animal.spec.ts | 4 +++- test/commerce.spec.ts | 4 +++- test/company.spec.ts | 4 +++- test/database.spec.ts | 4 +++- test/datatype.spec.ts | 4 +++- test/date.spec.ts | 4 +++- test/finance.spec.ts | 4 +++- test/finance_iban.spec.ts | 4 +++- test/git.spec.ts | 4 +++- test/hacker.spec.ts | 4 +++- test/helpers.spec.ts | 4 +++- test/internet.spec.ts | 4 +++- test/lorem.spec.ts | 4 +++- test/music.spec.ts | 4 +++- test/name.spec.ts | 4 +++- test/phone.spec.ts | 4 +++- test/system.spec.ts | 4 +++- test/time.spec.ts | 4 +++- test/unique.spec.ts | 4 +++- test/vehicle.spec.ts | 4 +++- test/word.spec.ts | 4 +++- 25 files changed, 72 insertions(+), 28 deletions(-) diff --git a/src/datatype.ts b/src/datatype.ts index 3da8e2a4154..a5e751c0410 100644 --- a/src/datatype.ts +++ b/src/datatype.ts @@ -4,11 +4,11 @@ import type { Faker } from '.'; * Module to generate various primitive values and data types. */ export class Datatype { - constructor(private readonly faker: Faker, seed?: any[] | any) { + constructor(private readonly faker: Faker, seed?: number | number[]) { // Use a user provided seed if it is an array or number if (Array.isArray(seed) && seed.length) { this.faker.mersenne.seed_array(seed); - } else if (!isNaN(seed)) { + } else if (!Array.isArray(seed) && !isNaN(seed)) { this.faker.mersenne.seed(seed); } diff --git a/src/faker.ts b/src/faker.ts index f8d43a7ac92..25046b9a62e 100644 --- a/src/faker.ts +++ b/src/faker.ts @@ -47,7 +47,7 @@ export class Faker { // Will be lazy init readonly definitions: LocaleDefinition = {} as LocaleDefinition; - seedValue?: any[] | any; + seedValue?: number | number[]; readonly fake: Fake['fake'] = new Fake(this).fake; readonly unique: Unique['unique'] = new Unique().unique; @@ -127,7 +127,7 @@ export class Faker { }); } - seed(value?: any[] | any): void { + seed(value?: number | number[]): void { this.seedValue = value; this.random = new Random(this, this.seedValue); this.datatype = new Datatype(this, this.seedValue); diff --git a/src/random.ts b/src/random.ts index d9096d71ea8..f1e1550f632 100644 --- a/src/random.ts +++ b/src/random.ts @@ -18,11 +18,11 @@ function arrayRemove(arr: T[], values: T[]): T[] { * Generates random values of different kinds. Some methods are deprecated and have been moved to dedicated modules. */ export class Random { - constructor(private readonly faker: Faker, seed?: any[] | any) { + constructor(private readonly faker: Faker, seed?: number | number[]) { // Use a user provided seed if it is an array or number if (Array.isArray(seed) && seed.length) { this.faker.mersenne.seed_array(seed); - } else if (!isNaN(seed)) { + } else if (!Array.isArray(seed) && !isNaN(seed)) { this.faker.mersenne.seed(seed); } diff --git a/test/address.spec.ts b/test/address.spec.ts index 6c4490625b8..01d8a0b1a14 100644 --- a/test/address.spec.ts +++ b/test/address.spec.ts @@ -339,7 +339,9 @@ describe('address', () => { // Create and log-back the seed for debug purposes faker.seed(Math.ceil(Math.random() * 1_000_000_000)); - describe(`random seeded tests for seed ${faker.seedValue}`, () => { + describe(`random seeded tests for seed ${JSON.stringify( + faker.seedValue + )}`, () => { for (let i = 1; i <= NON_SEEDED_BASED_RUN; i++) { describe('countryCode()', () => { it('returns random alpha-3 countryCode', () => { diff --git a/test/animal.spec.ts b/test/animal.spec.ts index 9af68d861a2..b98aae5004b 100644 --- a/test/animal.spec.ts +++ b/test/animal.spec.ts @@ -101,7 +101,9 @@ describe('animal', () => { // Create and log-back the seed for debug purposes faker.seed(Math.ceil(Math.random() * 1_000_000_000)); - describe(`random seeded tests for seed ${faker.seedValue}`, () => { + describe(`random seeded tests for seed ${JSON.stringify( + faker.seedValue + )}`, () => { for (let i = 1; i <= NON_SEEDED_BASED_RUN; i++) { for (const functionName of functionNames) { describe(`${functionName}()`, () => { diff --git a/test/commerce.spec.ts b/test/commerce.spec.ts index ced09ad2722..a06f96ed909 100644 --- a/test/commerce.spec.ts +++ b/test/commerce.spec.ts @@ -80,7 +80,9 @@ describe('commerce', () => { // Create and log-back the seed for debug purposes faker.seed(Math.ceil(Math.random() * 1_000_000_000)); - describe(`random seeded tests for seed ${faker.seedValue}`, () => { + describe(`random seeded tests for seed ${JSON.stringify( + faker.seedValue + )}`, () => { for (let i = 1; i <= NON_SEEDED_BASED_RUN; i++) { describe(`color()`, () => { it('should return random value from color array', () => { diff --git a/test/company.spec.ts b/test/company.spec.ts index 902d5322484..7b8e7820dd2 100644 --- a/test/company.spec.ts +++ b/test/company.spec.ts @@ -89,7 +89,9 @@ describe('company', () => { // Create and log-back the seed for debug purposes faker.seed(Math.ceil(Math.random() * 1_000_000_000)); - describe(`random seeded tests for seed ${faker.seedValue}`, () => { + describe(`random seeded tests for seed ${JSON.stringify( + faker.seedValue + )}`, () => { for (let i = 1; i <= NON_SEEDED_BASED_RUN; i++) { describe('suffixes()', () => { it('should return all suffixes', () => { diff --git a/test/database.spec.ts b/test/database.spec.ts index 9079647fe34..063f214bfd3 100644 --- a/test/database.spec.ts +++ b/test/database.spec.ts @@ -56,7 +56,9 @@ describe('database', () => { // Create and log-back the seed for debug purposes faker.seed(Math.ceil(Math.random() * 1_000_000_000)); - describe(`random seeded tests for seed ${faker.seedValue}`, () => { + describe(`random seeded tests for seed ${JSON.stringify( + faker.seedValue + )}`, () => { for (let i = 1; i <= NON_SEEDED_BASED_RUN; i++) { describe('column()', () => { it('should return a column name from array', () => { diff --git a/test/datatype.spec.ts b/test/datatype.spec.ts index 61c357ae15b..bee280d7bf1 100644 --- a/test/datatype.spec.ts +++ b/test/datatype.spec.ts @@ -383,7 +383,9 @@ describe('datatype', () => { // Create and log-back the seed for debug purposes faker.seed(Math.ceil(Math.random() * 1_000_000_000)); - describe(`random seeded tests for seed ${faker.seedValue}`, () => { + describe(`random seeded tests for seed ${JSON.stringify( + faker.seedValue + )}`, () => { for (let i = 1; i <= NON_SEEDED_BASED_RUN; i++) { describe('number', () => { it('should return a random number given a maximum value as Number', () => { diff --git a/test/date.spec.ts b/test/date.spec.ts index 9b73a471598..a6af2cb5d00 100644 --- a/test/date.spec.ts +++ b/test/date.spec.ts @@ -423,7 +423,9 @@ describe('date', () => { // Create and log-back the seed for debug purposes faker.seed(Math.ceil(Math.random() * 1_000_000_000)); - describe(`random seeded tests for seed ${faker.seedValue}`, () => { + describe(`random seeded tests for seed ${JSON.stringify( + faker.seedValue + )}`, () => { for (let i = 1; i <= NON_SEEDED_BASED_RUN; i++) { describe('past()', () => { it('should return a date 5 years in the past', () => { diff --git a/test/finance.spec.ts b/test/finance.spec.ts index d42e19c5134..c7818417c34 100644 --- a/test/finance.spec.ts +++ b/test/finance.spec.ts @@ -119,7 +119,9 @@ describe('finance', () => { // Create and log-back the seed for debug purposes faker.seed(Math.ceil(Math.random() * 1_000_000_000)); - describe(`random seeded tests for seed ${faker.seedValue}`, () => { + describe(`random seeded tests for seed ${JSON.stringify( + faker.seedValue + )}`, () => { for (let i = 1; i <= NON_SEEDED_BASED_RUN; i++) { describe('account()', () => { it('should supply a default length', () => { diff --git a/test/finance_iban.spec.ts b/test/finance_iban.spec.ts index 2bf65fea108..23768387d85 100644 --- a/test/finance_iban.spec.ts +++ b/test/finance_iban.spec.ts @@ -9,7 +9,9 @@ describe('finance_iban', () => { // Create and log-back the seed for debug purposes faker.seed(Math.ceil(Math.random() * 1_000_000_000)); - describe(`random seeded tests for seed ${faker.seedValue}`, () => { + describe(`random seeded tests for seed ${JSON.stringify( + faker.seedValue + )}`, () => { for (let i = 1; i <= NON_SEEDED_BASED_RUN; i++) { describe('specific IBAN country checks', () => { it('IBAN for Georgia is correct', () => { diff --git a/test/git.spec.ts b/test/git.spec.ts index b43498d3335..84f85e760d0 100644 --- a/test/git.spec.ts +++ b/test/git.spec.ts @@ -101,7 +101,9 @@ describe('git', () => { // Create and log-back the seed for debug purposes faker.seed(Math.ceil(Math.random() * 1_000_000_000)); - describe(`random seeded tests for seed ${faker.seedValue}`, () => { + describe(`random seeded tests for seed ${JSON.stringify( + faker.seedValue + )}`, () => { for (let i = 1; i <= NON_SEEDED_BASED_RUN; i++) { describe('branch()', () => { it('should return a random branch', () => { diff --git a/test/hacker.spec.ts b/test/hacker.spec.ts index 7dcb5f67c71..1a567588aee 100644 --- a/test/hacker.spec.ts +++ b/test/hacker.spec.ts @@ -108,7 +108,9 @@ describe('name', () => { // Create and log-back the seed for debug purposes faker.seed(Math.ceil(Math.random() * 1_000_000_000)); - describe(`random seeded tests for seed ${faker.seedValue}`, () => { + describe(`random seeded tests for seed ${JSON.stringify( + faker.seedValue + )}`, () => { for (let i = 1; i <= NON_SEEDED_BASED_RUN; i++) { describe('abbreviation()', () => { beforeEach(() => { diff --git a/test/helpers.spec.ts b/test/helpers.spec.ts index d296350d4e9..929678c7f08 100644 --- a/test/helpers.spec.ts +++ b/test/helpers.spec.ts @@ -493,7 +493,9 @@ describe('helpers', () => { // Create and log-back the seed for debug purposes faker.seed(Math.ceil(Math.random() * 1_000_000_000)); - describe(`random seeded tests for seed ${faker.seedValue}`, () => { + describe(`random seeded tests for seed ${JSON.stringify( + faker.seedValue + )}`, () => { for (let i = 1; i <= NON_SEEDED_BASED_RUN; i++) { describe('randomize()', () => { // Will be marked as deprecated soon diff --git a/test/internet.spec.ts b/test/internet.spec.ts index eb1cebb31cf..b7d9a7ea729 100644 --- a/test/internet.spec.ts +++ b/test/internet.spec.ts @@ -122,7 +122,9 @@ describe('internet', () => { // Create and log-back the seed for debug purposes faker.seed(Math.ceil(Math.random() * 1_000_000_000)); - describe(`random seeded tests for seed ${faker.seedValue}`, () => { + describe(`random seeded tests for seed ${JSON.stringify( + faker.seedValue + )}`, () => { for (let i = 1; i <= NON_SEEDED_BASED_RUN; i++) { describe('avatar', () => { it('should return a random avatar url', () => { diff --git a/test/lorem.spec.ts b/test/lorem.spec.ts index c2690e2e5be..2ceb670f3b6 100644 --- a/test/lorem.spec.ts +++ b/test/lorem.spec.ts @@ -121,7 +121,9 @@ describe('lorem', () => { // Create and log-back the seed for debug purposes faker.seed(Math.ceil(Math.random() * 1_000_000_000)); - describe(`random seeded tests for seed ${faker.seedValue}`, () => { + describe(`random seeded tests for seed ${JSON.stringify( + faker.seedValue + )}`, () => { for (let i = 1; i <= NON_SEEDED_BASED_RUN; i++) { describe('word()', () => { it('should return random value from word array', () => { diff --git a/test/music.spec.ts b/test/music.spec.ts index e9f26a4c181..73457e8dbcd 100644 --- a/test/music.spec.ts +++ b/test/music.spec.ts @@ -54,7 +54,9 @@ describe('music', () => { // Create and log-back the seed for debug purposes faker.seed(Math.ceil(Math.random() * 1_000_000_000)); - describe(`random seeded tests for seed ${faker.seedValue}`, () => { + describe(`random seeded tests for seed ${JSON.stringify( + faker.seedValue + )}`, () => { for (let i = 1; i <= NON_SEEDED_BASED_RUN; i++) { describe('genre()', () => { it('should return a genre', () => { diff --git a/test/name.spec.ts b/test/name.spec.ts index 3077e75f01a..a8c0c986032 100644 --- a/test/name.spec.ts +++ b/test/name.spec.ts @@ -165,7 +165,9 @@ describe('name', () => { // Create and log-back the seed for debug purposes faker.seed(Math.ceil(Math.random() * 1_000_000_000)); - describe(`random seeded tests for seed ${faker.seedValue}`, () => { + describe(`random seeded tests for seed ${JSON.stringify( + faker.seedValue + )}`, () => { for (let i = 1; i <= NON_SEEDED_BASED_RUN; i++) { describe('firstName()', () => { beforeEach(() => { diff --git a/test/phone.spec.ts b/test/phone.spec.ts index dc6b00724ad..0f80f038dfa 100644 --- a/test/phone.spec.ts +++ b/test/phone.spec.ts @@ -87,7 +87,9 @@ describe('phone', () => { // Create and log-back the seed for debug purposes faker.seed(Math.ceil(Math.random() * 1_000_000_000)); - describe(`random seeded tests for seed ${faker.seedValue}`, () => { + describe(`random seeded tests for seed ${JSON.stringify( + faker.seedValue + )}`, () => { for (let i = 1; i <= NON_SEEDED_BASED_RUN; i++) { describe('phoneNumber()', () => { it('should return a random phoneNumber with a random format', () => { diff --git a/test/system.spec.ts b/test/system.spec.ts index 731402cb30d..7c6e77609f3 100644 --- a/test/system.spec.ts +++ b/test/system.spec.ts @@ -90,7 +90,9 @@ describe('system', () => { // Create and log-back the seed for debug purposes faker.seed(Math.ceil(Math.random() * 1_000_000_000)); - describe(`random seeded tests for seed ${faker.seedValue}`, () => { + describe(`random seeded tests for seed ${JSON.stringify( + faker.seedValue + )}`, () => { for (let i = 1; i <= NON_SEEDED_BASED_RUN; i++) { describe('commonFileExt()', () => { it('should return common file types', () => { diff --git a/test/time.spec.ts b/test/time.spec.ts index 0727eddb1ff..1146bb083cf 100644 --- a/test/time.spec.ts +++ b/test/time.spec.ts @@ -50,7 +50,9 @@ describe('time', () => { // Create and log-back the seed for debug purposes faker.seed(Math.ceil(Math.random() * 1_000_000_000)); - describe(`random seeded tests for seed ${faker.seedValue}`, () => { + describe(`random seeded tests for seed ${JSON.stringify( + faker.seedValue + )}`, () => { for (let i = 1; i <= NON_SEEDED_BASED_RUN; i++) { describe('recent()', () => { it('should return the recent timestamp in unix time format by default', () => { diff --git a/test/unique.spec.ts b/test/unique.spec.ts index 37f21e7a6ad..483fe05e599 100644 --- a/test/unique.spec.ts +++ b/test/unique.spec.ts @@ -82,7 +82,9 @@ describe('unique', () => { // Create and log-back the seed for debug purposes faker.seed(Math.ceil(Math.random() * 1_000_000_000)); - describe(`random seeded tests for seed ${faker.seedValue}`, () => { + describe(`random seeded tests for seed ${JSON.stringify( + faker.seedValue + )}`, () => { for (let i = 1; i <= NON_SEEDED_BASED_RUN; i++) { describe('unique()', () => { it('should be possible to call a function with no arguments and return a result', () => { diff --git a/test/vehicle.spec.ts b/test/vehicle.spec.ts index f319325843f..b52ccff6b74 100644 --- a/test/vehicle.spec.ts +++ b/test/vehicle.spec.ts @@ -81,7 +81,9 @@ describe('vehicle', () => { // Create and log-back the seed for debug purposes faker.seed(Math.ceil(Math.random() * 1_000_000_000)); - describe(`random seeded tests for seed ${faker.seedValue}`, () => { + describe(`random seeded tests for seed ${JSON.stringify( + faker.seedValue + )}`, () => { for (let i = 1; i <= NON_SEEDED_BASED_RUN; i++) { describe('vehicle()', () => { it('should return a random vehicle', () => { diff --git a/test/word.spec.ts b/test/word.spec.ts index b1b2fd6d052..ac40c8a5e01 100644 --- a/test/word.spec.ts +++ b/test/word.spec.ts @@ -180,7 +180,9 @@ describe('word', () => { // Create and log-back the seed for debug purposes faker.seed(Math.ceil(Math.random() * 1_000_000_000)); - describe(`random seeded tests for seed ${faker.seedValue}`, () => { + describe(`random seeded tests for seed ${JSON.stringify( + faker.seedValue + )}`, () => { for (let i = 1; i <= NON_SEEDED_BASED_RUN; i++) { describe(`adjective`, () => { it('should return adjective from adjective array', () => { From 442812f66a5ad9a42e389ad1ae06dbbcddad4e99 Mon Sep 17 00:00:00 2001 From: ST-DDT Date: Tue, 1 Mar 2022 19:43:21 +0100 Subject: [PATCH 4/4] docs: Fix 'Missing' entries (#565) --- src/helpers.ts | 9 ++++++--- src/vehicle.ts | 3 +++ 2 files changed, 9 insertions(+), 3 deletions(-) diff --git a/src/helpers.ts b/src/helpers.ts index 31878c6462b..7a0cba2264e 100644 --- a/src/helpers.ts +++ b/src/helpers.ts @@ -129,6 +129,7 @@ export class Helpers { * * Takes an array and returns a random element of the array. * + * @template T The type of the entries to pick from. * @param array The array to select an element from. * * @see faker.random.arrayElement() @@ -396,6 +397,7 @@ export class Helpers { * * Uses the modern version of the Fisher–Yates algorithm. * + * @template T The type of the entries to shuffle. * @param o The array to shuffle. Defaults to `[]`. * * @example @@ -423,13 +425,14 @@ export class Helpers { * and outputs a unique array of strings based on that source. * This method does not store the unique state between invocations. * + * @template T The type of the entries. * @param source The strings to choose from or a function that generates a string. * @param length The number of elements to generate. * * @example - * uniqueArray(faker.random.word, 50) - * uniqueArray(faker.definitions.name.first_name, 6) - * uniqueArray(["Hello", "World", "Goodbye"], 2) + * faker.helpers.uniqueArray(faker.random.word, 50) + * faker.helpers.uniqueArray(faker.definitions.name.first_name, 6) + * faker.helpers.uniqueArray(["Hello", "World", "Goodbye"], 2) */ uniqueArray(source: T[] | (() => T), length: number): T[] { if (Array.isArray(source)) { diff --git a/src/vehicle.ts b/src/vehicle.ts index 786617382db..58fb63a14f2 100644 --- a/src/vehicle.ts +++ b/src/vehicle.ts @@ -3,6 +3,9 @@ import type { Fake } from './fake'; let fake: Fake['fake']; +/** + * Module to generate vehicle related entries. + */ export class Vehicle { constructor(private readonly faker: Faker) { fake = faker.fake;