feat!: support tree-shaking (#152)

build/gulp-tasks/browser.js

@@ -6,30 +6,29 @@
 */
 
 const browserify = require('browserify');
-const source  = require('vinyl-source-stream');
+const source = require('vinyl-source-stream');
 const buffer = require('vinyl-buffer');
 const uglify = require('gulp-uglify');
 const rename = require('gulp-rename');
 const { src, dest } = require('gulp');
 
 const files = {
-  jsMain: './index.js',
-  jsOutput: 'faker.js'
-}
+  jsMain: './lib/index.js',
+  jsOutput: 'faker.js',
+};
 
-module.exports = function browser () {
+module.exports = function browser() {
   return browserify(files.jsMain, {
     standalone: 'faker',
-    debug: true
+    debug: true,
   })
-  .bundle()
-  .pipe(source(files.jsOutput))
-  .pipe(buffer())
-  .pipe(dest("examples/browser/js"))
-  .pipe(dest('dist/'))
-  .pipe(rename({ extname: ".min.js" }))
-  .pipe(uglify())
-  .pipe(dest("examples/browser/js"))
-  .pipe(dest('dist/'));
+    .bundle()
+    .pipe(source(files.jsOutput))
+    .pipe(buffer())
+    .pipe(dest('examples/browser/js'))
+    .pipe(dest('dist/'))
+    .pipe(rename({ extname: '.min.js' }))
+    .pipe(uglify())
+    .pipe(dest('examples/browser/js'))
+    .pipe(dest('dist/'));
 };
-

examples/node/generateMultiLevelMultiLocaleJSON.js

@@ -1,31 +1,39 @@
-// This example shows the generation of a multilevel object and JSON document using various faker.js features
-// including name, address, company, date and commerce namespaces, moustache expressions and random element production
-// Using the helper function arr, randomly sized collections of elements are produced in the document.
-
-var faker = require('../../index');
-var fs = require('fs');
-// produce array with random number of empty elements 
-const arr = (maxNumberOfElements) => new Array(faker.datatype.number({min: 1, max: maxNumberOfElements})).fill()
-
-const locales = ["nl","es","de","fr","en_AU"]
-const company = 
-  { "name"        : faker.company.companyName()
-  , "country"     : faker.address.country()
-  , "departments" : arr(8).map(() =>  { faker.locale = faker.random.arrayElement(locales)
-                                        return { "name"     : faker.commerce.department()
-                                               , "location" : faker.fake("{{address.city}} ({{address.country}})")
-                                               , "employees": arr(20).map(() => {
-                                                                 return { "name"     : faker.fake("{{name.firstName}} {{name.lastName}}")
-                                                                        , "job"      : faker.name.jobTitle()
-                                                                        , "hiredate" : faker.date.past(12).toISOString().split('T')[0]
-                                                                        , "salary"   : faker.datatype.number(700, 9000)
-                                                                        }
-                                                               })
-                                               }
-                                     })
-  }                                        
-
-  console.log(JSON.stringify(company))
-  fs.writeFile(__dirname + '/companyDataSet.json',  JSON.stringify(company), function() {
-    console.log("dataSet generated successfully!");
-  });
+// This example shows the generation of a multilevel object and JSON document using various faker.js features
+// including name, address, company, date and commerce namespaces, moustache expressions and random element production
+// Using the helper function arr, randomly sized collections of elements are produced in the document.
+
+var faker = require('../../lib').faker;
+var fs = require('fs');
+// produce array with random number of empty elements
+const arr = (maxNumberOfElements) =>
+  new Array(faker.datatype.number({ min: 1, max: maxNumberOfElements })).fill();
+
+const locales = ['nl', 'es', 'de', 'fr', 'en_AU'];
+const company = {
+  name: faker.company.companyName(),
+  country: faker.address.country(),
+  departments: arr(8).map(() => {
+    faker.locale = faker.random.arrayElement(locales);
+    return {
+      name: faker.commerce.department(),
+      location: faker.fake('{{address.city}} ({{address.country}})'),
+      employees: arr(20).map(() => {
+        return {
+          name: faker.fake('{{name.firstName}} {{name.lastName}}'),
+          job: faker.name.jobTitle(),
+          hiredate: faker.date.past(12).toISOString().split('T')[0],
+          salary: faker.datatype.number(700, 9000),
+        };
+      }),
+    };
+  }),
+};
+
+console.log(JSON.stringify(company));
+fs.writeFile(
+  __dirname + '/companyDataSet.json',
+  JSON.stringify(company),
+  function () {
+    console.log('dataSet generated successfully!');
+  }
+);

examples/node/generateSet.js

@@ -1,19 +1,26 @@
 var fs = require('fs');
 
-var faker = require('../../index');
-
+var faker = require('../../lib').faker;
 
 // generate dataSet as example
-fs.writeFile(__dirname + '/dataSet.json',  JSON.stringify(faker.helpers.userCard()), function() {
-  console.log("dataSet generated successfully!");
-});
+fs.writeFile(
+  __dirname + '/dataSet.json',
+  JSON.stringify(faker.helpers.userCard()),
+  function () {
+    console.log('dataSet generated successfully!');
+  }
+);
 // generate bigDataSet as example
 var bigSet = [];
 
-for(var i = 20; i >= 0; i--){
+for (var i = 20; i >= 0; i--) {
   bigSet.push(faker.helpers.userCard());
-};
+}
 
-fs.writeFile(__dirname + '/bigDataSet.json',  JSON.stringify(bigSet), function() {
-  console.log("bigDataSet generated successfully!");
-});
+fs.writeFile(
+  __dirname + '/bigDataSet.json',
+  JSON.stringify(bigSet),
+  function () {
+    console.log('bigDataSet generated successfully!');
+  }
+);

examples/node/generators.js

@@ -1,14 +1,11 @@
-var faker = require('../../index');
+var faker = require('../../lib').faker;
 
-faker.locale = "en";
+faker.locale = 'en';
 
 console.log(faker.fake('{{random.uuid}}, {{name.firstName}} {{name.suffix}}'));
 
-
 return;
 
-
 console.log(faker.fake('{{finance.currencyName}} - {{finance.amount}}'));
 
-
-console.log(faker.fake('{{name.firstName}} {{name.lastName}}'));
+console.log(faker.fake('{{name.firstName}} {{name.lastName}}'));

examples/node/minimal-usage.js

@@ -1,17 +1,17 @@
 #!/usr/bin/env node
 
-var faker = require('../../index');
-faker.locale = "fi";
+var faker = require('../../lib').faker;
+faker.locale = 'fi';
 
 //console.log(faker.lorem.sentences())
 
-console.log(faker.name.findName())
+console.log(faker.name.findName());
 return;
 //console.log(faker.address)
-console.log(faker.internet.email())
-console.log(faker.date.recent())
+console.log(faker.internet.email());
+console.log(faker.date.recent());
 console.log(faker.helpers.contextualCard());
 
-faker.locale = "uk";
+faker.locale = 'uk';
 
-console.log(faker.helpers.contextualCard());
+console.log(faker.helpers.contextualCard());

examples/node/unique-values.js

@@ -1,19 +1,18 @@
-var faker = require('../../index');
+var faker = require('../../lib').faker;
 
 var emails = {};
 var conflicts = 0;
 // emails estimated: 1,055,881
 // full names estimated: 1,185,139
 for (var i = 0; i < 100000; i++) {
-
   // call function with no arguments
   var email = faker.unique(faker.internet.email);
 
   // or with function arguments as argument array
-    // var email = faker.unique(faker.internet.email, [null, null, 'marak.com']);
+  // var email = faker.unique(faker.internet.email, [null, null, 'marak.com']);
 
   // or with custom options for maxTime as milliseconds or maxRetries
-    // var email = faker.unique(faker.internet.email, [null, null, 'marak.com'], { maxRetries: 1, maxTime: 50 });
+  // var email = faker.unique(faker.internet.email, [null, null, 'marak.com'], { maxRetries: 1, maxTime: 50 });
 
   if (typeof emails[email] === 'undefined') {
     // found a unique new item
@@ -26,4 +25,4 @@ for (var i = 0; i < 100000; i++) {
 console.log('total conflicts', conflicts); // should be zero using faker.unique()
 console.log('total uniques generated', Object.keys(emails).length);
 
-// console.log(emails);
+// console.log(emails);

package.json

@@ -22,7 +22,7 @@
     "url": "https://github.com/faker-js/faker.git"
   },
   "license": "MIT",
-  "main": "index.js",
+  "main": "lib/index.js",
   "scripts": {
     "browser": "gulp browser",
     "build": "tsc",

src/index.ts

@@ -271,5 +271,9 @@ export class Faker {
   }
 }
 
-export default Faker;
-module.exports = Faker;
+// since we are requiring the top level of faker, load all locales by default
+export const faker: Faker = new Faker({
+  locales: require('./locales'),
+});
+
+export default faker;

test/address.unit.js

@@ -1,7 +1,7 @@
 if (typeof module !== 'undefined') {
   var assert = require('assert');
   var sinon = require('sinon');
-  var faker = require('../index');
+  var faker = require('../lib').faker;
 }
 
 describe('address.js', function () {

test/all.functional.js

@@ -1,7 +1,7 @@
 if (typeof module !== 'undefined') {
   var assert = require('assert');
   var sinon = require('sinon');
-  var faker = require('../index');
+  var faker = require('../lib').faker;
 }
 
 var functionalHelpers = require('./support/function-helpers.js');

test/animal.unit.js

@@ -1,7 +1,7 @@
 if (typeof module !== 'undefined') {
   var assert = require('assert');
   var sinon = require('sinon');
-  var faker = require('../index');
+  var faker = require('../lib').faker;
 }
 
 describe('animal.js', function () {

test/commerce.unit.js

@@ -1,7 +1,7 @@
 if (typeof module !== 'undefined') {
-  var assert = require('assert'),
-    sinon = require('sinon'),
-    faker = require('../index');
+  var assert = require('assert');
+  var sinon = require('sinon');
+  var faker = require('../lib').faker;
 }
 
 describe('commerce.js', function () {

test/company.unit.js

@@ -1,7 +1,7 @@
 if (typeof module !== 'undefined') {
   var assert = require('assert');
   var sinon = require('sinon');
-  var faker = require('../index');
+  var faker = require('../lib').faker;
 }
 
 describe('company.js', function () {

test/database.unit.js

@@ -1,7 +1,7 @@
 if (typeof module !== 'undefined') {
   var assert = require('assert');
   var sinon = require('sinon');
-  var faker = require('../index');
+  var faker = require('../lib').faker;
 }
 
 describe('database.js', function () {

test/datatype.unit.js

@@ -2,7 +2,7 @@ if (typeof module !== 'undefined') {
   var assert = require('assert');
   var sinon = require('sinon');
   var _ = require('lodash');
-  var faker = require('../index');
+  var faker = require('../lib').faker;
   var mersenne = require('../vendor/mersenne');
 }
 

test/date.unit.js

@@ -1,7 +1,7 @@
 if (typeof module !== 'undefined') {
   var assert = require('assert');
   var sinon = require('sinon');
-  var faker = require('../index');
+  var faker = require('../lib').faker;
 }
 
 describe('date.js', function () {

test/fake.unit.js

@@ -1,7 +1,7 @@
 if (typeof module !== 'undefined') {
   var assert = require('assert');
   var sinon = require('sinon');
-  var faker = require('../index');
+  var faker = require('../lib').faker;
 }
 
 describe('fake.js', function () {

test/finance.unit.js

@@ -1,7 +1,7 @@
 if (typeof module !== 'undefined') {
   var assert = require('assert');
   var sinon = require('sinon');
-  var faker = require('../index');
+  var faker = require('../lib').faker;
 }
 
 faker.seed(1234);

test/finance_iban.unit.js

@@ -1,6 +1,6 @@
 if (typeof module !== 'undefined') {
   var assert = require('assert');
-  var faker = require('../index');
+  var faker = require('../lib').faker;
 }
 
 function getAnIbanByCountry(countryCode) {

test/git.unit.js

@@ -1,7 +1,7 @@
 if (typeof module !== 'undefined') {
   var assert = require('assert');
   var sinon = require('sinon');
-  var faker = require('../index');
+  var faker = require('../lib').faker;
 }
 
 describe('git.js', function () {

test/helpers.unit.js

@@ -1,7 +1,7 @@
 if (typeof module !== 'undefined') {
   var assert = require('assert');
   var sinon = require('sinon');
-  var faker = require('../index');
+  var faker = require('../lib').faker;
 }
 
 describe('helpers.js', function () {

test/image.unit.js

@@ -1,7 +1,7 @@
 if (typeof module !== 'undefined') {
   var assert = require('assert');
   var sinon = require('sinon');
-  var faker = require('../index');
+  var faker = require('../lib').faker;
 }
 
 describe('image.js', function () {