diff options
| -rw-r--r-- | Readme.md | 600 | ||||
| -rw-r--r-- | build/gulp-tasks/readme.js | 46 | ||||
| -rw-r--r-- | build/src/docs.md | 262 | ||||
| -rw-r--r-- | gulpfile.js | 3 | ||||
| -rw-r--r-- | package.json | 4 |
5 files changed, 298 insertions, 617 deletions
@@ -10,39 +10,40 @@ [](#sponsors) [](https://gitter.im/Faker-js/community) -## Demo +## FAQ - What happened to the original faker.js? -[https://rawgit.com/Marak/faker.js/master/examples/browser/index.html](https://rawgit.com/Marak/faker.js/master/examples/browser/index.html) +This project was originally created and hosted at https://github.com/marak/Faker.js/ - however around 4th Jan, 2022 - the author decided to delete the repository (for unknown reasons). -### Faker Cloud +In the interest of the community, it has been decided that faker.js will continue to be maintained here and all help in its development will be appreciated. -Don't have a local development setup ready? +## Demo -Try our hosted version of Faker at [https://fakercloud.com/api](https://fakercloud.com/api) +Coming soon! -https://github.com/faker/faker-cloud +### Faker Cloud + +Coming Soon ! ## Usage ### Browser ```html - <script src = "faker.js" type = "text/javascript"></script> - <script> - var randomName = faker.name.findName(); // Caitlyn Kerluke - var randomEmail = faker.internet.email(); // [email protected] - var randomCard = faker.helpers.createCard(); // random contact card containing many properties - </script> +<script src="faker.js" type="text/javascript"></script> +<script> + var randomName = faker.name.findName(); // Caitlyn Kerluke + var randomEmail = faker.internet.email(); // [email protected] + var randomCard = faker.helpers.createCard(); // random contact card containing many properties +</script> ``` ### Node.js ```js - var faker = require('faker'); - - var randomName = faker.name.findName(); // Rowan Nikolaus - var randomEmail = faker.internet.email(); // [email protected] - var randomCard = faker.helpers.createCard(); // random contact card containing many properties +var faker = require("faker"); +var randomName = faker.name.findName(); // Rowan Nikolaus +var randomEmail = faker.internet.email(); // [email protected] +var randomCard = faker.helpers.createCard(); // random contact card containing many properties ``` ## API @@ -53,232 +54,232 @@ https://github.com/faker/faker-cloud ### API Methods -* address - * zipCode - * zipCodeByState - * city - * cityPrefix - * citySuffix - * cityName - * streetName - * streetAddress - * streetSuffix - * streetPrefix - * secondaryAddress - * county - * country - * countryCode - * state - * stateAbbr - * latitude - * longitude - * direction - * cardinalDirection - * ordinalDirection - * nearbyGPSCoordinate - * timeZone -* animal - * dog - * cat - * snake - * bear - * lion - * cetacean - * horse - * bird - * cow - * fish - * crocodilia - * insect - * rabbit - * type -* commerce - * color - * department - * productName - * price - * productAdjective - * productMaterial - * product - * productDescription -* company - * suffixes - * companyName - * companySuffix - * catchPhrase - * bs - * catchPhraseAdjective - * catchPhraseDescriptor - * catchPhraseNoun - * bsAdjective - * bsBuzz - * bsNoun -* database - * column - * type - * collation - * engine -* datatype - * number - * float - * datetime - * string - * uuid - * boolean - * hexaDecimal - * json - * array -* date - * past - * future - * between - * betweens - * recent - * soon - * month - * weekday -* fake -* finance - * account - * accountName - * routingNumber - * mask - * amount - * transactionType - * currencyCode - * currencyName - * currencySymbol - * bitcoinAddress - * litecoinAddress - * creditCardNumber - * creditCardCVV - * ethereumAddress - * iban - * bic - * transactionDescription -* git - * branch - * commitEntry - * commitMessage - * commitSha - * shortSha -* hacker - * abbreviation - * adjective - * noun - * verb - * ingverb - * phrase -* helpers - * randomize - * slugify - * replaceSymbolWithNumber - * replaceSymbols - * replaceCreditCardSymbols - * repeatString - * regexpStyleStringParse - * shuffle - * mustache - * createCard - * contextualCard - * userCard - * createTransaction -* image - * image - * avatar - * imageUrl - * abstract - * animals - * business - * cats - * city - * food - * nightlife - * fashion - * people - * nature - * sports - * technics - * transport - * dataUri - * lorempixel - * unsplash - * lorempicsum -* internet - * avatar - * email - * exampleEmail - * userName - * protocol - * httpMethod - * url - * domainName - * domainSuffix - * domainWord - * ip - * ipv6 - * port - * userAgent - * color - * mac - * password -* lorem - * word - * words - * sentence - * slug - * sentences - * paragraph - * paragraphs - * text - * lines -* mersenne - * rand - * seed - * seed_array -* music - * genre -* name - * firstName - * lastName - * middleName - * findName - * jobTitle - * gender - * prefix - * suffix - * title - * jobDescriptor - * jobArea - * jobType -* phone - * phoneNumber - * phoneNumberFormat - * phoneFormats -* system - * fileName - * commonFileName - * mimeType - * commonFileType - * commonFileExt - * fileType - * fileExt - * directoryPath - * filePath - * semver -* time - * recent -* unique -* vehicle - * vehicle - * manufacturer - * model - * type - * fuel - * vin - * color - * vrm - * bicycle +- address + - zipCode + - zipCodeByState + - city + - cityPrefix + - citySuffix + - cityName + - streetName + - streetAddress + - streetSuffix + - streetPrefix + - secondaryAddress + - county + - country + - countryCode + - state + - stateAbbr + - latitude + - longitude + - direction + - cardinalDirection + - ordinalDirection + - nearbyGPSCoordinate + - timeZone +- animal + - dog + - cat + - snake + - bear + - lion + - cetacean + - horse + - bird + - cow + - fish + - crocodilia + - insect + - rabbit + - type +- commerce + - color + - department + - productName + - price + - productAdjective + - productMaterial + - product + - productDescription +- company + - suffixes + - companyName + - companySuffix + - catchPhrase + - bs + - catchPhraseAdjective + - catchPhraseDescriptor + - catchPhraseNoun + - bsAdjective + - bsBuzz + - bsNoun +- database + - column + - type + - collation + - engine +- datatype + - number + - float + - datetime + - string + - uuid + - boolean + - hexaDecimal + - json + - array +- date + - past + - future + - between + - betweens + - recent + - soon + - month + - weekday +- fake +- finance + - account + - accountName + - routingNumber + - mask + - amount + - transactionType + - currencyCode + - currencyName + - currencySymbol + - bitcoinAddress + - litecoinAddress + - creditCardNumber + - creditCardCVV + - ethereumAddress + - iban + - bic + - transactionDescription +- git + - branch + - commitEntry + - commitMessage + - commitSha + - shortSha +- hacker + - abbreviation + - adjective + - noun + - verb + - ingverb + - phrase +- helpers + - randomize + - slugify + - replaceSymbolWithNumber + - replaceSymbols + - replaceCreditCardSymbols + - repeatString + - regexpStyleStringParse + - shuffle + - mustache + - createCard + - contextualCard + - userCard + - createTransaction +- image + - image + - avatar + - imageUrl + - abstract + - animals + - business + - cats + - city + - food + - nightlife + - fashion + - people + - nature + - sports + - technics + - transport + - dataUri + - lorempixel + - unsplash + - lorempicsum +- internet + - avatar + - email + - exampleEmail + - userName + - protocol + - httpMethod + - url + - domainName + - domainSuffix + - domainWord + - ip + - ipv6 + - port + - userAgent + - color + - mac + - password +- lorem + - word + - words + - sentence + - slug + - sentences + - paragraph + - paragraphs + - text + - lines +- mersenne + - rand + - seed + - seed_array +- music + - genre +- name + - firstName + - lastName + - middleName + - findName + - jobTitle + - gender + - prefix + - suffix + - title + - jobDescriptor + - jobArea + - jobType +- phone + - phoneNumber + - phoneNumberFormat + - phoneFormats +- system + - fileName + - commonFileName + - mimeType + - commonFileType + - commonFileExt + - fileType + - fileExt + - directoryPath + - filePath + - semver +- time + - recent +- unique +- vehicle + - vehicle + - manufacturer + - model + - type + - fuel + - vin + - color + - vrm + - bicycle ### Faker.fake() @@ -287,13 +288,12 @@ faker.js contains a super useful generator method `Faker.fake` for combining fak **Example:** - -``` js -console.log(faker.fake("{{name.lastName}}, {{name.firstName}} {{name.suffix}}")); -// outputs: "Marks, Dean Sr." +```js +console.log( + faker.fake("{{name.lastName}}, {{name.firstName}} {{name.suffix}}") +); ``` - This will interpolate the format string with the value of methods `name.lastName()`, `name.firstName()`, and `name.suffix()` ## Localization @@ -309,65 +309,65 @@ Setting a new locale is simple: faker.locale = "de"; ``` - * az - * ar - * cz - * de - * de_AT - * de_CH - * en - * en_AU - * en_AU_ocker - * en_BORK - * en_CA - * en_GB - * en_IE - * en_IND - * en_US - * en_ZA - * es - * es_MX - * fa - * fi - * fr - * fr_CA - * fr_CH - * ge - * hy - * hr - * id_ID - * it - * ja - * ko - * nb_NO - * ne - * nl - * nl_BE - * pl - * pt_BR - * pt_PT - * ro - * ru - * sk - * sv - * tr - * uk - * vi - * zh_CN - * zh_TW + - az + - ar + - cz + - de + - de_AT + - de_CH + - en + - en_AU + - en_AU_ocker + - en_BORK + - en_CA + - en_GB + - en_IE + - en_IND + - en_US + - en_ZA + - es + - es_MX + - fa + - fi + - fr + - fr_CA + - fr_CH + - ge + - hy + - hr + - id_ID + - it + - ja + - ko + - nb_NO + - ne + - nl + - nl_BE + - pl + - pt_BR + - pt_PT + - ro + - ru + - sk + - sv + - tr + - uk + - vi + - zh_CN + - zh_TW ### Individual Localization Packages faker.js supports incremental loading of locales. -By default, requiring `faker` will include *all* locale data. +By default, requiring `faker` will include _all_ locale data. In a production environment, you may only want to include the locale data for a specific set of locales. ```js // loads only de locale -var faker = require('faker/locale/de'); +var faker = require("faker/locale/de"); ``` ## Setting a randomness seed @@ -414,14 +414,6 @@ npm run browser npm run jsdoc ``` -### Building ReadMe - -The `ReadMe.md` file for `faker.js` is automatically generated and should not be modified directly. All updates to `ReadMe.md` should be performed in `./build/src/docs.md` and then the build script should be run. - -```shell -npm run readme -``` - ## Version Release Schedule faker.js is a popular project used by many organizations and individuals in production settings. Major and Minor version releases are generally on a monthly schedule. Bugs fixes are addressed by severity and fixed as soon as possible. diff --git a/build/gulp-tasks/readme.js b/build/gulp-tasks/readme.js deleted file mode 100644 index 199acde1..00000000 --- a/build/gulp-tasks/readme.js +++ /dev/null @@ -1,46 +0,0 @@ -/* - - this task will generate the Readme.md file found in the project root - -*/ - -const { src, dest } = require('gulp'); -const mustache = require('gulp-mustache'); -const rename = require('gulp-rename'); - -module.exports = function readme (cb) { - var API = '', LOCALES = ''; - var faker = require('../../index'); - - // generate locale list - for (var locale in faker.locales) { - LOCALES += ' * ' + locale + '\n'; - } - - var keys = Object.keys(faker); - keys = keys.sort(); - - // generate nice tree of api for docs - keys.forEach(function(module){ - // ignore certain properties - var ignore = ['locale', 'localeFallback', 'definitions', 'locales']; - if (ignore.indexOf(module) !== -1) { - return; - } - API += '* ' + module + '\n'; - for (var method in faker[module]) { - API += ' * ' + method + '\n'; - } - }); - - return src('build/src/docs.md') - .pipe(mustache({ - 'API': API, - 'LOCALES': LOCALES, - 'startYear': 2010, - 'currentYear': new Date().getFullYear() - })) - .pipe(rename("../Readme.md")) - .pipe(dest('build/')); - -};
\ No newline at end of file diff --git a/build/src/docs.md b/build/src/docs.md deleted file mode 100644 index d04d567e..00000000 --- a/build/src/docs.md +++ /dev/null @@ -1,262 +0,0 @@ -# faker.js - generate massive amounts of fake data in the browser and node.js - - - -[](https://travis-ci.org/Marak/faker.js) [](https://coveralls.io/github/Marak/faker.js?branch=master) - -[](http://badge.fury.io/js/faker) - -[](#backers) -[](#sponsors) -[](https://gitter.im/Faker-js/community) - -## Demo - -[https://rawgit.com/Marak/faker.js/master/examples/browser/index.html](https://rawgit.com/Marak/faker.js/master/examples/browser/index.html) - -### Faker Cloud - -Don't have a local development setup ready? - -Try our hosted version of Faker at [https://fakercloud.com/api](https://fakercloud.com/api) - -https://github.com/faker/faker-cloud - -## Usage - -### Browser - -```html - <script src = "faker.js" type = "text/javascript"></script> - <script> - var randomName = faker.name.findName(); // Caitlyn Kerluke - var randomEmail = faker.internet.email(); // [email protected] - var randomCard = faker.helpers.createCard(); // random contact card containing many properties - </script> -``` - -### Node.js - -```js - var faker = require('faker'); - - var randomName = faker.name.findName(); // Rowan Nikolaus - var randomEmail = faker.internet.email(); // [email protected] - var randomCard = faker.helpers.createCard(); // random contact card containing many properties -``` - -## API - -### JSDoc API Browser - -[http://marak.github.io/faker.js/](http://marak.github.io/faker.js/) - -### API Methods - -{{{API}}} - -### Faker.fake() - -faker.js contains a super useful generator method `Faker.fake` for combining faker API methods using a mustache string format. - -**Example:** - -{{=<% %>=}} - -``` js -console.log(faker.fake("{{name.lastName}}, {{name.firstName}} {{name.suffix}}")); -// outputs: "Marks, Dean Sr." -``` - -<%={{ }}=%> - -This will interpolate the format string with the value of methods `name.lastName()`, `name.firstName()`, and `name.suffix()` - -## Localization - -As of version `v2.0.0` faker.js has support for multiple localities. - -The default language locale is set to English. - -Setting a new locale is simple: - -```js -// sets locale to de -faker.locale = "de"; -``` - -{{LOCALES}} - -### Individual Localization Packages - -faker.js supports incremental loading of locales. - -By default, requiring `faker` will include *all* locale data. - -In a production environment, you may only want to include the locale data for a specific set of locales. - -```js -// loads only de locale -var faker = require('faker/locale/de'); -``` - -## Setting a randomness seed - -If you want consistent results, you can set your own seed: - -```js -faker.seed(123); - -var firstRandom = faker.datatype.number(); - -// Setting the seed again resets the sequence. -faker.seed(123); - -var secondRandom = faker.datatype.number(); - -console.log(firstRandom === secondRandom); -``` - -## Tests - -```shell -npm install . -make test -``` - -You can view a code coverage report generated in coverage/lcov-report/index.html. - -## Building faker.js - -faker uses [gulp](http://gulpjs.com/) to automate its build process. Each build operation is a separate task which can be run independently. - -### Browser Bundle - -```shell -npm run browser -``` - -### Building JSDocs - -[JSDOC](https://jsdoc.app/) v3 HTML API documentation - -```shell -npm run jsdoc -``` - -### Building ReadMe - -The `ReadMe.md` file for `faker.js` is automatically generated and should not be modified directly. All updates to `ReadMe.md` should be performed in `./build/src/docs.md` and then the build script should be run. - -```shell -npm run readme -``` - -## Version Release Schedule - -faker.js is a popular project used by many organizations and individuals in production settings. Major and Minor version releases are generally on a monthly schedule. Bugs fixes are addressed by severity and fixed as soon as possible. - -If you require the absolute latest version of `faker.js` the `master` branch @ <http://github.com/marak/faker.js/> should always be up to date and working. - -## Maintainer - -#### Marak Squires - -faker.js - Copyright (c) 2020 -Marak Squires -www.marak.com -http://github.com/marak/faker.js/ - -faker.js was inspired by and has used data definitions from: - - * <https://github.com/stympy/faker/> - Copyright (c) 2007-2010 Benjamin Curtis - * <http://search.cpan.org/~jasonk/Data-Faker-0.07/> - Copyright 2004-2005 by Jason Kohles - -Permission is hereby granted, free of charge, to any person obtaining -a copy of this software and associated documentation files (the -"Software"), to deal in the Software without restriction, including -without limitation the rights to use, copy, modify, merge, publish, -distribute, sublicense, and/or sell copies of the Software, and to -permit persons to whom the Software is furnished to do so, subject to -the following conditions: - -The above copyright notice and this permission notice shall be -included in all copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND -NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE -LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION -OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION -WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - -## Backers - -Support us with a monthly donation and help us continue our activities. [[Become a backer](https://opencollective.com/fakerjs#backer)] - -<a href="https://opencollective.com/fakerjs/backer/0/website" target="_blank"><img src="https://opencollective.com/fakerjs/backer/0/avatar.svg"></a> -<a href="https://opencollective.com/fakerjs/backer/1/website" target="_blank"><img src="https://opencollective.com/fakerjs/backer/1/avatar.svg"></a> -<a href="https://opencollective.com/fakerjs/backer/2/website" target="_blank"><img src="https://opencollective.com/fakerjs/backer/2/avatar.svg"></a> -<a href="https://opencollective.com/fakerjs/backer/3/website" target="_blank"><img src="https://opencollective.com/fakerjs/backer/3/avatar.svg"></a> -<a href="https://opencollective.com/fakerjs/backer/4/website" target="_blank"><img src="https://opencollective.com/fakerjs/backer/4/avatar.svg"></a> -<a href="https://opencollective.com/fakerjs/backer/5/website" target="_blank"><img src="https://opencollective.com/fakerjs/backer/5/avatar.svg"></a> -<a href="https://opencollective.com/fakerjs/backer/6/website" target="_blank"><img src="https://opencollective.com/fakerjs/backer/6/avatar.svg"></a> -<a href="https://opencollective.com/fakerjs/backer/7/website" target="_blank"><img src="https://opencollective.com/fakerjs/backer/7/avatar.svg"></a> -<a href="https://opencollective.com/fakerjs/backer/8/website" target="_blank"><img src="https://opencollective.com/fakerjs/backer/8/avatar.svg"></a> -<a href="https://opencollective.com/fakerjs/backer/9/website" target="_blank"><img src="https://opencollective.com/fakerjs/backer/9/avatar.svg"></a> -<a href="https://opencollective.com/fakerjs/backer/10/website" target="_blank"><img src="https://opencollective.com/fakerjs/backer/10/avatar.svg"></a> -<a href="https://opencollective.com/fakerjs/backer/11/website" target="_blank"><img src="https://opencollective.com/fakerjs/backer/11/avatar.svg"></a> -<a href="https://opencollective.com/fakerjs/backer/12/website" target="_blank"><img src="https://opencollective.com/fakerjs/backer/12/avatar.svg"></a> -<a href="https://opencollective.com/fakerjs/backer/13/website" target="_blank"><img src="https://opencollective.com/fakerjs/backer/13/avatar.svg"></a> -<a href="https://opencollective.com/fakerjs/backer/14/website" target="_blank"><img src="https://opencollective.com/fakerjs/backer/14/avatar.svg"></a> -<a href="https://opencollective.com/fakerjs/backer/15/website" target="_blank"><img src="https://opencollective.com/fakerjs/backer/15/avatar.svg"></a> -<a href="https://opencollective.com/fakerjs/backer/16/website" target="_blank"><img src="https://opencollective.com/fakerjs/backer/16/avatar.svg"></a> -<a href="https://opencollective.com/fakerjs/backer/17/website" target="_blank"><img src="https://opencollective.com/fakerjs/backer/17/avatar.svg"></a> -<a href="https://opencollective.com/fakerjs/backer/18/website" target="_blank"><img src="https://opencollective.com/fakerjs/backer/18/avatar.svg"></a> -<a href="https://opencollective.com/fakerjs/backer/19/website" target="_blank"><img src="https://opencollective.com/fakerjs/backer/19/avatar.svg"></a> -<a href="https://opencollective.com/fakerjs/backer/20/website" target="_blank"><img src="https://opencollective.com/fakerjs/backer/20/avatar.svg"></a> -<a href="https://opencollective.com/fakerjs/backer/21/website" target="_blank"><img src="https://opencollective.com/fakerjs/backer/21/avatar.svg"></a> -<a href="https://opencollective.com/fakerjs/backer/22/website" target="_blank"><img src="https://opencollective.com/fakerjs/backer/22/avatar.svg"></a> -<a href="https://opencollective.com/fakerjs/backer/23/website" target="_blank"><img src="https://opencollective.com/fakerjs/backer/23/avatar.svg"></a> -<a href="https://opencollective.com/fakerjs/backer/24/website" target="_blank"><img src="https://opencollective.com/fakerjs/backer/24/avatar.svg"></a> -<a href="https://opencollective.com/fakerjs/backer/25/website" target="_blank"><img src="https://opencollective.com/fakerjs/backer/25/avatar.svg"></a> -<a href="https://opencollective.com/fakerjs/backer/26/website" target="_blank"><img src="https://opencollective.com/fakerjs/backer/26/avatar.svg"></a> -<a href="https://opencollective.com/fakerjs/backer/27/website" target="_blank"><img src="https://opencollective.com/fakerjs/backer/27/avatar.svg"></a> -<a href="https://opencollective.com/fakerjs/backer/28/website" target="_blank"><img src="https://opencollective.com/fakerjs/backer/28/avatar.svg"></a> -<a href="https://opencollective.com/fakerjs/backer/29/website" target="_blank"><img src="https://opencollective.com/fakerjs/backer/29/avatar.svg"></a> - -## Sponsors - -Become a sponsor and get your logo on our README on Github with a link to your site. [[Become a sponsor](https://opencollective.com/fakerjs#sponsor)] - -<a href="https://opencollective.com/fakerjs/sponsor/0/website" target="_blank"><img src="https://opencollective.com/fakerjs/sponsor/0/avatar.svg"></a> -<a href="https://opencollective.com/fakerjs/sponsor/1/website" target="_blank"><img src="https://opencollective.com/fakerjs/sponsor/1/avatar.svg"></a> -<a href="https://opencollective.com/fakerjs/sponsor/2/website" target="_blank"><img src="https://opencollective.com/fakerjs/sponsor/2/avatar.svg"></a> -<a href="https://opencollective.com/fakerjs/sponsor/3/website" target="_blank"><img src="https://opencollective.com/fakerjs/sponsor/3/avatar.svg"></a> -<a href="https://opencollective.com/fakerjs/sponsor/4/website" target="_blank"><img src="https://opencollective.com/fakerjs/sponsor/4/avatar.svg"></a> -<a href="https://opencollective.com/fakerjs/sponsor/5/website" target="_blank"><img src="https://opencollective.com/fakerjs/sponsor/5/avatar.svg"></a> -<a href="https://opencollective.com/fakerjs/sponsor/6/website" target="_blank"><img src="https://opencollective.com/fakerjs/sponsor/6/avatar.svg"></a> -<a href="https://opencollective.com/fakerjs/sponsor/7/website" target="_blank"><img src="https://opencollective.com/fakerjs/sponsor/7/avatar.svg"></a> -<a href="https://opencollective.com/fakerjs/sponsor/8/website" target="_blank"><img src="https://opencollective.com/fakerjs/sponsor/8/avatar.svg"></a> -<a href="https://opencollective.com/fakerjs/sponsor/9/website" target="_blank"><img src="https://opencollective.com/fakerjs/sponsor/9/avatar.svg"></a> -<a href="https://opencollective.com/fakerjs/sponsor/10/website" target="_blank"><img src="https://opencollective.com/fakerjs/sponsor/10/avatar.svg"></a> -<a href="https://opencollective.com/fakerjs/sponsor/11/website" target="_blank"><img src="https://opencollective.com/fakerjs/sponsor/11/avatar.svg"></a> -<a href="https://opencollective.com/fakerjs/sponsor/12/website" target="_blank"><img src="https://opencollective.com/fakerjs/sponsor/12/avatar.svg"></a> -<a href="https://opencollective.com/fakerjs/sponsor/13/website" target="_blank"><img src="https://opencollective.com/fakerjs/sponsor/13/avatar.svg"></a> -<a href="https://opencollective.com/fakerjs/sponsor/14/website" target="_blank"><img src="https://opencollective.com/fakerjs/sponsor/14/avatar.svg"></a> -<a href="https://opencollective.com/fakerjs/sponsor/15/website" target="_blank"><img src="https://opencollective.com/fakerjs/sponsor/15/avatar.svg"></a> -<a href="https://opencollective.com/fakerjs/sponsor/16/website" target="_blank"><img src="https://opencollective.com/fakerjs/sponsor/16/avatar.svg"></a> -<a href="https://opencollective.com/fakerjs/sponsor/17/website" target="_blank"><img src="https://opencollective.com/fakerjs/sponsor/17/avatar.svg"></a> -<a href="https://opencollective.com/fakerjs/sponsor/18/website" target="_blank"><img src="https://opencollective.com/fakerjs/sponsor/18/avatar.svg"></a> -<a href="https://opencollective.com/fakerjs/sponsor/19/website" target="_blank"><img src="https://opencollective.com/fakerjs/sponsor/19/avatar.svg"></a> -<a href="https://opencollective.com/fakerjs/sponsor/20/website" target="_blank"><img src="https://opencollective.com/fakerjs/sponsor/20/avatar.svg"></a> -<a href="https://opencollective.com/fakerjs/sponsor/21/website" target="_blank"><img src="https://opencollective.com/fakerjs/sponsor/21/avatar.svg"></a> -<a href="https://opencollective.com/fakerjs/sponsor/22/website" target="_blank"><img src="https://opencollective.com/fakerjs/sponsor/22/avatar.svg"></a> -<a href="https://opencollective.com/fakerjs/sponsor/23/website" target="_blank"><img src="https://opencollective.com/fakerjs/sponsor/23/avatar.svg"></a> -<a href="https://opencollective.com/fakerjs/sponsor/24/website" target="_blank"><img src="https://opencollective.com/fakerjs/sponsor/24/avatar.svg"></a> -<a href="https://opencollective.com/fakerjs/sponsor/25/website" target="_blank"><img src="https://opencollective.com/fakerjs/sponsor/25/avatar.svg"></a> -<a href="https://opencollective.com/fakerjs/sponsor/26/website" target="_blank"><img src="https://opencollective.com/fakerjs/sponsor/26/avatar.svg"></a> -<a href="https://opencollective.com/fakerjs/sponsor/27/website" target="_blank"><img src="https://opencollective.com/fakerjs/sponsor/27/avatar.svg"></a> -<a href="https://opencollective.com/fakerjs/sponsor/28/website" target="_blank"><img src="https://opencollective.com/fakerjs/sponsor/28/avatar.svg"></a> -<a href="https://opencollective.com/fakerjs/sponsor/29/website" target="_blank"><img src="https://opencollective.com/fakerjs/sponsor/29/avatar.svg"></a> diff --git a/gulpfile.js b/gulpfile.js index 53b5d6c8..a7a60ff3 100644 --- a/gulpfile.js +++ b/gulpfile.js @@ -1,12 +1,11 @@ function defaultTask(cb) { // place code for your default task here console.log('please run gulp --tasks to see available tasks for faker.js') - console.log('you can then try running a command like `gulp readme`') + console.log('you can then try running a command like `gulp jsdoc`') cb(); } exports.browser = require('./build/gulp-tasks/browser'); exports.jsdoc = require('./build/gulp-tasks/jsdoc'); -exports.readme = require('./build/gulp-tasks/readme'); exports.default = defaultTask
\ No newline at end of file diff --git a/package.json b/package.json index 7a1d1202..8479c030 100644 --- a/package.json +++ b/package.json @@ -12,7 +12,6 @@ "scripts": { "browser": "./node_modules/.bin/gulp browser", "jsdoc": "./node_modules/.bin/gulp jsdoc", - "readme": "./node_modules/.bin/gulp readme", "lint": "node_modules/.bin/eslint ./lib/animal.js", "test": "node_modules/.bin/mocha test/*.*.js", "coverage": "nyc report --reporter=text-lcov | coveralls" @@ -67,6 +66,5 @@ "vinyl-transform": "^1.0.0" }, "license": "MIT", - "main": "index.js", - "dependencies": {} + "main": "index.js" } |