Skip to content

Commit

Permalink
Merge branch 'main' into en_product_names
Browse files Browse the repository at this point in the history
  • Loading branch information
Shinigami92 authored Apr 5, 2022
2 parents 920b1d8 + b34ef46 commit f9d1731
Show file tree
Hide file tree
Showing 75 changed files with 2,053 additions and 1,853 deletions.
14 changes: 7 additions & 7 deletions .github/CODEOWNERS
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
# These owners will be the default owners for everything in the repo.
# Unless a later match takes precedence, @faker-js/maintainers will
# Unless a later match takes precedence, @faker-js/maintainers will
# be requested for review when someone opens a pull request.

* @faker-js/maintainers
* @faker-js/maintainers

# ================================================
# Docs owners ...
# ================================================

/docs/ @faker-js/maintainers-docs
netlify.toml @faker-js/maintainers-docs
README.md @faker-js/maintainers-docs @faker-js/maintainers
CONTRIBUTING.md @faker-js/maintainers-docs
/docs/ @faker-js/maintainers-docs @faker-js/maintainers
netlify.toml @faker-js/maintainers-docs @faker-js/maintainers
README.md @faker-js/maintainers-docs @faker-js/maintainers
CONTRIBUTING.md @faker-js/maintainers-docs @faker-js/maintainers

# ================================================
# CODEOWNERS owners ...
# ================================================

/.github/CODEOWNERS @faker-js/maintainers
/.github/CODEOWNERS @faker-js/maintainers
32 changes: 0 additions & 32 deletions .github/workflows/issue-labeling.yml

This file was deleted.

60 changes: 60 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,66 @@

All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.

## [6.1.2](https://github.com/faker-js/faker/compare/v6.1.1...v6.1.2) (2022-04-04)


### Features

* FakerError ([#718](https://github.com/faker-js/faker/issues/718)) ([c3be3b1](https://github.com/faker-js/faker/commit/c3be3b1945248ed422342b046ad765d252bbac05))


### Bug Fixes

* datatype.number when min = max + precision, throw when max > min ([#664](https://github.com/faker-js/faker/issues/664)) ([0304120](https://github.com/faker-js/faker/commit/03041201c21ad599bbe1874c375f4f41b94961ba))
* deterministic results for address.nearbyGPSCoordinate ([#737](https://github.com/faker-js/faker/issues/737)) ([bc7bd57](https://github.com/faker-js/faker/commit/bc7bd571d8d6c70b046a3bda23c61c527ddb1d4a))
* random word fails on undefined ([#771](https://github.com/faker-js/faker/issues/771)) ([fb1b87e](https://github.com/faker-js/faker/commit/fb1b87e2249798c6257cb5383f73a15022f438f0))
* remove doubled extension in system.filePath ([#300](https://github.com/faker-js/faker/issues/300)) ([2532eb9](https://github.com/faker-js/faker/commit/2532eb9f5a6f73bbc1786ec91952f838d98fd72a))

## [6.1.1](https://github.com/faker-js/faker/compare/v6.1.0...v6.1.1) (2022-03-28)

### Bug Fixes

* forgot to run `pnpm run build`

## [6.1.0](https://github.com/faker-js/faker/compare/v6.0.0-alpha.6...v6.1.0) (2022-03-28)

**WARNING**: This build is broken due to missing build files. Please don't use this version!

### Features

* **types:** generate all locales index files with non-any types ([#494](https://github.com/faker-js/faker/issues/494)) ([b611ca1](https://github.com/faker-js/faker/commit/b611ca1c6f7d756f224a1a7b641e36b531d169be))
* **types:** provide strong typing for locales 2 ([#398](https://github.com/faker-js/faker/issues/398)) ([419e9e2](https://github.com/faker-js/faker/commit/419e9e20a570b44909faf24c9019bf7f232ee7a9))


### Bug Fixes

* accept dates as params for Date methods ([#200](https://github.com/faker-js/faker/issues/200)) ([91a1aab](https://github.com/faker-js/faker/commit/91a1aaba954b7d172c3dd3346567078644b74189))
* alphaNumeric all chars banned ([#550](https://github.com/faker-js/faker/issues/550)) ([c51fb15](https://github.com/faker-js/faker/commit/c51fb1570669284e14915916636de97b7f644e17))
* corrected the Costa Rican IBAN format ([#646](https://github.com/faker-js/faker/issues/646)) ([3f3de78](https://github.com/faker-js/faker/commit/3f3de78c83ae919fd44531ac7ae9caed885800d4))
* correcting the readme file ([#529](https://github.com/faker-js/faker/issues/529)) ([6c9dcdd](https://github.com/faker-js/faker/commit/6c9dcdd03050ef70554fc2bb6ccc0c883fd1edc9))
* datatype.datetime should use static boundaries ([#343](https://github.com/faker-js/faker/issues/343)) ([7141cd7](https://github.com/faker-js/faker/commit/7141cd7d8a2fd505d3338d13ca29fd1ab7a5dc80))
* enable algolia search ([#641](https://github.com/faker-js/faker/issues/641)) ([a759c87](https://github.com/faker-js/faker/commit/a759c8707c2e3758e64e1c174c2de7aad51cd64b))
* fake behavior with special replacement patterns ([#688](https://github.com/faker-js/faker/issues/688)) ([8d1aefb](https://github.com/faker-js/faker/commit/8d1aefbda070265909cedb07af564ea143be74a7))
* fake is unable to return empty strings ([#347](https://github.com/faker-js/faker/issues/347)) ([301a6d2](https://github.com/faker-js/faker/commit/301a6d2024816bf40f1091ccffe6bb81cb7ba7b0))
* **finance:** update iso-3166-1 country codes for IBAN/BIC ([#168](https://github.com/faker-js/faker/issues/168)) ([6050d7a](https://github.com/faker-js/faker/commit/6050d7acbb991568cbdac7b0c16a088aef200abc))
* fix bicycle_types files being named incorrectly ([#477](https://github.com/faker-js/faker/issues/477)) ([7a2a522](https://github.com/faker-js/faker/commit/7a2a522c181dc696f6e9b4767ca18d39bad4476d))
* fix time.recent method signature ([#586](https://github.com/faker-js/faker/issues/586)) ([60d3cc5](https://github.com/faker-js/faker/commit/60d3cc519cd2cab061a23fbe09164d8b59e177ff))
* fix unique method types ([#457](https://github.com/faker-js/faker/issues/457)) ([14df7d3](https://github.com/faker-js/faker/commit/14df7d3f70b54c4a153f5dcf111ef90575bbbe9e))
* force passed locales into faker constructor ([#580](https://github.com/faker-js/faker/issues/580)) ([5ed963f](https://github.com/faker-js/faker/commit/5ed963f1e4928eb2df36f230faf7f9d63b51bef1))
* handle missing or broken locales main index files ([#478](https://github.com/faker-js/faker/issues/478)) ([ff97431](https://github.com/faker-js/faker/commit/ff974319a63acbcbbb96cf1a67a48616de9fd9da))
* mersenne rand invalid input argument ([#577](https://github.com/faker-js/faker/issues/577)) ([486c76e](https://github.com/faker-js/faker/commit/486c76e34f22cf1fd66fa2c99e605d52c7077760))
* move el credit card information to the expected location ([#484](https://github.com/faker-js/faker/issues/484)) ([dcbd18e](https://github.com/faker-js/faker/commit/dcbd18e13ab53e837de17cec7b3f8e51ba479d0e))
* name module gender ([#644](https://github.com/faker-js/faker/issues/644)) ([7675abe](https://github.com/faker-js/faker/commit/7675abe5a62c8d44ecfd4a6f50bfb5fa50f40efa))
* normalize provider in finance.creditCardNumber ([#662](https://github.com/faker-js/faker/issues/662)) ([9ce1551](https://github.com/faker-js/faker/commit/9ce1551ab7c9cafc97e3d051f0632591e34eb3ce))
* only return word with desirable alpha characters ([#654](https://github.com/faker-js/faker/issues/654)) ([b7b2e4f](https://github.com/faker-js/faker/commit/b7b2e4f8dbd40b6bb2678fb60ee95e198838d08a))
* remove invalid aliases ([#488](https://github.com/faker-js/faker/issues/488)) ([58fbfe3](https://github.com/faker-js/faker/commit/58fbfe3835b0f27949e7eb262d246eb9d84bb870))
* remove unreachable code finance ([#508](https://github.com/faker-js/faker/issues/508)) ([1bc622a](https://github.com/faker-js/faker/commit/1bc622a9499bf236052809610ecabe80f87de482))
* replaced placeimg.com on loremflickr.com ([#692](https://github.com/faker-js/faker/issues/692)) ([2a49e82](https://github.com/faker-js/faker/commit/2a49e8215a81ef284a2955f7f9a51d6f2bd76f5f))
* solve various todos ([#649](https://github.com/faker-js/faker/issues/649)) ([d0a473f](https://github.com/faker-js/faker/commit/d0a473f7ca6b525391ca8ab17e029335c66ed99e))
* test random.alphaNumeric ([#517](https://github.com/faker-js/faker/issues/517)) ([41ec6f0](https://github.com/faker-js/faker/commit/41ec6f08784afc2a674568328a0ea2bfb033a411))
* use require/import export map in package.json ([#697](https://github.com/faker-js/faker/issues/697)) ([0f74908](https://github.com/faker-js/faker/commit/0f74908a5ac16d4a9b73d747a275a9399a131757))
* Vehicle vin is always 17 characters long ([#320](https://github.com/faker-js/faker/issues/320)) ([d2fc1e6](https://github.com/faker-js/faker/commit/d2fc1e6b5ba55242d16b9b8a1e9f42c7b24957b0))

## [6.0.0](https://github.com/faker-js/faker/compare/v6.0.0-beta.0...v6.0.0) (2022-03-15)


Expand Down
6 changes: 3 additions & 3 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Faker - Copyright (c) 2022

This software consists of voluntary contributions made by many individuals.
This software consists of voluntary contributions made by many individuals.
For exact contribution history, see the revision history
available at https://github.com/faker-js/faker

Expand All @@ -23,7 +23,7 @@ LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

===
===

From: https://github.com/faker-js/faker/commit/a9f98046c7d5eeaabe12fc587024c06d683800b8
To: https://github.com/faker-js/faker/commit/29234378807c4141588861f69421bf20b5ac635e
Expand Down Expand Up @@ -58,4 +58,4 @@ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,7 @@ pnpm install @faker-js/faker -D

```js
const { faker } = require('@faker-js/faker');

const randomName = faker.name.findName(); // Rowan Nikolaus
const randomEmail = faker.internet.email(); // Kassandra.Haley@erich.biz
const randomPhoneNumber = faker.phone.phoneNumber(); // (279) 329-8663 x30233
Expand Down Expand Up @@ -95,6 +96,12 @@ In order to have faker working properly, you need to check if these `compilerOpt
}
```

And then simply import it like everything else:

```ts
import { faker } from '@faker-js/faker';
```

If you want for whatever reason the versions prior to `v6`,
you can use `@types/faker` and rebind the declarations to the `@faker-js/faker` package with a `faker.d.ts` file in your e.g. src folder.

Expand All @@ -117,7 +124,7 @@ An in-depth overview of the API methods is available in the [documentation](http
| Commerce | `faker.commerce.product()` | Polo t-shirt |
| Company | `faker.company.companyName()` | Zboncak and Sons |
| Database | `faker.database.engine()` | MyISAM |
| Datatype | `faker.datatype.uuid()` | 1oijf8-3iuhiu-21jddj-1092jf |
| Datatype | `faker.datatype.uuid()` | 7b16dd12-935e-4acc-8381-b1e457bf0176 |
| Date | `faker.date.past()` | Sat Oct 20 2018 04:19:38 GMT-0700 (Pacific Daylight Time) |
| Finance | `faker.finance.amount()` | ¥23400 (After setting locale) |
| Git | `faker.git.commitMessage()` | feat: add products list page |
Expand Down
43 changes: 35 additions & 8 deletions docs/.vitepress/config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,26 +4,53 @@ import { apiPages } from './api-pages';

const nav: DefaultTheme.NavItem[] = [
{ text: 'Guide', link: '/guide/' },
// { text: 'Playground', link: '/playground/' },
{
text: 'Ecosystem',
items: [
{ text: 'Discord', link: 'https://chat.fakerjs.dev' },
{ text: 'StackBlitz', link: 'https://fakerjs.dev/new' },
{ text: 'Twitter', link: 'https://twitter.com/faker_js' },
{ text: 'Discord ', link: 'https://chat.fakerjs.dev' },
{ text: 'StackBlitz ', link: 'https://fakerjs.dev/new' },
{ text: 'Twitter ', link: 'https://twitter.com/faker_js' },
],
},
{
text: 'About',
items: [
{
text: 'Announcements',
link: '/about/announcements',
},
{
text: 'Team',
link: '/about/team',
},
],
},
// { text: 'Playground', link: '/playground/' },
];

const sidebar: DefaultTheme.MultiSideBarConfig = {
'/': [
'/about': [
{
text: 'Guide',
text: 'About',
children: [
{
text: 'Recent Statement and FAQs',
link: '/update.html',
text: 'Announcements',
link: '/about/announcements',
children: [
{ text: '2022-01-14', link: '/about/announcements/2022-01-14' },
],
},
{
text: 'Team',
link: '/about/team',
},
],
},
],
'/': [
{
text: 'Guide',
children: [
{
text: 'Getting Started',
link: '/guide/',
Expand Down
7 changes: 7 additions & 0 deletions docs/about/announcements.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
editLink: false
---

# Announcements

- [2022-01-14 - An update from the Faker team](./announcements/2022-01-14)
2 changes: 1 addition & 1 deletion docs/update.md → docs/about/announcements/2022-01-14.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ He gave us permission to re-use his work to create **[fakerjs.dev](https://faker

9. Done a TON of issue triage and many, many PR reviews.

<div style="text-align: center;"><img src="./public/first-week-wins.png" width="600" alt="64 pull requests were opened. 34 were merged. 44 issues were opened. 25 were closed." /></div>
<div style="text-align: center;"><img src="/first-week-wins.png" width="600" alt="64 pull requests were opened. 34 were merged. 44 issues were opened. 25 were closed." /></div>

10. We've gotten in contact with the [Open Collective](https://opencollective.com) and discussed a transition plan for the project.

Expand Down
9 changes: 9 additions & 0 deletions docs/about/team.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
title: Team
---

<script setup>
import TeamPage from './team/TeamPage.vue'
</script>

<TeamPage />
7 changes: 7 additions & 0 deletions docs/about/team/TeamMember.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
export interface Member {
readonly name: string;
readonly github: string;
readonly gitlab?: string;
readonly twitter?: string;
readonly roles: readonly string[];
}
76 changes: 76 additions & 0 deletions docs/about/team/TeamMember.vue
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
<script lang="ts" setup>
import type { Member } from './TeamMember';
defineProps<{ member: Member }>();
</script>

<template>
<div class="TeamMember">
<div class="avatar">
<img :src="'https://github.com/' + member.github + '.png'" width="120" />
</div>
<div class="info">
<div class="name">
<b>{{ member.name }}</b>
</div>
<div class="socials">
<a :href="'https://github.com/' + member.github">
<img
src="https://img.icons8.com/ios-glyphs/344/github.png"
alt="GitHub"
title="GitHub"
width="32"
/>
</a>
<a v-if="member.gitlab" :href="'https://gitlab.com/' + member.gitlab">
<img
src="https://img.icons8.com/color/344/gitlab.png"
alt="GitLab"
title="GitLab"
width="32"
/>
</a>
<a
v-if="member.twitter"
:href="'https://twitter.com/' + member.twitter"
>
<img
src="https://img.icons8.com/color/344/twitter.png"
alt="Twitter"
title="Twitter"
width="32"
/>
</a>
</div>
<div v-if="member.roles?.length" class="roles">
<span>Roles: </span>
<template v-for="(role, index) in member.roles">
<i>{{ role }}</i>
<span v-if="index < member.roles.length - 1">, </span>
</template>
</div>
</div>
</div>
</template>

<style scoped>
.TeamMember {
padding: 0.5em;
display: flex;
align-items: center;
}
.TeamMember .avatar {
flex: 0 0 120px;
margin-right: 1em;
}
.TeamMember .avatar img {
border-radius: 50%;
}
.TeamMember .roles i {
white-space: nowrap;
}
</style>
Loading

0 comments on commit f9d1731

Please sign in to comment.