feat: only generate IANA example domains#3967
Open
hazrid93 wants to merge 1 commit into
Open
Conversation
✅ Deploy Preview for fakerjs ready!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify project configuration. |
ST-DDT
requested changes
Jul 20, 2026
ST-DDT
left a comment
ST-DDT
left a comment
Member
There was a problem hiding this comment.
CI is failing. Please run pnpn run preflight before commiting.
ST-DDT
marked this pull request as draft
July 20, 2026 12:45
Closes faker-js#2228. Add an optional `{ allowOnlyExamples?: boolean }`: when true, returns <word>.example.<com|org|net>: a 3 label subdomain under the IANA reserved example domains (RFC 2606), which never resolve. Default (no option / false) behavior is unchanged.
hazrid93
force-pushed
the
hazrid93/99_2228
branch
from
July 20, 2026 13:12
f2d5f92 to
a6d3a03
Compare
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## next #3967 +/- ##
=======================================
Coverage 98.91% 98.91%
=======================================
Files 923 924 +1
Lines 3223 3228 +5
Branches 567 586 +19
=======================================
+ Hits 3188 3193 +5
Misses 31 31
Partials 4 4
🚀 New features to boost your workflow:
|
ST-DDT
added
c: feature
ST-DDT
marked this pull request as ready for review
July 20, 2026 13:40
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds an opt-in way to generate domain names under IANA-reserved “example” domains to reduce the chance of producing domains that might be mistaken for real sites, addressing #2228.
Changes:
- Extend
internet.domainName()with an optional{ allowOnlyExamples?: boolean }parameter that produces<word>.example.<com|org|net>when enabled. - Update seeded internet module tests to cover both the default
domainName()call and the new option. - Refresh snapshots to reflect the new test structure and the example-domain output.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| test/modules/internet.spec.ts | Adds a dedicated domainName test group to exercise the new option. |
| test/modules/snapshots/internet.spec.ts.snap | Updates snapshot keys/values for the new domainName cases. |
| src/modules/internet/module.ts | Implements allowOnlyExamples behavior and documents the new option. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+543
to
+545
| * @param options The optional options object. | ||
| * @param options.allowOnlyExamples When `true`, generate a domain under the IANA-reserved example domains (example.com / example.org / example.net) so the result never resolves to a real host. See issue #2228. | ||
| * |
Comment on lines
+553
to
+555
| /** | ||
| * When `true`, generate a domain under the IANA-reserved example domains (example.com / example.org / example.net) so the result never resolves to a real host. | ||
| */ |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #2228.
Add an optional
{ allowOnlyExamples?: boolean }: when true, returns .example.<com|org|net>: a 3 label subdomain under the IANA reserved example domains (RFC 2606), which never resolve. Default (no option / false) behavior is unchanged.