feat(food): new module #2484

xDivisionByZerox · 2023-10-17T20:18:07Z

Description

MVP implementation for a new FoodModule. The locale data is based on the dataset of the ruby Faker library.

Feel free to discuss certain implementation details or locale data as you wish.

More Context

Resolves #1593.

codecov · 2023-10-17T20:23:35Z

Codecov Report

Attention: 56 lines in your changes are missing coverage. Please review.

Comparison is base (0e4b93f) 99.57% compared to head (2118804) 99.55%.

Additional details and impacted files

@@            Coverage Diff             @@
##             next    #2484      +/-   ##
==========================================
- Coverage   99.57%   99.55%   -0.02%     
==========================================
  Files        2807     2820      +13     
  Lines      250526   251739    +1213     
  Branches     1149     1167      +18     
==========================================
+ Hits       249450   250613    +1163     
- Misses       1076     1097      +21     
- Partials        0       29      +29

Files	Coverage Δ
src/faker.ts	`89.93% <100.00%> (+0.04%)`	⬆️
src/index.ts	`100.00% <100.00%> (ø)`
src/locales/en/food/adjective.ts	`100.00% <100.00%> (ø)`
src/locales/en/food/description_pattern.ts	`100.00% <100.00%> (ø)`
src/locales/en/food/dish.ts	`100.00% <100.00%> (ø)`
src/locales/en/food/dish_pattern.ts	`100.00% <100.00%> (ø)`
src/locales/en/food/ethnic_category.ts	`100.00% <100.00%> (ø)`
src/locales/en/food/fruit.ts	`100.00% <100.00%> (ø)`
src/locales/en/food/index.ts	`100.00% <100.00%> (ø)`
src/locales/en/food/ingredient.ts	`100.00% <100.00%> (ø)`
... and 8 more

... and 28 files with indirect coverage changes

test.ts

test/modules/__snapshots__/food.spec.ts.snap

test/modules/food.spec.ts

src/locales/en/food/dish.ts

src/locales/en/food/fruit.ts

src/locales/en/food/description_pattern.ts

ST-DDT · 2023-10-30T09:35:39Z

Please fix the "merge conflicts" (although I don't think there are any for local executions).

matthewmayer · 2024-01-19T08:54:44Z

@xDivisionByZerox would you be OK with me continuing work on this to address some of the feedback and get to an MVP?

xDivisionByZerox · 2024-01-19T09:06:38Z

@xDivisionByZerox would you be OK with me continuing work on this to address some of the feedback and get to an MVP?

@matthewmayer I would be happy if you would continue working on this.

- add new definitions for adjective, dish_pattern and meat - add more description patterns - make most definitions lower case and singular - alphabeticize definitions

implemented

matthewmayer · 2024-01-19T13:50:37Z

You can see a sample menu from the Faker Bistro here ;)

https://gist.github.com/matthewmayer/794406e8281e2c796e70495a1598ec50

Generated with:

console.log(faker.helpers.multiple(a=>faker.helpers.fake("**{{food.dish}}** - {{commerce.price({\"max\":30})}}\n\n{{food.description}}\n\n"),{count:50}).join(""))

src/modules/food/index.ts

Co-authored-by: ST-DDT <ST-DDT@gmx.de>

ST-DDT · 2024-02-10T11:18:18Z

FFR: This feature would benefit from #2584

add multipleOf to faker.number.int #2584 (comment)

ST-DDT

A little typo but otherwise good to go.

src/modules/food/index.ts

Co-authored-by: ST-DDT <ST-DDT@gmx.de>

IgnusG · 2024-02-24T17:29:22Z

Just checking out of curiosity, I see a new version with this module has not been published yet. Is that intentional?

matthewmayer · 2024-02-24T19:21:11Z

Yes it's intentional it will appear in v9 but there are a few more things to merge before the first alpha/beta version of v9 will be released.

xDivisionByZerox added 5 commits October 17, 2023 19:49

feat(food): new module

c77c60c

feat(locale): add food data for en

697c9ed

test(food): add

27cd5e6

docs: add food to api page

40ded56

docs: add basic JSDocs

3e10b78

xDivisionByZerox added c: feature Request for new feature p: 1-normal Nothing urgent s: accepted Accepted feature / Confirmed bug labels Oct 17, 2023

xDivisionByZerox added this to the vAnytime milestone Oct 17, 2023

xDivisionByZerox self-assigned this Oct 17, 2023

xDivisionByZerox requested a review from a team October 17, 2023 20:18

xDivisionByZerox requested a review from a team as a code owner October 17, 2023 20:18

xDivisionByZerox added the m: food Something is referring to the food module label Oct 17, 2023

xDivisionByZerox mentioned this pull request Oct 17, 2023

Add food module on faker 🍽 #1593

Closed

ST-DDT reviewed Oct 17, 2023

View reviewed changes

test.ts Outdated Show resolved Hide resolved

test/modules/__snapshots__/food.spec.ts.snap Outdated Show resolved Hide resolved

test/modules/food.spec.ts Outdated Show resolved Hide resolved

chore: remove accidental committed file

8d8f704

matthewmayer requested changes Oct 18, 2023

View reviewed changes

src/locales/en/food/dish.ts Outdated Show resolved Hide resolved

matthewmayer requested changes Oct 18, 2023

View reviewed changes

src/locales/en/food/fruit.ts Outdated Show resolved Hide resolved

matthewmayer requested changes Oct 18, 2023

View reviewed changes

src/locales/en/food/description_pattern.ts Outdated Show resolved Hide resolved

ST-DDT added s: needs decision Needs team/maintainer decision and removed s: needs decision Needs team/maintainer decision labels Oct 20, 2023

matthewmayer previously requested changes Oct 25, 2023

View reviewed changes

src/locales/en/food/description_pattern.ts Outdated Show resolved Hide resolved

ST-DDT added the needs rebase There is a merge conflict label Oct 30, 2023

matthewmayer added 3 commits January 19, 2024 20:32

fix merge

44889ec

new definitions and methods

a5d743c

- add new definitions for adjective, dish_pattern and meat - add more description patterns - make most definitions lower case and singular - alphabeticize definitions

fix lint

c21cf81

fix tests

f5515d4

matthewmayer added 2 commits January 19, 2024 20:53

tweak descriptions

be599a5

fix snapshot

368d9ce

ST-DDT reviewed Jan 19, 2024

View reviewed changes

src/modules/food/index.ts Outdated Show resolved Hide resolved

src/modules/food/index.ts Outdated Show resolved Hide resolved

matthewmayer and others added 5 commits January 20, 2024 08:13

Update index.ts

ee30d87

Co-authored-by: ST-DDT <ST-DDT@gmx.de>

fix imports

c78f0d5

Merge branch 'next' into feat/food-module

958f1b6

fix lint, tweak title case

a3da8ce

MD tweak

e7e8f05

matthewmayer removed the needs rebase There is a merge conflict label Jan 23, 2024

Merge branch 'next' into feat/food-module

20b8414

ST-DDT assigned matthewmayer Feb 10, 2024

ST-DDT previously approved these changes Feb 10, 2024

View reviewed changes

src/modules/food/index.ts Outdated Show resolved Hide resolved

matthewmayer dismissed ST-DDT’s stale review via 8389722 February 10, 2024 11:31

Update index.ts

8389722

Co-authored-by: ST-DDT <ST-DDT@gmx.de>

ST-DDT approved these changes Feb 10, 2024

View reviewed changes

ST-DDT requested review from a team February 10, 2024 11:49

Shinigami92 approved these changes Feb 10, 2024

View reviewed changes

ejcheng approved these changes Feb 11, 2024

View reviewed changes

Merge branch 'next' into feat/food-module

2118804

ST-DDT enabled auto-merge (squash) February 11, 2024 10:25

ST-DDT merged commit 9aab7c2 into next Feb 11, 2024
16 checks passed

ST-DDT deleted the feat/food-module branch February 11, 2024 10:29

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(food): new module #2484

feat(food): new module #2484

xDivisionByZerox commented Oct 17, 2023

codecov bot commented Oct 17, 2023 •

edited

Loading

ST-DDT commented Oct 30, 2023

matthewmayer commented Jan 19, 2024

xDivisionByZerox commented Jan 19, 2024

matthewmayer commented Jan 19, 2024

ST-DDT commented Feb 10, 2024

ST-DDT left a comment

IgnusG commented Feb 24, 2024

matthewmayer commented Feb 24, 2024

feat(food): new module #2484

feat(food): new module #2484

Conversation

xDivisionByZerox commented Oct 17, 2023

Description

More Context

codecov bot commented Oct 17, 2023 • edited Loading

Codecov Report

ST-DDT commented Oct 30, 2023

matthewmayer commented Jan 19, 2024

xDivisionByZerox commented Jan 19, 2024

matthewmayer commented Jan 19, 2024

ST-DDT commented Feb 10, 2024

ST-DDT left a comment

Choose a reason for hiding this comment

IgnusG commented Feb 24, 2024

matthewmayer commented Feb 24, 2024

codecov bot commented Oct 17, 2023 •

edited

Loading