docs(isURL): add info about require_tld #2537

sgress454 · Mar 27, 2025

Adds information about the require_tld option to the isURL docs. Although present in the description of the options defaults, it's not listed among the other options so it's easy to miss that this helpful option exists (I did).

The options list here is a bit inconsistent as far as the "If set to true..." vs. "If set to false..." language; I opted for "If set to false" since the default is true. Happy to clean these all up to make them consistent if there's appetite for that, but I'm starting with a low-touch PR.

Checklist

PR contains only changes related; no stray files, etc.
README updated (where applicable)

WikiRik · Mar 27, 2025

Thanks for the PR! I'll check what's wrong with the tests, that should not be due to your change

WikiRik

I think we want to add this information in other places as well;

validator.js/src/lib/isURL.js

Lines 8 to 21 in 2866bb1

    
           /* 
        
           options for isURL method 
        
           require_protocol - if set as true isURL will return false if protocol is not present in the URL 
        
           require_valid_protocol - isURL will check if the URL's protocol is present in the protocols option 
        
           protocols - valid protocols can be modified with this option 
        
           require_host - if set as false isURL will not check if host is present in the URL 
        
           require_port - if set as true isURL will check if port is present in the URL 
        
           allow_protocol_relative_urls - if set as true protocol relative URLs will be allowed 
        
           validate_length - if set as false isURL will skip string length validation 
        
             max_allowed_length will be ignored if this is set as false 
        
           max_allowed_length - if set isURL will not allow URLs longer than max_allowed_length 
        
             default is 2084 that IE maximum URL length 
        
           */

validator.js/README.md

Line 113 in 2866bb1

    
           **isFQDN(str [, options])**             | check if the string is a fully qualified domain name (e.g. domain.com).<br/><br/>`options` is an object which defaults to `{ require_tld: true, allow_underscores: false, allow_trailing_dot: false, allow_numeric_tld: false, allow_wildcard: false, ignore_max_length: false }`. If `allow_wildcard` is set to true, the validator will allow domain starting with `*.` (e.g. `*.example.com` or `*.shop.example.com`).

Could you add those as well?

Note that isEmail already has information about require_tld;

validator.js/README.md

Line 109 in 2866bb1

    
           **isEmail(str [, options])**            | check if the string is an email.<br/><br/>`options` is an object which defaults to `{ allow_display_name: false, require_display_name: false, allow_utf8_local_part: true, require_tld: true, allow_ip_domain: false, allow_underscores: false, domain_specific_validation: false, blacklisted_chars: '', host_blacklist: [] }`. If `allow_display_name` is set to true, the validator will also match `Display Name <email-address>`. If `require_display_name` is set to true, the validator will reject strings without the format `Display Name <email-address>`. If `allow_utf8_local_part` is set to false, the validator will not allow any non-English UTF8 character in email address' local part. If `require_tld` is set to false, email addresses without a TLD in their domain will also be matched. If `ignore_max_length` is set to true, the validator will not check for the standard max length of an email. If `allow_ip_domain` is set to true, the validator will allow IP addresses in the host part. If `domain_specific_validation` is true, some additional validation will be enabled, e.g. disallowing certain syntactically valid email addresses that are rejected by Gmail. If `blacklisted_chars` receives a string, then the validator will reject emails that include any of the characters in the string, in the name part. If `host_blacklist` is set to an array of strings or regexp, and the part of the email after the `@` symbol matches one of the strings defined in it, the validation fails. If `host_whitelist` is set to an array of strings or regexp, and the part of the email after the `@` symbol matches none of the strings defined in it, the validation fails.

…rl-docs

sgress454 · Mar 28, 2025

@WikiRik updated!

sgress454 · Mar 28, 2025

Let me know when #2538 is in and I'll merge main again.

WikiRik

Nitpicky comments, but would be great if you could implement this as well

README.md

src/lib/isURL.js

sgress454 · Mar 30, 2025

would be great if you could implement this as well

Sure thing!

WikiRik · Apr 8, 2025

@sgress454 we've updated the CI workflow file so I'm not allowed to update your branch. Could you do it yourself?

…rl-docs

codecov · Apr 11, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (bdb8f9e) to head (5fcb23e).
Report is 2 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff            @@
##            master     #2537   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          114       114           
  Lines         2535      2535           
  Branches       641       641           
=========================================
  Hits          2535      2535

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

sgress454 · Apr 11, 2025

@WikiRik ✅ !

update isurl docs

f771905

sgress454 mentioned this pull request Mar 27, 2025

Full-stack: Make "Server url" validation conditions consistent across Fleet, update Web Address form validation and submission logic per Fleet best practices (frontend/docs/patterns.md) fleetdm/fleet#27455

Merged

4 tasks

sgress454 changed the title ~~(docs)isURL: add info about require_tld~~ docs(isURL): add info about require_tld Mar 27, 2025

WikiRik requested changes Mar 27, 2025

View reviewed changes

sgress454 added 4 commits March 28, 2025 18:00

update other locations

8aa4e0c

fix typo

fc69b76

url -> domain

93083ad

Merge remote-tracking branch 'main/master' into sgress454/update-is-u…

0d6e30b

…rl-docs

WikiRik previously approved these changes Mar 28, 2025

View reviewed changes

README.md Outdated Show resolved Hide resolved

README.md Outdated Show resolved Hide resolved

src/lib/isURL.js Outdated Show resolved Hide resolved

clean up docs a bit more

2699ea4

sgress454 dismissed WikiRik’s stale review via 2699ea4 March 30, 2025 19:16

Merge branch 'master' into sgress454/update-is-url-docs

c997eaa

sgress454 added 2 commits April 11, 2025 11:55

Merge remote-tracking branch 'main/master' into sgress454/update-is-u…

c84f6b9

…rl-docs

lint

5fcb23e

WikiRik approved these changes Apr 21, 2025

View reviewed changes

WikiRik requested a review from rubiin April 21, 2025 16:34

rubiin approved these changes Apr 21, 2025

View reviewed changes

rubiin merged commit d91af4b into validatorjs:master Apr 21, 2025
13 checks passed

WikiRik mentioned this pull request May 14, 2025

maintenance: 2505 release #2560

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

docs(isURL): add info about require_tld #2537

docs(isURL): add info about require_tld #2537

Uh oh!

sgress454 commented Mar 27, 2025

Uh oh!

WikiRik commented Mar 27, 2025

Uh oh!

WikiRik left a comment

Uh oh!

sgress454 commented Mar 28, 2025

Uh oh!

sgress454 commented Mar 28, 2025

Uh oh!

WikiRik left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

sgress454 commented Mar 30, 2025

Uh oh!

WikiRik commented Apr 8, 2025

Uh oh!

codecov bot commented Apr 11, 2025 •

edited

Loading

Uh oh!

sgress454 commented Apr 11, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

	/*
	options for isURL method

	require_protocol - if set as true isURL will return false if protocol is not present in the URL
	require_valid_protocol - isURL will check if the URL's protocol is present in the protocols option
	protocols - valid protocols can be modified with this option
	require_host - if set as false isURL will not check if host is present in the URL
	require_port - if set as true isURL will check if port is present in the URL
	allow_protocol_relative_urls - if set as true protocol relative URLs will be allowed
	validate_length - if set as false isURL will skip string length validation
	max_allowed_length will be ignored if this is set as false
	max_allowed_length - if set isURL will not allow URLs longer than max_allowed_length
	default is 2084 that IE maximum URL length
	*/

Search code, repositories, users, issues, pull requests...

Uh oh!

docs(isURL): add info about require_tld #2537

docs(isURL): add info about require_tld #2537

Uh oh!

Conversation

sgress454 commented Mar 27, 2025

Checklist

Uh oh!

WikiRik commented Mar 27, 2025

Uh oh!

WikiRik left a comment

Choose a reason for hiding this comment

Uh oh!

sgress454 commented Mar 28, 2025

Uh oh!

sgress454 commented Mar 28, 2025

Uh oh!

WikiRik left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

sgress454 commented Mar 30, 2025

Uh oh!

WikiRik commented Apr 8, 2025

Uh oh!

codecov bot commented Apr 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

sgress454 commented Apr 11, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

codecov bot commented Apr 11, 2025 •

edited

Loading