Migrate to ES6

[forabi]

This is a large PR with some opinionated changes, so I'm not sure if it would be accepted, but I'd try anyway :)

• Deprecate non-string coercion (major version upgrade): it is difficult to implement this functionality when each function is used separately.
• Rewrite validation functions as ES6 modules, so we can now require each function separately without having to include the whole library, this will be helpful to anyone using validator on the client side, and will make it possible in the future to use tree shaking (i.e. removing unused code) when Node supports ES6 modules.

Functions are available on the root folder for convenience Functions are available in the lib/ dir:

// ES5
var isEmail = require('validator/lib/isEmail');

// ES6
import isEmail from 'validator/lib/isEmail';

// ES6 with tree shaking
import { isEmail } from 'validator';

Of course you can still include the entire library as usual:

var validator = require('validator');
validator.isEmail('[email protected]'); // => true

Now to the opinionated changes:

• Move to ESLint: it is extensible, has better support for ES6 and has awesome integration extensions for popular code editors.

• Use npm scripts to build, clean and test the package as they are more compatible with non-*nix platforms and easier to use.

  npm run clean # removes all builds
  npm run clean:browser
  npm run clean:node
  npm run build
  npm run build:browser
  npm run build:node
  npm run lint # runs ESLint
  npm run test

[chriso]

Thanks for the PR! ✨ This will obviously take some time to review but I'm liking everything so far.

I'm happy to move from jshint to eslint, and also happy to drop the makefile in favour of npm scripts.

Dropping coercion of non-string input is already planned for v5, although I'd like for the deprecation notice to be out there in the wild for a bit longer, as there are undoubtedly projects and libraries that depend on the latest version of the library rather than ^4

[forabi]

Great!
I've added a new function assertString that is called by every validation function and currently throws an error if the input is not a string, toString is still available but it should be called manually. We could print the deprecation notice in assertString and throw the error, or even restore the coercion behavior by simply calling toString inside assertString.

[forabi]

Just wanted to point out that accessing individual functions using validator/<functionName> is not currently implemented, instead one has to use validator/lib/<functionName>. I'm trying to figure out the best way to do it without polluting the root dir with too many files. We may need to add tests for these files too.

[tunnckoCore]

I'm trying to figure out the best way to do it without polluting the root dir with too many files

Try export-files, set just one index.js in lib :)

[chriso]

The point of the deprecation notice was that it still coerced input but warned when it did so, giving you time to update your code. Printing a deprecation notice and then throwing an error defeats the purpose.

I'm happy for you to drop the deprecation notice entirely. Once this PR Is merged I'll tag and publish v5.

[chriso]

The Makefile no longer exists.

[forabi]

@chriso Tests are linted now. I've also added:

• isMobilePhone validation for ar-SY (Arabic (Syria))
• isAlpha and isAlphanumeric validation for various Arabic locales.

[forabi]

@chriso upgraded to ESLint 2 👍

[chriso]

👍 we'll need to merge in the changes from master in the past week and then I'll look at merging this PR.

[forabi]

Do you want me to do that?

[chriso]

If you don't mind. It won't let me merge otherwise.

[forabi]

@chriso Done!

[chriso]

Apart from the README changes, this is ready to merge ✨

[chriso]

v5 will land shortly.

[forabi]

Awesome! 😄
Thank you!

[chriso]

5.0.0 has been published. Thanks for the PR!

[ldong]

I dont understand why it does not work for Ember by default? Something like:

import validator from 'bower_components/validator-js';

I had to do this

bower install validator-js --save-dev

Then inside ember-cli-build.js, add this line of code app.import('bower_components/validator-js/validator.js');

@chriso Thanks for the help.