lorem-ipsum - npm Package Compare versions

Comparing version 1.0.6 to 2.0.0-alpha.0

package.json

 {
   "name": "lorem-ipsum",
-  "version": "1.0.6",
+  "version": "2.0.0-alpha.0",
   "description": "Generates passages of lorem ipsum text suitable for use as placeholder copy in web pages, graphics, and more. Works in the browser, NodeJS, and React Native.",
   "author": "Nickolas Kenyeres <[e-mail]> (http://knicklabs.github.com)",
-  "license": "MIT",
-  "main": "./lib/generator",
-  "dependencies": {
-    "minimist": "~1.2.0"
+  "license": "ISC",
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/knicklabs/node-lorem-ipsum.git"
   },
-  "devDependencies": {
-    "alea": "0.0.9",
-    "mocha": "^5.2.0"
-  },
-  "optionalDependencies": {},
   "bin": {
-    "lorem-ipsum": "bin/lorem-ipsum.bin.js"
+    "lorem-ipsum": "dist/bin/lorem-ipsum.bin.js"
   },
   "scripts": {
-    "test": "./node_modules/mocha/bin/mocha"
+    "build": "webpack",
+    "lint:check": "tslint -c tslint.json src/**/*.ts",
+    "test": "jest --coverage",
+    "release": "yarn build && release-it",
+    "release:dry": "yarn build && release-it --dry-run",
+    "coverage": "nyc report --temp-directory=coverage --reporter=text-lcov"
   },
-  "repository": {
-    "type": "git",
-    "url": "git://github.com/knicklabs/node-lorem-ipsum.git"
-  },
   "keywords": [
@@ -34,5 +30,54 @@ "lorem",
   ],
-  "engine": {
-    "node": ">=0.4"
+  "engines": {
+    "node": ">= 8.x",
+    "npm": ">= 5.x"
+  },
+  "devDependencies": {
+    "@babel/core": "^7.0.0",
+    "@babel/plugin-proposal-class-properties": "^7.0.0",
+    "@babel/plugin-proposal-object-rest-spread": "^7.0.0",
+    "@babel/preset-env": "^7.0.0",
+    "@babel/preset-typescript": "^7.0.0",
+    "@types/jest": "^23.3.1",
+    "@types/node": "^10.9.3",
+    "@types/random-seed": "^0.3.3",
+    "@types/react-native": "^0.56.15",
+    "babel-loader": "^8.0.0",
+    "clean-webpack-plugin": "^0.1.19",
+    "coveralls": "^3.0.2",
+    "jest": "^23.5.0",
+    "nock-exec": "^0.1.0",
+    "nyc": "^13.0.1",
+    "prettier": "^1.14.2",
+    "release-it": "^7.6.0",
+    "ts-jest": "^23.1.4",
+    "tslint": "^5.11.0",
+    "typescript": "^3.0.1",
+    "webpack": "^4.17.1",
+    "webpack-cli": "^3.1.0"
+  },
+  "dependencies": {
+    "commander": "^2.17.1",
+    "random-seed": "^0.3.0"
+  },
+  "jest": {
+    "collectCoverageFrom": [
+      "src/**/*.{ts}",
+      "!src/bin/**/*.ts",
+      "!src/constants/cli.ts",
+      "!src/@types/**/*.d.ts"
+    ],
+    "transform": {
+      "^.+\\.tsx?$": "ts-jest"
+    },
+    "testRegex": "(/__tests__/.*|(\\.|/)(test|spec))\\.(jsx?|tsx?)$",
+    "moduleFileExtensions": [
+      "ts",
+      "tsx",
+      "js",
+      "jsx",
+      "json",
+      "node"
+    ]
   }
 }

README.md

@@ -1,124 +0,138 @@
-### lorem-ipsum.js
+# lorem-ipsum
 
-lorem-ipsum.js is a Node.js, Component.js, and React Native module for generating passages of lorem ipsum text. Lorem ipsum text is commonly used as placeholder text in publishing, graphic design, and web development.
+[![Codacy Badge](https://api.codacy.com/project/badge/Grade/b55bd2bc24764915adde9b0e74223045)](https://www.codacy.com/app/knicklabs/lorem-ipsum.js?utm_source=github.com&utm_medium=referral&utm_content=knicklabs/lorem-ipsum.js&utm_campaign=Badge_Grade)
+[![Build Status](https://travis-ci.org/knicklabs/lorem-ipsum.js.svg?branch=master)](https://travis-ci.org/knicklabs/lorem-ipsum.js) [![Coverage Status](https://coveralls.io/repos/github/knicklabs/lorem-ipsum.js/badge.svg?branch=master)](https://coveralls.io/github/knicklabs/lorem-ipsum.js?branch=master) [![npm version](https://badge.fury.io/js/lorem-ipsum.svg)](https://badge.fury.io/js/lorem-ipsum) ![dependencies](https://david-dm.org/knicklabs/lorem-ipsum.js.svg) ![node](https://img.shields.io/badge/node-8x-blue.svg) ![npm](https://img.shields.io/badge/npm-5x-blue.svg)
 
-### Using the Module (Node.js)
+`lorem-ipsum` is a JavaScript module for generating passages of lorem
+ipsum text. Lorem ipsum text is commonly used as placeholder text in
+publishing, graphic design, and web development.
 
-Install the lorem-ipsum.js module to use the library in your server-side Node.js projects.
+`lorem-ipsum` is compatible with the browser, Node.JS, and React Native.
 
-```bash
-cd ~/MyProject
-npm install lorem-ipsum
+## Using the Class
+
+The class is the recommended way to use `lorem-ipsum` since version 2.
+It makes it simpler to generate text using the same options.
+
 ```
+import { LoremIpsum } from "lorem-ipsum";
 
-Require the lorem-ipsum.js module and use it to generate a passage of lorem ipsum text.
+const lorem = new LoremIpsum({
+  sentencesPerParagraph: {
+    max: 8,
+    min: 4
+  },
+  wordsPerSentence: {
+    max: 16,
+    min: 4
+  }
+});
 
-```javascript
-var loremIpsum = require('lorem-ipsum')
-  , output     = loremIpsum();
+lorem.generateWords(1);
+lorem.generateSentences(5);
+lorem.generateParagraphs(7);
 ```
 
-### Using the Module (Component.js)
+## Using the Function
 
-Install the lorem-ipsum.js module to use the library client-side.
+`lorem-ipsum` version 2 exports a default function that is backwards-
+compatible with the default function exported by `lorem-ipsum` version
+1. Users of version 1 should be able to upgrade to version 2 without 
+any issue; they can just continue using this library as they did before.
 
-```bash
-cd ~/MyProject
-component install knicklabs/lorem-ipsum.js
 ```
+import lorem from "lorem-ipsum";
 
-Require the lorem-ipsum.js module and use it to generate a passage of lorem ipsum text.
-
-```javascript
-var loremIpsum = require('knicklabs-lorem-ipsum.js')
-  , output     = loremIpsum();
+lorem(); // generates one sentence
 ```
 
-### Customizing the Output with Options (Node.js/Component.js)
+Like before, you can pass in a number of options to customize the output.
+The example below shows the default options.
 
-You can pass options to the loremIpsum() function to fine-tune the output. The API is the same on client and server. See below:
+```
+import lorem from "lorem-ipsum";
 
-```javascript
-...
-output = loremIpsum({
-    count: 1                      // Number of words, sentences, or paragraphs to generate.
-  , units: 'sentences'            // Generate words, sentences, or paragraphs.
-  , sentenceLowerBound: 5         // Minimum words per sentence.
-  , sentenceUpperBound: 15        // Maximum words per sentence.
-  , paragraphLowerBound: 3        // Minimum sentences per paragraph.
-  , paragraphUpperBound: 7        // Maximum sentences per paragraph.
-  , format: 'plain'               // Plain text or html
-  , words: ['ad', 'dolor', ... ]  // Custom word dictionary. Uses dictionary.words (in lib/dictionary.js) by default.
-  , random: Math.random           // A PRNG function. Uses Math.random by default
-  , suffix: EOL                   // The character to insert between paragraphs. Defaults to default EOL for your OS.
-});
+lorem({
+  count: 1,                // Number of "words", "sentences", or "paragraphs"
+  format: "plain",         // "plain" or "html"
+  paragraphLowerBound: 3,  // Min. number of sentences per paragraph.
+  paragraphUpperBound: 7,  // Max. number of sentences per paragarph.
+  random: Math.random,     // A PRNG function
+  sentenceLowerBound: 5,   // Min. number of words per sentence.
+  sentenceUpperBound: 15,  // Max. number of words per sentence.
+  suffix: "\n",            // Line ending, defaults to "\n" or "\r\n" (win32)
+  units: "sentences",      // paragraph(s), "sentence(s)", or "word(s)"
+  words: ["ad", ...]       // Array of words to draw from
+})
 ```
 
-### Using the CLI (Node.js)
+## Using the CLI
 
-lorem-ipsum.js includes a command line interface for generating passages of lorem ipsum text. Install the module globally to take advantage of this feature.
+`lorem-ipsum` includes a command line interface (CLI) program for generating 
+passages of lorem ipsum text directly from your terminal. This CLI program 
+is compatible with Mac OSX, Windows, and Linux. On Linux you will need to 
+install xclip. On Ubuntu: `apt-get install xclip`.
 
-```bash
-npm install lorem-ipsum --global
+Simply install the module globally to take advantage of this feature.
+
 ```
+npm i -g lorem-ipsum
+```
 
-Execute the statement `lorem-ipsum` from your terminal to generate a passage of lorem ipsum text. You can pass arguments to the program to fine-tune the output.
+Execute the statement `lorem-ipsum [count] [units]` from your terminal to
+generate a passage of lorem ipsum text. You can additional arguments to
+the program.
 
-```bash
-lorem-ipsum --units words --count 100 --copy --format html
 ```
+lorem-ipsum --version
+# Displays the version number
 
-See below for a description of the arguments to the program.
+lorem-ipsum --help
+# Displays the help documentation
 
-<table>
-  <tr>
-    <th>Argument</th>
-    <th>Description</th>
-  </tr>
-  <tr>
-    <td>--count</td>
-    <td>The <strong>number</strong> of words, sentences or paragraphs to generate</td>
-  </tr>
-  <tr>
-    <td>--units</td>
-    <td>Generate <strong>words</strong>, <strong>sentences</strong> or <strong>paragraphs</strong></td>
-  </tr>
-  <tr>
-    <td>--copy</td>
-    <td><strong>Copy</strong> the output to the system clipboard</td>
-  </tr>
-  <tr>
-    <td>--format</td>
-    <td><strong>html</strong> or <strong>plain</strong> text format</td>
-  </tr>
-</table>
+lorem-ipsum 1 word
+# Prints one word
 
-You may now also use a short form when running lorem-ipsum.js from the command line. Here's some examples:
+lorem-ipsum 2 words
+# Prints two words
 
-```
-lorem-ipsum 1 word
-```
+lorem-ipsum 1 sentence
+# Prints one sentence
 
-```
-lorem-ipsum 15 sentences --copy
-```
+lorem-ipsum 2 sentences
+# Prints two sentences
 
-```
-lorem-ipsum 5 paragraphs --copy --format html
-```
+lorem-ipsum 1 paragraph
+# Prints one paragraph
 
-### Notes
+lorem-ipsum 2 paragraphs
+# Prints two paragraphs
 
-The copy feature requires that you have xclip installed if you are using lorem-ipsum.js on Linux. The feature will work out of the box on Mac and Windows systems.
+lorem-ipsum 2 paragraphs --copy
+# Prints two pargraphs and copies it to your clipboard
 
-### License
+lorem-ipsum 2 pargraphs --format html
+# Prints two paragraphs in HTML format
 
-This software is licensed under the MIT license.
+lorem-ipsum 2 paragraphs --format html --copy
+# Prints two paragraphs in HTML format and copies it to your clipboard.
 
-Copyright (c) 2012-2018 Nickolas Kenyeres
+Uprading from version 1.x? The `--count` and `--units` options have been 
+dropped in favor of the natural language interface shown in the examples
+above.
 
-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:
+## License
 
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+Copyright (c) 2012-2018 Nickolas Kenyeres <[e-mail]>
 
-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.
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Shell access

Supply chain risk

This module accesses the system shell. Accessing the system shell increases the risk of executing arbitrary code.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

190170

increased by1290.03%

Number of package files

52

increased by477.78%

Lines of code

2209

increased by688.93%

Number of lines in readme file

139

increased by11.2%

Worsened metrics

Dependency count

2

increased by100%

Dev dependency count

22

increased by1000%

Number of low quality alerts

2

increased by100%

Dependency changes

• + Addedcommander@^2.17.1

• + Addedrandom-seed@^0.3.0

• + Addedcommander@2.20.3(transitive)

• + Addedjson-stringify-safe@5.0.1(transitive)

• + Addedrandom-seed@0.3.0(transitive)

• - Removedminimist@~1.2.0

• - Removedminimist@1.2.8(transitive)