feat: add book module

[cieslarmichal]

Added new Book module as discussed in #2310.

Changes made:

• added a new module with following methods: author, format, genre, publisher, series, title
• added en locale data
• added pl locale data
• added tests for all methods
• added new docs page

[netlify]

✅ Deploy Preview for fakerjs ready!

Built without sensitive environment variables

Name	Link
🔨 Latest commit	4561d0a
🔍 Latest deploy log	https://app.netlify.com/sites/fakerjs/deploys/66dec0b88291000008f1d7ee
😎 Deploy Preview	https://deploy-preview-2949.fakerjs.dev
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site configuration.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.96%. Comparing base (ca9d036) to head (4561d0a).

Additional details and impacted files

@@            Coverage Diff             @@
##             next    #2949      +/-   ##
==========================================
- Coverage   99.96%   99.96%   -0.01%     
==========================================
  Files        2776     2792      +16     
  Lines      226260   227311    +1051     
  Branches      939      585     -354     
==========================================
+ Hits       226180   227230    +1050     
- Misses         80       81       +1     

Files with missing lines	Coverage Δ
src/definitions/book.ts	100.00% <100.00%> (ø)
src/definitions/definitions.ts	100.00% <ø> (ø)
src/definitions/index.ts	100.00% <ø> (ø)
src/faker.ts	100.00% <100.00%> (ø)
src/index.ts	100.00% <ø> (ø)
src/locales/en/book/author.ts	100.00% <100.00%> (ø)
src/locales/en/book/format.ts	100.00% <100.00%> (ø)
src/locales/en/book/genre.ts	100.00% <100.00%> (ø)
src/locales/en/book/index.ts	100.00% <100.00%> (ø)
src/locales/en/book/publisher.ts	100.00% <100.00%> (ø)
... and 12 more

... and 1 file with indirect coverage changes

[xDivisionByZerox]

hello guys, is there anything more I should do here? 🙂

There might be. If there is we will write a comment. 🙂
It's not unusual in open source that PRs will take a while to be fully reviewed and merged.

Please keep in mind that all members and maintainers of FakerJS work on this project in their free time.

[cieslarmichal]

I know, sure, just asking :)

[matthewmayer]

Happy with the API I think it looks good overall!

Maybe we could have a few more books for the title method, I feel 100 is not that many. We normally cap any one data type at 1000. Perhaps we could get up to 200 books?

Non urgent as this probably won't get merged until 9.1

[cieslarmichal]

Ok I will add more book titles

[cieslarmichal]

I have just added more book titles and authors (about 150 each).

[xDivisionByZerox]

I'll already approve. I still have the question if the addition of the polish locale should be it's own PR. That way there would be a separate entry on our reloase notes/changelog.

1. Create book module (new modules have to have applicable locale data in the default locale => en)
2. Add polish locale data for book module.

---

This is not blocking. Just a question on the process.

Edit: Also, thank you @cieslarmichal for the initial waiting, quick implementation and reasonable feedback loops. Was a pleasure reviewing your PR.

[ST-DDT]

I still have the question if the addition of the polish locale should be it's own PR.

Initial data is initial data.
IMO if I consider something useful, I would try it instead of searching the changelog for my locale.
Unless, I know the feature exists and I'm just waiting for it to get available for my locale.
But I don't have a particular strong opinion on this either.

[matthewmayer]

I would say if it's only 2 or 3 locales included it's better to include in the initial commit. That helps verify there are no incorrect assumptions about how the data will be localised (for example in the first version of this PR the pl and en versions of author used different FirstName surname orders. That was good, as it helped us clarify what the rule should be in general and standardise it.)

[cieslarmichal]

Thank you guys for a nice word :) It was a good review process, I am happy about it, can't wait to release those changes 😎