docs(isURL): add info about require_tld #2537

sgress454 · 2025-03-27T15:18:29Z

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 · 2025-03-27T16:02:49Z

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 · 2025-03-28T23:08:54Z

@WikiRik updated!

sgress454 · 2025-03-28T23:13:45Z

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

WikiRik · 2025-03-28T23:30:08Z

README.md

@@ -110,7 +110,7 @@ Validator                               | Description
 **isEmpty(str [, options])**            | check if the string has a length of zero.<br/><br/>`options` is an object which defaults to `{ ignore_whitespace: false }`.
 **isEthereumAddress(str)**              | check if the string is an [Ethereum][Ethereum] address. Does not validate address checksums.
 **isFloat(str [, options])**            | check if the string is a float.<br/><br/>`options` is an object which can contain the keys `min`, `max`, `gt`, and/or `lt` to validate the float is within boundaries (e.g. `{ min: 7.22, max: 9.55 }`) it also has `locale` as an option.<br/><br/>`min` and `max` are equivalent to 'greater or equal' and 'less or equal', respectively while `gt` and `lt` are their strict counterparts.<br/><br/>`locale` determines the decimal separator and is one of `['ar', 'ar-AE', 'ar-BH', 'ar-DZ', 'ar-EG', 'ar-IQ', 'ar-JO', 'ar-KW', 'ar-LB', 'ar-LY', 'ar-MA', 'ar-QA', 'ar-QM', 'ar-SA', 'ar-SD', 'ar-SY', 'ar-TN', 'ar-YE', 'bg-BG', 'cs-CZ', 'da-DK', 'de-DE', 'en-AU', 'en-GB', 'en-HK', 'en-IN', 'en-NZ', 'en-US', 'en-ZA', 'en-ZM', 'eo', 'es-ES', 'fr-CA', 'fr-FR', 'hu-HU', 'it-IT', 'nb-NO', 'nl-NL', 'nn-NO', 'pl-PL', 'pt-BR', 'pt-PT', 'ru-RU', 'sl-SI', 'sr-RS', 'sr-RS@latin', 'sv-SE', 'tr-TR', 'uk-UA']`. Locale list is `validator.isFloatLocales`.
-**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`).
+**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 }`.<br/><br/>`allow_wildcard` - if set to true, the validator will allow domains starting with `*.` (e.g. `*.example.com` or `*.shop.example.com`).<br/>`allow_trailing_dot` - if set to true, the validator will allow the domain to end with a `.` character.<br/>`allow_numeric_tld` - if set to true, the validator will allow the TLD of the domain to be made up solely of numbers.<br/>`allow_underscores` - if set to true, the validator will allow underscores in the domain.<br/>`ignore_max_length` - if set to true, the validator will not check for the standard max length of a domain.<br/>`require_tld` - If set to false the validator will not check if the domain includes a TLD.


Could you use the same order for the explanation of the options as the default object? So start with explaining require_tld etc

WikiRik · 2025-03-28T23:30:21Z

README.md

@@ -167,7 +167,7 @@ Validator                               | Description
 **isStrongPassword(str [, options])**   | check if the string can be considered a strong password or not. Allows for custom requirements or scoring rules. If `returnScore` is true, then the function returns an integer score for the password rather than a boolean.<br/>Default options: <br/>`{ minLength: 8, minLowercase: 1, minUppercase: 1, minNumbers: 1, minSymbols: 1, returnScore: false, pointsPerUnique: 1, pointsPerRepeat: 0.5, pointsForContainingLower: 10, pointsForContainingUpper: 10, pointsForContainingNumber: 10, pointsForContainingSymbol: 10 }`
 **isTime(str [, options])**             | check if the string is a valid time e.g. [`23:01:59`, new Date().toLocaleTimeString()].<br/><br/> `options` is an object which can contain the keys `hourFormat` or `mode`.<br/><br/>`hourFormat` is a key and defaults to `'hour24'`.<br/><br/>`mode` is a key and defaults to `'default'`. <br/><br/>`hourFormat` can contain the values `'hour12'` or `'hour24'`, `'hour24'` will validate hours in 24 format and `'hour12'` will validate hours in 12 format. <br/><br/>`mode` can contain the values `'default', 'withSeconds', withOptionalSeconds`, `'default'` will validate `HH:MM` format, `'withSeconds'` will validate the `HH:MM:SS` format, `'withOptionalSeconds'` will validate `'HH:MM'` and `'HH:MM:SS'` formats.
 **isTaxID(str, locale)**                | check if the string is a valid Tax Identification Number. Default locale is `en-US`.<br/><br/>More info about exact TIN support can be found in `src/lib/isTaxID.js`.<br/><br/>Supported locales: `[ 'bg-BG', 'cs-CZ', 'de-AT', 'de-DE', 'dk-DK', 'el-CY', 'el-GR', 'en-CA', 'en-GB', 'en-IE', 'en-US', 'es-AR', 'es-ES', 'et-EE', 'fi-FI', 'fr-BE', 'fr-CA', 'fr-FR', 'fr-LU', 'hr-HR', 'hu-HU', 'it-IT', 'lb-LU', 'lt-LT', 'lv-LV', 'mt-MT', 'nl-BE', 'nl-NL', 'pl-PL', 'pt-BR', 'pt-PT', 'ro-RO', 'sk-SK', 'sl-SI', 'sv-SE', 'uk-UA']`.
-**isURL(str [, options])**              | check if the string is a URL.<br/><br/>`options` is an object which defaults to `{ protocols: ['http','https','ftp'], require_tld: true, require_protocol: false, require_host: true, require_port: false, require_valid_protocol: true, allow_underscores: false, host_whitelist: false, host_blacklist: false, allow_trailing_dot: false, allow_protocol_relative_urls: false, allow_fragments: true, allow_query_components: true, disallow_auth: false, validate_length: true }`.<br/><br/>`require_protocol` - if set to true isURL will return false if protocol is not present in the URL.<br/>`require_valid_protocol` - isURL will check if the URL's protocol is present in the protocols option.<br/>`protocols` - valid protocols can be modified with this option.<br/>`require_host` - if set to false isURL will not check if host is present in the URL.<br/>`require_port` - if set to true isURL will check if port is present in the URL.<br/>`allow_protocol_relative_urls` - if set to true protocol relative URLs will be allowed.<br/>`allow_fragments` - if set to false isURL will return false if fragments are present.<br/>`allow_query_components` - if set to false isURL will return false if query components are present.<br/>`validate_length` - if set to false isURL will skip string length validation. `max_allowed_length` will be ignored if this is set as `false`.<br/>`max_allowed_length` - if set isURL will not allow URLs longer than the specified value (default is 2084 that IE maximum URL length).
+**isURL(str [, options])**              | check if the string is a URL.<br/><br/>`options` is an object which defaults to `{ protocols: ['http','https','ftp'], require_tld: true, require_protocol: false, require_host: true, require_port: false, require_valid_protocol: true, allow_underscores: false, host_whitelist: false, host_blacklist: false, allow_trailing_dot: false, allow_protocol_relative_urls: false, allow_fragments: true, allow_query_components: true, disallow_auth: false, validate_length: true }`.<br/><br/>`require_protocol` - if set to true isURL will return false if protocol is not present in the URL.<br/>`require_valid_protocol` - isURL will check if the URL's protocol is present in the protocols option.<br/>`require_tld` - If set to false isURL will not check if the URL's host includes a top-level domain.<br/>`protocols` - valid protocols can be modified with this option.<br/>`require_host` - if set to false isURL will not check if host is present in the URL.<br/>`require_port` - if set to true isURL will check if port is present in the URL.<br/>`allow_protocol_relative_urls` - if set to true protocol relative URLs will be allowed.<br/>`allow_fragments` - if set to false isURL will return false if fragments are present.<br/>`allow_query_components` - if set to false isURL will return false if query components are present.<br/>`validate_length` - if set to false isURL will skip string length validation. `max_allowed_length` will be ignored if this is set as `false`.<br/>`max_allowed_length` - if set isURL will not allow URLs longer than the specified value (default is 2084 that IE maximum URL length).


Same comment here

WikiRik · 2025-03-28T23:30:41Z

src/lib/isURL.js

@@ -8,6 +8,7 @@ import merge from './util/merge';
 /*
 options for isURL method

+require_tld - If set to false isURL will not check if the URL's host includes a top-level domain


And here as well, just so we have at least some consistency

sgress454 · 2025-03-30T19:16:43Z

would be great if you could implement this as well

Sure thing!

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

clean up docs a bit more

2699ea4

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

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs(isURL): add info about require_tld #2537

docs(isURL): add info about require_tld #2537

sgress454 commented Mar 27, 2025

WikiRik commented Mar 27, 2025

WikiRik left a comment

sgress454 commented Mar 28, 2025

sgress454 commented Mar 28, 2025

WikiRik left a comment

WikiRik Mar 28, 2025

WikiRik Mar 28, 2025

WikiRik Mar 28, 2025

sgress454 commented Mar 30, 2025

	/*
	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
	*/

docs(isURL): add info about require_tld #2537

Are you sure you want to change the base?

docs(isURL): add info about require_tld #2537

Conversation

sgress454 commented Mar 27, 2025

Checklist

WikiRik commented Mar 27, 2025

WikiRik left a comment

Choose a reason for hiding this comment

sgress454 commented Mar 28, 2025

sgress454 commented Mar 28, 2025

WikiRik left a comment

Choose a reason for hiding this comment

WikiRik Mar 28, 2025

Choose a reason for hiding this comment

WikiRik Mar 28, 2025

Choose a reason for hiding this comment

WikiRik Mar 28, 2025

Choose a reason for hiding this comment

sgress454 commented Mar 30, 2025