Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

test: ensure working examples and no console spam #908

Merged
merged 9 commits into from
May 4, 2022
Merged

test: ensure working examples and no console spam #908

merged 9 commits into from
May 4, 2022

Conversation

ST-DDT
Copy link
Member

@ST-DDT ST-DDT commented May 2, 2022 •
edited
Loading

May be merged after #907.
Prevents issues such as #902.

This PR adds tests ensuring, that every method

  • has working examples
  • and running these does not log anything, unless the method is deprecated

Can be tested by:

  • removing or adding @deprecated
  • replacing faker.helpers.arrayElement with faker.random.arrayElement (or any other deprecated method)
  • removing or modifying examples

@ST-DDT ST-DDT added the c: test label May 2, 2022
@ST-DDT ST-DDT added this to the v7.0 - Next Minor milestone May 2, 2022
@ST-DDT ST-DDT requested review from a team May 2, 2022 23:53
@ST-DDT ST-DDT self-assigned this May 2, 2022
@ST-DDT ST-DDT added s: on hold Blocked by something or frozen to avoid conflicts p: 1-normal Nothing urgent labels May 2, 2022
@ST-DDT ST-DDT mentioned this pull request May 2, 2022
Merged
@ST-DDT ST-DDT removed the s: on hold Blocked by something or frozen to avoid conflicts label May 3, 2022
@codecov
Copy link

codecov bot commented May 3, 2022 •
edited
Loading

Codecov Report

Merging #908 (6daa9c9) into main (39b74c0) will increase coverage by 0.00%.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #908   +/-   ##
=======================================
  Coverage   99.67%   99.67%           
=======================================
  Files        1957     1957           
  Lines      209768   209768           
  Branches      878      885    +7     
=======================================
+ Hits       209082   209084    +2     
+ Misses        666      664    -2     
  Partials       20       20
Impacted Files Coverage Δ
src/modules/finance/index.ts 99.31% <0.00%> (-0.69%) ⬇️
src/modules/helpers/index.ts 98.52% <0.00%> (+0.21%) ⬆️
src/modules/image/index.ts 100.00% <0.00%> (+1.15%) ⬆️

@ST-DDT ST-DDT requested review from a team and Shinigami92 May 3, 2022 18:35
@ST-DDT @Shinigami92
chore: apply suggestions
f66ae73 
Co-authored-by: Shinigami <[email protected]>
@ST-DDT ST-DDT requested review from Shinigami92 and a team May 4, 2022 10:06
Shinigami92
Shinigami92 approved these changes May 4, 2022
View reviewed changes
Copy link
Member

@Shinigami92 Shinigami92 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is really nice 👌

@ST-DDT ST-DDT requested a review from a team May 4, 2022 10:16
@Shinigami92 Shinigami92 enabled auto-merge (squash) May 4, 2022 12:51
@Shinigami92 Shinigami92 merged commit f1dba1b into main May 4, 2022
@Shinigami92 Shinigami92 deleted the test/examples-and-deprecations branch May 4, 2022 13:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Shinigami92 Shinigami92 Shinigami92 approved these changes

@ejcheng ejcheng ejcheng approved these changes

Assignees

@ST-DDT ST-DDT

Labels
c: test p: 1-normal Nothing urgent
Projects
No open projects
Faker Roadmap
Status: Done
Milestone
v7.0 - Structural Breaking Changes
Development

Successfully merging this pull request may close these issues.
3 participants
@ST-DDT @Shinigami92 @ejcheng