docs: Improve consistency and fix errors in README.md by pano9000 · Pull Request #2107 · validatorjs/validator.js · GitHub

Hello Team,

I have spent some time to go through the "Validators" section of the README.md and fix some typos, mistakes and general inconsistencies, e.g. inconsistent use of terms or formatting across these validators.

This also fixes two errors:

54cf4c9 fixes the isSlug description, which mentions something about an "option" which is not present in the code
bd86f0b fixes the isLicensePlate description, which was hinting that the locale parameter is optional, while in fact the current code will throw an error (Uncaught Error: Invalid locale 'undefined'), if you try to run it without passing a locale as argument.

A lot of these changes can be seen as being nitpicking (which they are :-)), but I since I was at it, why not do it 100% properly :-)
I've tried to spread these changes in separate commits, so that you can cherry-pick if necessary

Kind regards,

Pano

Checklist

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

Codecov Report

Base: 100.00% // Head: 100.00% // No change to project coverage 👍

Coverage data is based on head (62cbf4a) compared to base (f97e8d4).
Patch has no changes to coverable lines.

Additional details and impacted files

@@            Coverage Diff            @@
##            master     #2107   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          105       105           
  Lines         2335      2335           
  Branches       586       586           
=========================================
  Hits          2335      2335

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

Nice work!

Suggested change

      
            **isAlpha(str [, locale, options])**    | check if the string contains only letters (a-zA-Z).<br/><br/>`Locale` 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', 'bn', 'cs-CZ', 'da-DK', 'de-DE', 'el-GR', 'en-AU', 'en-GB', 'en-HK', 'en-IN', 'en-NZ', 'en-US', 'en-ZA', 'en-ZM', 'es-ES', 'fa-IR', 'fi-FI', 'fr-CA', 'fr-FR', 'he', 'hi-IN', 'hu-HU', 'it-IT', 'ko-KR', 'ja-JP', 'ku-IQ', 'nb-NO', 'nl-NL', 'nn-NO', 'pl-PL', 'pt-BR', 'pt-PT', 'ru-RU', 'si-LK', 'sl-SI', 'sk-SK', 'sr-RS', 'sr-RS@latin', 'sv-SE', 'tr-TR', 'uk-UA']` and defaults to `en-US`. Locale list is `validator.isAlphaLocales`. `options` is an optional object that can be supplied with the following key(s): `ignore` which can either be a String or RegExp of characters to be ignored e.g. " -" will ignore spaces and -'s.
          
            **isAlpha(str [, locale, options])**    | check if the string contains only letters (a-zA-Z).<br/><br/>`locale` 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', 'bn', 'cs-CZ', 'da-DK', 'de-DE', 'el-GR', 'en-AU', 'en-GB', 'en-HK', 'en-IN', 'en-NZ', 'en-US', 'en-ZA', 'en-ZM', 'es-ES', 'fa-IR', 'fi-FI', 'fr-CA', 'fr-FR', 'he', 'hi-IN', 'hu-HU', 'it-IT', 'ko-KR', 'ja-JP', 'ku-IQ', 'nb-NO', 'nl-NL', 'nn-NO', 'pl-PL', 'pt-BR', 'pt-PT', 'ru-RU', 'si-LK', 'sl-SI', 'sk-SK', 'sr-RS', 'sr-RS@latin', 'sv-SE', 'tr-TR', 'uk-UA']` and defaults to `en-US`. Locale list is `validator.isAlphaLocales`. `options` is an optional object that can be supplied with the following key(s): `ignore` which can either be a String or RegExp of characters to be ignored e.g. " -" will ignore spaces and -'s.

If we are referring to the locale parameter, we should use the correctly cased name

good catch, thank you!
will commit in a second

…it as a parameter. in reference to validatorjs#2107 (review)

This looks good, but will cause some merge conflicts with other PRs so be cautious when merging this. @profnandaa

Sure, this is good work in the docs clean-up. Will surely cause some good number of merge conflicts. Let me handle this one as the last one before the next realease.

I can also fix any possible merge conflicts here, if you let me know, when you are done with pulling in "feat" type commits for the upcoming release.

* correctly capitalize Gmail * consistently use email * fix grammatical error

rubiin previously approved these changes Dec 2, 2022

View reviewed changes

braaar suggested changes Dec 5, 2022

View reviewed changes

pano9000 pushed a commit to pano9000/validator.js that referenced this pull request Dec 5, 2022

docs: consistently format and capitalize locale, when referring to …

5610dcd

…it as a parameter. in reference to validatorjs#2107 (review)

pano9000 dismissed rubiin’s stale review via 5610dcd December 5, 2022 13:10

WikiRik previously approved these changes Dec 13, 2022

View reviewed changes

braaar previously approved these changes Dec 13, 2022

View reviewed changes

pano9000 dismissed stale reviews from braaar and WikiRik via 626bcae December 29, 2022 17:29

pano9000 mentioned this pull request Dec 29, 2022

Fix/readme.md #1987

Closed

rubiin requested review from WikiRik and braaar and removed request for braaar December 29, 2022 17:35

WikiRik previously approved these changes Dec 29, 2022

View reviewed changes

rubiin previously approved these changes Dec 30, 2022

View reviewed changes

rubiin added the ✅ LGTM label Jan 23, 2023

profnandaa added the mc-to-land Just merge-conflict standing between the PR and landing. label Jan 28, 2023

Panagiotis Papadopoulos added 10 commits January 29, 2023 00:46

docs: replace in-line links with reference links

b25aae0

docs: add new reference links for a few terms

51cee1c

docs: consistent use of "check if the string"

698416e

docs: fix typo -> locals to locales

0963148

docs: consistently end sentences with a dot

ca48980

docs: consistently wrap "options" with backticks

7eeb1d4

docs: avoid contractions like it's or that's

ce4c299

docs: avoid contractions like it's or that's (missed one)

d8d34f8

docs: fix typo - missing 's' in 'determines'

80296cc

docs: smaller improvements to isEmail

d90bada

* correctly capitalize Gmail * consistently use email * fix grammatical error

snyk-io Bot mentioned this pull request Jun 10, 2024

[Snyk] Upgrade validator from 13.5.2 to 13.12.0 DefenderK/nodejs-goof#76

Closed

florinMiro mentioned this pull request Jun 11, 2024

[Snyk-dev] Upgrade validator from 13.5.2 to 13.12.0 florinMiro/nodejs-goof-renamed#56

Closed

snyk-io Bot mentioned this pull request Jun 11, 2024

[Snyk] Upgrade validator from 13.5.2 to 13.12.0 DefenderK/nodejs-goof#79

Closed

This was referenced Jun 12, 2024

[Snyk] Upgrade validator from 13.5.2 to 13.12.0 DefenderK/nodejs-goof#80

Closed

[Snyk] Upgrade validator from 13.5.2 to 13.12.0 DefenderK/nodejs-goof#84

Closed

snyk-io Bot mentioned this pull request Jun 13, 2024

[Snyk] Upgrade validator from 13.5.2 to 13.12.0 DefenderK/nodejs-goof#85

Closed

DefenderK mentioned this pull request Jun 13, 2024

[Snyk] Upgrade validator from 13.5.2 to 13.12.0 DefenderK/nodejs-goof#86

Closed

This was referenced Jun 14, 2024

[Snyk] Upgrade validator from 13.5.2 to 13.12.0 DefenderK/nodejs-goof#87

Closed

[Snyk] Upgrade validator from 13.5.2 to 13.12.0 DefenderK/nodejs-goof#91

Closed

DefenderK mentioned this pull request Jun 14, 2024

[Snyk] Upgrade validator from 13.5.2 to 13.12.0 DefenderK/nodejs-goof#92

Closed

This was referenced Jun 20, 2024

[Snyk] Upgrade validator from 13.5.2 to 13.12.0 DefenderK/nodejs-goof#95

Closed

[Snyk] Upgrade validator from 13.5.2 to 13.12.0 DefenderK/nodejs-goof#97

Closed

snyk-io Bot mentioned this pull request Jun 28, 2024

[Snyk] Upgrade validator from 13.5.2 to 13.12.0 DefenderK/nodejs-goof#101

Closed

This was referenced Jul 10, 2024

[Snyk] Upgrade validator from 13.5.2 to 13.12.0 DefenderK/nodejs-goof#105

Closed

[Snyk] Upgrade validator from 13.5.2 to 13.12.0 DefenderK/nodejs-goof#109

Closed

[Snyk] Upgrade validator from 13.5.2 to 13.12.0 DefenderK/nodejs-goof#112

Closed

rm-neilsondesa mentioned this pull request Jul 16, 2024

[Snyk] Upgrade validator from 13.7.0 to 13.12.0 rm-neilsondesa/EH-Patch-Todo-App#26

Open

snyk-io Bot mentioned this pull request Jul 18, 2024

[Snyk] Upgrade validator from 13.5.2 to 13.12.0 DefenderK/nodejs-goof#114

Closed

DefenderK mentioned this pull request Jul 18, 2024

[Snyk] Upgrade validator from 13.5.2 to 13.12.0 DefenderK/nodejs-goof#116

Closed

This was referenced Jul 19, 2024

[Snyk] Upgrade validator from 13.5.2 to 13.12.0 DefenderK/nodejs-goof#119

Closed

[Snyk] Upgrade validator from 13.5.2 to 13.12.0 DefenderK/nodejs-goof#121

Closed

[Snyk] Upgrade validator from 13.5.2 to 13.12.0 DefenderK/nodejs-goof#123

Closed

luizhp mentioned this pull request Aug 21, 2024

[Snyk] Upgrade validator from 13.0.0 to 13.12.0 luizhp/template-api-tdd#8

Open

This was referenced Aug 30, 2024

[Snyk] Upgrade validator from 13.7.0 to 13.12.0 TheJ-Erk400/passbolt_browser_extension#11

Open

[Snyk] Upgrade validator from 13.7.0 to 13.12.0 TheJ-Erk400/passbolt_cli2#4

Open

sumandas0 mentioned this pull request Sep 8, 2024

[Snyk] Upgrade: lodash, cassandra-driver, validator sumandas0/Cassandra_node#32

Open

TheJ-Erk400 mentioned this pull request Sep 8, 2024

[Snyk] Upgrade: jssha, validator TheJ-Erk400/passbolt_cli2#6

Open

KOTTAGENVH mentioned this pull request Sep 27, 2024

[Snyk] Upgrade validator from 13.7.0 to 13.12.0 anjana-madushan/E-COMMERCE-WEB-APP-ITP-PROJ-#11

Open

DefenderK mentioned this pull request Oct 30, 2024

[Snyk] Upgrade validator from 13.5.2 to 13.12.0 DefenderK/nodejs-goof#132

Closed

fossabot Bot mentioned this pull request Oct 28, 2025

Bump validator from 13.7.0 to 13.15.20 in /ui UchihaCortez/conductor#6

Closed

-              **isAlpha(str [, locale, options])**    | check if the string contains only letters (a-zA-Z).<br/><br/>Locale 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', 'bn', 'cs-CZ', 'da-DK', 'de-DE', 'el-GR', 'en-AU', 'en-GB', 'en-HK', 'en-IN', 'en-NZ', 'en-US', 'en-ZA', 'en-ZM', 'es-ES', 'fa-IR', 'fi-FI', 'fr-CA', 'fr-FR', 'he', 'hi-IN', 'hu-HU', 'it-IT', 'ko-KR', 'ja-JP', 'ku-IQ', 'nb-NO', 'nl-NL', 'nn-NO', 'pl-PL', 'pt-BR', 'pt-PT', 'ru-RU', 'si-LK', 'sl-SI', 'sk-SK', 'sr-RS', 'sr-RS@latin', 'sv-SE', 'tr-TR', 'uk-UA']`) and defaults to `en-US`. Locale list is `validator.isAlphaLocales`. options is an optional object that can be supplied with the following key(s): ignore which can either be a String or RegExp of characters to be ignored e.g. " -" will ignore spaces and -'s.
-              **isAlphanumeric(str [, locale, options])**      | check if the string contains only letters and numbers (a-zA-Z0-9).<br/><br/>Locale 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', 'bn', 'bg-BG', 'cs-CZ', 'da-DK', 'de-DE', 'el-GR', 'en-AU', 'en-GB', 'en-HK', 'en-IN', 'en-NZ', 'en-US', 'en-ZA', 'en-ZM', 'es-ES', 'fa-IR', 'fi-FI', 'fr-CA', 'fr-FR', 'he', 'hi-IN', 'hu-HU', 'it-IT', 'ko-KR', 'ja-JP','ku-IQ', 'nb-NO', 'nl-NL', 'nn-NO', 'pl-PL', 'pt-BR', 'pt-PT', 'ru-RU', 'si-LK', 'sl-SI', 'sk-SK', 'sr-RS', 'sr-RS@latin', 'sv-SE', 'tr-TR', 'uk-UA']`) and defaults to `en-US`. Locale list is `validator.isAlphanumericLocales`. options is an optional object that can be supplied with the following key(s): ignore which can either be a String or RegExp of characters to be ignored e.g. " -" will ignore spaces and -'s.
+              **isAfter(str [, date])**               | check if the string is a date that is after the specified date (defaults to now).
+              **isAlpha(str [, locale, options])**    | check if the string contains only letters (a-zA-Z).<br/><br/>`Locale` 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', 'bn', 'cs-CZ', 'da-DK', 'de-DE', 'el-GR', 'en-AU', 'en-GB', 'en-HK', 'en-IN', 'en-NZ', 'en-US', 'en-ZA', 'en-ZM', 'es-ES', 'fa-IR', 'fi-FI', 'fr-CA', 'fr-FR', 'he', 'hi-IN', 'hu-HU', 'it-IT', 'ko-KR', 'ja-JP', 'ku-IQ', 'nb-NO', 'nl-NL', 'nn-NO', 'pl-PL', 'pt-BR', 'pt-PT', 'ru-RU', 'si-LK', 'sl-SI', 'sk-SK', 'sr-RS', 'sr-RS@latin', 'sv-SE', 'tr-TR', 'uk-UA']` and defaults to `en-US`. Locale list is `validator.isAlphaLocales`. `options` is an optional object that can be supplied with the following key(s): `ignore` which can either be a String or RegExp of characters to be ignored e.g. " -" will ignore spaces and -'s.

docs: Improve consistency and fix errors in README.md by pano9000 · Pull Request #2107 · validatorjs/validator.js · GitHub

Uh oh!

Uh oh!

docs: Improve consistency and fix errors in README.md - #2107

docs: Improve consistency and fix errors in README.md#2107
profnandaa merged 37 commits into
validatorjs:masterfrom
pano9000:master

pano9000 commented Dec 1, 2022

Uh oh!

codecov Bot commented Dec 1, 2022 •
edited
Loading

Uh oh!

Uh oh!

WikiRik commented Dec 1, 2022

Uh oh!

braaar Dec 5, 2022

Uh oh!

pano9000 Dec 5, 2022

Uh oh!

WikiRik left a comment

Uh oh!

profnandaa commented Jan 19, 2023

Uh oh!

pano9000 commented Jan 20, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

docs: Improve consistency and fix errors in README.md by pano9000 · Pull Request #2107 · validatorjs/validator.js · GitHub

Uh oh!

Uh oh!

docs: Improve consistency and fix errors in README.md - #2107

docs: Improve consistency and fix errors in README.md#2107profnandaa merged 37 commits intovalidatorjs:mastervalidatorjs/validator.js:masterfrom pano9000:masterpano9000/validator.js:masterCopy head branch name to clipboard

Conversation

pano9000 commented Dec 1, 2022

Checklist

Uh oh!

codecov Bot commented Dec 1, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

WikiRik commented Dec 1, 2022

Uh oh!

braaar Dec 5, 2022

Choose a reason for hiding this comment

Uh oh!

pano9000 Dec 5, 2022

Choose a reason for hiding this comment

Uh oh!

WikiRik left a comment

Choose a reason for hiding this comment

Uh oh!

profnandaa commented Jan 19, 2023

Uh oh!

pano9000 commented Jan 20, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

docs: Improve consistency and fix errors in README.md#2107
profnandaa merged 37 commits into
validatorjs:masterfrom
pano9000:master

codecov Bot commented Dec 1, 2022 •
edited
Loading