v2.1.1

- Clear history

.eslintignore

@@ -0,0 +1,9 @@
+coverage/*
+node_modules/*
+dist
+**/vendor/*.js
+test/libs
+.nyc_output/*
+LICENSE
+package.json
+README.md

.eslintrc.json

@@ -0,0 +1,6 @@
+{
+  "extends": "eslint-config-goes",
+  "env": {
+    "jasmine": true
+  }
+}

.gitignore

@@ -0,0 +1,17 @@
+# Logs
+logs
+*.log
+*.debug
+
+# Runtime data
+*.pid
+*.lock
+*.seed
+
+node_modules
+coverage
+.nyc_output
+
+yarn.lock
+coverage.lcov
+package-lock.json

.travis.yml

@@ -0,0 +1,6 @@
+language: node_js
+node_js:
+  - "10.0"
+  - "8.11"
+  - "7.6"
+  - "6.0"

LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Dong Nguyen
+
+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.

README.md

@@ -0,0 +1,98 @@
+# txtgen
+Lightweight util for generating random sentences, paragraphs and articles in English. Inspired by [Sentencer](https://github.com/kylestetz/Sentencer) and [metaphorpsum.com](http://metaphorpsum.com/).
+
+[![NPM](https://badge.fury.io/js/txtgen.svg)](https://badge.fury.io/js/txtgen)
+[![Build Status](https://travis-ci.org/ndaidong/txtgen.svg?branch=master)](https://travis-ci.org/ndaidong/txtgen)
+[![codecov](https://codecov.io/gh/ndaidong/txtgen/branch/master/graph/badge.svg)](https://codecov.io/gh/ndaidong/txtgen)
+[![Dependency Status](https://gemnasium.com/badges/github.com/ndaidong/txtgen.svg)](https://gemnasium.com/github.com/ndaidong/txtgen)
+[![NSP Status](https://nodesecurity.io/orgs/techpush/projects/1b2672cb-6712-436d-bd2c-c122892775bb/badge)](https://nodesecurity.io/orgs/techpush/projects/1b2672cb-6712-436d-bd2c-c122892775bb)
+
+
+# Demo
+
+[See how it works?](http://ndaidong.github.io/txtgen/)
+
+
+## Setup
+
+- Node.js
+
+  ```
+  npm install txtgen
+  ```
+
+- CDN
+
+  - [txtgen.js](https://cdn.rawgit.com/ndaidong/txtgen/master/dist/txtgen.js)
+  - [txtgen.min.js](https://cdn.rawgit.com/ndaidong/txtgen/master/dist/txtgen.min.js)
+  - [txtgen.min.map](https://cdn.rawgit.com/ndaidong/txtgen/master/dist/txtgen.min.map)
+
+- Also supports ES6 Module, CommonJS, AMD and UMD style.
+
+
+### Usage
+
+```
+var txtgen = require('txtgen');
+
+let sentence = txtgen.sentence();
+console.log(sentence);
+
+let paragraph = txtgen.paragraph();
+console.log(paragraph);
+
+let article = txtgen.article();
+console.log(article);
+```
+
+## APIs
+
+ - .sentence()
+ - .paragraph([Number totalSentences])
+ - .article([Number totalParagraphs])
+ - .addNouns(Array nouns)
+ - .addAdjectives(Array adjectives)
+ - .addTemplates(Array sentenceTemplates)
+
+### Template
+
+If you want to add more kinds of sentence, just use `.addTemplates()` method. It expects a list of sentence templates.
+Each of sentence template is an English sentence, with the placeholders that can be replaced with any alternative word.
+
+
+For example:
+
+```
+import {
+  addTemplates
+} from 'txtgen';
+
+let templates = [
+  '{{a_noun}} is {{a_noun}} from the right perspective',
+  'the {{noun}} of {{a_noun}} becomes {{an_adjective}} {{noun}}'
+];
+
+addTemplates(templates);
+```
+
+Here are the available placeholders:
+
+- noun
+- nouns
+- a_noun
+- adjective
+- an_adjective
+
+
+## Test
+
+```
+git clone https://github.com/ndaidong/txtgen.git
+cd txtgen
+npm install
+npm test
+```
+
+# License
+
+The MIT License (MIT)

dist/txtgen.js

@@ -0,0 +1,164 @@
+/**
+ * [email protected]
+ * built on: Mon, 07 May 2018 08:49:31 GMT
+ * repository: https://github.com/ndaidong/txtgen
+ * maintainer: @ndaidong
+ * License: MIT
+**/
+(function (global, factory) {
+  typeof exports === 'object' && typeof module !== 'undefined' ? factory(exports) :
+  typeof define === 'function' && define.amd ? define(['exports'], factory) :
+  (factory((global.txtgen = {})));
+}(this, (function (exports) { 'use strict';
+  var unique = function unique(a) {
+    var r = [];
+    for (var i = 0; i < a.length; i++) {
+      if (r.indexOf(a[i]) === -1) {
+        r.push(a[i]);
+      }
+    }
+    return r;
+  };
+  var random = function random(min, max) {
+    var offset = min;
+    var range = max - min + 1;
+    var rd = Math.floor(Math.random() * range) + offset;
+    return rd;
+  };
+  var rand = function rand(a) {
+    var w = void 0;
+    while (!w) {
+      w = a[random(0, a.length - 1)];
+    }
+    return w;
+  };
+  var pickLastPunc = function pickLastPunc() {
+    var a = '.......!?!?;...'.split('');
+    return rand(a);
+  };
+  var pluralize = function pluralize(word) {
+    if (word.endsWith('s')) {
+      return word;
+    }
+    if (word.match(/(ss|ish|ch|x|us)$/)) {
+      word += 'e';
+    } else if (word.endsWith('y') && !vowels.includes(word.charAt(word.length - 2))) {
+      word = word.slice(0, word.length - 1);
+      word += 'ie';
+    }
+    return word + 's';
+  };
+  var normalize = function normalize(word) {
+    var a = 'a';
+    if (word.match(/^(a|e|i|o)/)) {
+      a = 'an';
+    }
+    return a + ' ' + word;
+  };
+  var nouns = ['alligator', 'ant', 'bear', 'bee', 'bird', 'camel', 'cat', 'cheetah', 'chicken', 'chimpanzee', 'cow', 'crocodile', 'deer', 'dog', 'dolphin', 'duck', 'eagle', 'elephant', 'fish', 'fly', 'fox', 'frog', 'giraffe', 'goat', 'goldfish', 'hamster', 'hippopotamus', 'horse', 'kangaroo', 'kitten', 'lion', 'lobster', 'monkey', 'octopus', 'owl', 'panda', 'pig', 'puppy', 'rabbit', 'rat', 'scorpion', 'seal', 'shark', 'sheep', 'snail', 'snake', 'spider', 'squirrel', 'tiger', 'turtle', 'wolf', 'zebra', 'apple', 'apricot', 'banana', 'blackberry', 'blueberry', 'cherry', 'cranberry', 'currant', 'fig', 'grape', 'grapefruit', 'grapes', 'kiwi', 'kumquat', 'lemon', 'lime', 'melon', 'nectarine', 'orange', 'peach', 'pear', 'persimmon', 'pineapple', 'plum', 'pomegranate', 'prune', 'raspberry', 'strawberry', 'tangerine', 'watermelon'];
+  var adjectives = ['adaptable', 'adventurous', 'affable', 'affectionate', 'agreeable', 'alert', 'alluring', 'ambitious', 'ambitious', 'amiable', 'amicable', 'amused', 'amusing', 'boundless', 'brave', 'brave', 'bright', 'bright', 'broad-minded', 'calm', 'calm', 'capable', 'careful', 'charming', 'charming', 'cheerful', 'coherent', 'comfortable', 'communicative', 'compassionate', 'confident', 'conscientious', 'considerate', 'convivial', 'cooperative', 'courageous', 'courageous', 'courteous', 'creative', 'credible', 'cultured', 'dashing', 'dazzling', 'debonair', 'decisive', 'decisive', 'decorous', 'delightful', 'detailed', 'determined', 'determined', 'diligent', 'diligent', 'diplomatic', 'discreet', 'discreet', 'dynamic', 'dynamic', 'eager', 'easygoing', 'efficient', 'elated', 'eminent', 'emotional', 'enchanting', 'encouraging', 'endurable', 'energetic', 'energetic', 'entertaining', 'enthusiastic', 'enthusiastic', 'excellent', 'excited', 'exclusive', 'exuberant', 'exuberant', 'fabulous', 'fair', 'fair-minded', 'faithful', 'faithful', 'fantastic', 'fearless', 'fearless', 'fine', 'forceful', 'frank', 'frank', 'friendly', 'friendly', 'funny', 'funny', 'generous', 'generous', 'gentle', 'gentle', 'glorious', 'good', 'good', 'gregarious', 'happy', 'hard-working', 'harmonious', 'helpful', 'helpful', 'hilarious', 'honest', 'honorable', 'humorous', 'imaginative', 'impartial', 'impartial', 'independent', 'industrious', 'instinctive', 'intellectual', 'intelligent', 'intuitive', 'inventive', 'jolly', 'joyous', 'kind', 'kind', 'kind-hearted', 'knowledgeable', 'level', 'likeable', 'lively', 'lovely', 'loving', 'loving', 'loyal', 'lucky', 'mature', 'modern', 'modest', 'neat', 'nice', 'nice', 'obedient', 'optimistic', 'painstaking', 'passionate', 'patient', 'peaceful', 'perfect', 'persistent', 'philosophical', 'pioneering', 'placid', 'placid', 'plausible', 'pleasant', 'plucky', 'plucky', 'polite', 'powerful', 'practical', 'pro-active', 'productive', 'protective', 'proud', 'punctual', 'quick-witted', 'quiet', 'quiet', 'rational', 'receptive', 'reflective', 'reliable', 'relieved', 'reserved', 'resolute', 'resourceful', 'responsible', 'rhetorical', 'righteous', 'romantic', 'romantic', 'sedate', 'seemly', 'selective', 'self-assured', 'self-confident', 'self-disciplined', 'sensible', 'sensitive', 'sensitive', 'shrewd', 'shy', 'silly', 'sincere', 'sincere', 'skillful', 'smiling', 'sociable', 'splendid', 'steadfast', 'stimulating', 'straightforward', 'successful', 'succinct', 'sympathetic', 'talented', 'thoughtful', 'thoughtful', 'thrifty', 'tidy', 'tough', 'tough', 'trustworthy', 'unassuming', 'unbiased', 'understanding', 'unusual', 'upbeat', 'versatile', 'vigorous', 'vivacious', 'warm', 'warmhearted', 'willing', 'willing', 'wise', 'witty', 'witty', 'wonderful'];
+  var vowels = ['a', 'e', 'i', 'o', 'u', 'y'];
+  var sentenceTemplates = ['the {{noun}} is {{a_noun}}', '{{a_noun}} is {{an_adjective}} {{noun}}', 'the first {{adjective}} {{noun}} is, in its own way, {{a_noun}}', 'their {{noun}} was, in this moment, {{an_adjective}} {{noun}}', '{{a_noun}} is {{a_noun}} from the right perspective', 'the literature would have us believe that {{an_adjective}} {{noun}} is not but {{a_noun}}', '{{an_adjective}} {{noun}} is {{a_noun}} of the mind', 'the {{adjective}} {{noun}} reveals itself as {{an_adjective}} {{noun}} to those who look', 'authors often misinterpret the {{noun}} as {{an_adjective}} {{noun}}, when in actuality it feels more like {{an_adjective}} {{noun}}', 'we can assume that any instance of {{a_noun}} can be construed as {{an_adjective}} {{noun}}', 'they were lost without the {{adjective}} {{noun}} that composed their {{noun}}', 'the {{adjective}} {{noun}} comes from {{an_adjective}} {{noun}}', '{{a_noun}} can hardly be considered {{an_adjective}} {{noun}} without also being {{a_noun}}', 'few can name {{an_adjective}} {{noun}} that isn\'t {{an_adjective}} {{noun}}', 'some posit the {{adjective}} {{noun}} to be less than {{adjective}}', '{{a_noun}} of the {{noun}} is assumed to be {{an_adjective}} {{noun}}', '{{a_noun}} sees {{a_noun}} as {{an_adjective}} {{noun}}', 'the {{noun}} of {{a_noun}} becomes {{an_adjective}} {{noun}}', '{{a_noun}} is {{a_noun}}\'s {{noun}}', '{{a_noun}} is the {{noun}} of {{a_noun}}', '{{an_adjective}} {{noun}}\'s {{noun}} comes with it the thought that the {{adjective}} {{noun}} is {{a_noun}}', '{{nouns}} are {{adjective}} {{nouns}}', '{{adjective}} {{nouns}} show us how {{nouns}} can be {{nouns}}', 'before {{nouns}}, {{nouns}} were only {{nouns}}', 'those {{nouns}} are nothing more than {{nouns}}', 'some {{adjective}} {{nouns}} are thought of simply as {{nouns}}', 'one cannot separate {{nouns}} from {{adjective}} {{nouns}}', 'the {{nouns}} could be said to resemble {{adjective}} {{nouns}}', '{{an_adjective}} {{noun}} without {{nouns}} is truly a {{noun}} of {{adjective}} {{nouns}}'];
+  var phrases = ['to be more specific, ', 'in recent years, ', 'however, ', 'by the way', 'of course, ', 'some assert that ', 'if this was somewhat unclear, ', 'unfortunately, that is wrong; on the contrary, ', 'it\'s very tricky, if not impossible, ', 'this could be, or perhaps ', 'this is not to discredit the idea that ', 'we know that ', 'it\'s an undeniable fact, really; ', 'framed in a different way, ', 'what we don\'t know for sure is whether or not ', 'as far as we can estimate, ', 'as far as he is concerned, ', 'the zeitgeist contends that ', 'though we assume the latter, ', 'far from the truth, ', 'extending this logic, ', 'nowhere is it disputed that ', 'in modern times ', 'in ancient times ', 'recent controversy aside, ', 'washing and polishing the car,', 'having been a gymnast, ', 'after a long day at school and work, ', 'waking to the buzz of the alarm clock, ', 'draped neatly on a hanger, ', 'shouting with happiness, '];
+  var addNouns = function addNouns() {
+    var ls = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : [];
+    var a = nouns.concat(ls);
+    nouns = unique(a);
+    return nouns.length;
+  };
+  var addAdjectives = function addAdjectives(ls) {
+    var a = adjectives.concat(ls);
+    adjectives = unique(a);
+    return adjectives.length;
+  };
+  var addTemplates = function addTemplates(ls) {
+    var a = sentenceTemplates.concat(ls);
+    sentenceTemplates = unique(a);
+    return sentenceTemplates.length;
+  };
+  var actions = ['noun', 'a_noun', 'nouns', 'adjective', 'an_adjective'];
+  var generator = {
+    noun: function noun() {
+      return rand(nouns);
+    },
+    a_noun: function a_noun() {
+      return normalize(rand(nouns));
+    },
+    nouns: function nouns$$1() {
+      return pluralize(rand(nouns));
+    },
+    adjective: function adjective() {
+      return rand(adjectives);
+    },
+    an_adjective: function an_adjective() {
+      return normalize(rand(adjectives));
+    }
+  };
+  var trim = function trim(s) {
+    return s.replace(/^[\s\xa0]+|[\s\xa0]+$/g, '').replace(/\r?\n|\r/g, ' ').replace(/\s\s+|\r/g, ' ');
+  };
+  var make = function make(template) {
+    var sentence = template;
+    var occurrences = template.match(/\{\{(.+?)\}\}/g);
+    if (occurrences && occurrences.length) {
+      for (var i = 0; i < occurrences.length; i++) {
+        var action = trim(occurrences[i].replace('{{', '').replace('}}', ''));
+        var result = void 0;
+        if (actions.includes(action)) {
+          result = generator[action]();
+        }
+        sentence = sentence.replace(occurrences[i], result);
+      }
+    }
+    return sentence;
+  };
+  var randomStartingPhrase = function randomStartingPhrase() {
+    if (Math.random() < 0.33) {
+      return rand(phrases);
+    }
+    return '';
+  };
+  var makeSentenceFromTemplate = function makeSentenceFromTemplate() {
+    return make(rand(sentenceTemplates));
+  };
+  var sentence = function sentence() {
+    var phrase = randomStartingPhrase();
+    var s = phrase + makeSentenceFromTemplate();
+    s = s.charAt(0).toUpperCase() + s.slice(1);
+    s += pickLastPunc();
+    return s;
+  };
+  var paragraph = function paragraph() {
+    var len = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : 0;
+    if (!len) {
+      len = random(3, 10);
+    }
+    var t = Math.min(len, 15);
+    var a = [];
+    while (a.length < t) {
+      var s = sentence();
+      a.push(s);
+    }
+    return a.join(' ');
+  };
+  var article = function article() {
+    var len = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : 0;
+    if (!len) {
+      len = random(3, 10);
+    }
+    var t = Math.min(len, 15);
+    var a = [];
+    while (a.length < t) {
+      var s = paragraph();
+      a.push(s);
+    }
+    return a.join('\n\n');
+  };
+  exports.sentence = sentence;
+  exports.paragraph = paragraph;
+  exports.article = article;
+  exports.addNouns = addNouns;
+  exports.addAdjectives = addAdjectives;
+  exports.addTemplates = addTemplates;
+  Object.defineProperty(exports, '__esModule', { value: true });
+})));