{"analyzedAt":"2022-07-08T15:46:12.217Z","collected":{"metadata":{"name":"lorem-ipsum","scope":"unscoped","version":"2.0.8","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.","keywords":["lorem","ipsum","placeholder","text","dummy","filler"],"date":"2022-06-10T03:59:54.323Z","author":{"name":"Nickolas Kenyeres","email":"nkenyeres@gmail.com","url":"http://knicklabs.github.com"},"publisher":{"username":"knicklabs","email":"nickolas@knicklabs.com"},"maintainers":[{"username":"knicklabs","email":"nickolas@knicklabs.com"}],"repository":{"type":"git","url":"git://github.com/knicklabs/node-lorem-ipsum.git"},"links":{"npm":"https://www.npmjs.com/package/lorem-ipsum","homepage":"https://github.com/knicklabs/node-lorem-ipsum#readme","repository":"https://github.com/knicklabs/node-lorem-ipsum","bugs":"https://github.com/knicklabs/node-lorem-ipsum/issues"},"license":"ISC","dependencies":{"commander":"^9.3.0"},"devDependencies":{"@babel/cli":"^7.17.10","@babel/core":"^7.18.2","@babel/plugin-proposal-class-properties":"^7.17.12","@babel/plugin-proposal-object-rest-spread":"^7.18.0","@babel/plugin-transform-modules-commonjs":"^7.18.2","@babel/preset-env":"^7.18.2","@babel/preset-typescript":"^7.17.12","@types/jest":"^28.1.1","@types/node":"^17.0.41","@types/random-seed":"^0.3.3","babel-loader":"^8.2.5","coveralls":"^3.1.1","jest":"^28.1.1","nock-exec":"^0.1.0","nyc":"^15.1.0","prettier":"^2.6.2","release-it":"^15.0.0","ts-jest":"^28.0.4","tslint":"^6.1.3","typescript":"^4.7.3"},"releases":[{"from":"2022-06-08T00:00:00.000Z","to":"2022-07-08T00:00:00.000Z","count":5},{"from":"2022-04-09T00:00:00.000Z","to":"2022-07-08T00:00:00.000Z","count":5},{"from":"2022-01-09T00:00:00.000Z","to":"2022-07-08T00:00:00.000Z","count":5},{"from":"2021-07-08T00:00:00.000Z","to":"2022-07-08T00:00:00.000Z","count":6},{"from":"2020-07-08T00:00:00.000Z","to":"2022-07-08T00:00:00.000Z","count":6}],"hasTestScript":true,"readme":"# lorem-ipsum\r\n\r\n[![Codacy Badge](https://app.codacy.com/project/badge/Grade/a0984231f0ac46efa617cf401964f8b6)](https://www.codacy.com/gh/knicklabs/lorem-ipsum.js/dashboard?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=knicklabs/lorem-ipsum.js&amp;utm_campaign=Badge_Grade)\r\n[![Coverage Status](https://coveralls.io/repos/github/knicklabs/lorem-ipsum.js/badge.svg?branch=main)](https://coveralls.io/github/knicklabs/lorem-ipsum.js?branch=main) [![npm version](https://badge.fury.io/js/lorem-ipsum.svg)](https://badge.fury.io/js/lorem-ipsum) ![node](https://img.shields.io/badge/node-8x-blue.svg) ![npm](https://img.shields.io/badge/npm-5x-blue.svg)\r\n\r\n## Overview\r\n\r\n🎉 __Celebrating 10 years of `lorem-ipsum`__ 🎉\r\n\r\n`lorem-ipsum` is a JavaScript module for generating passages of lorem\r\nipsum text. Lorem ipsum text is commonly used as placeholder text in\r\npublishing, graphic design, and web development.\r\n\r\n`lorem-ipsum` is compatible with the browser, Node.JS, and React Native.\r\n\r\n## Important Notes\r\n\r\nTHIS README IS FOR VERSION 2. SWITCH TO `1-STABLE` BRANCH FOR THE\r\nVERSION 1 DOCUMENTATION.\r\n\r\nIF YOU NEED COMPATIBILITY WITH OLDER VERSIONS OF NODEJS, PLEASE USE V1.0.6 WHICH IS \r\nCOMPATIBLE BACK TO NODE 0.4. `npm i lorem-ipsum@1.0.6`\r\n\r\n## Installation\r\n\r\n```\r\nnpm i lorem-ipsum\r\n```\r\n\r\n## Using the Class\r\n\r\nThe class is the recommended way to use `lorem-ipsum` since version 2.\r\nIt makes it simpler to generate text using the same options.\r\n\r\n```\r\nimport { LoremIpsum } from \"lorem-ipsum\";\r\n// const LoremIpsum = require(\"lorem-ipsum\").LoremIpsum;\r\n\r\nconst lorem = new LoremIpsum({\r\n  sentencesPerParagraph: {\r\n    max: 8,\r\n    min: 4\r\n  },\r\n  wordsPerSentence: {\r\n    max: 16,\r\n    min: 4\r\n  }\r\n});\r\n\r\nlorem.generateWords(1);\r\nlorem.generateSentences(5);\r\nlorem.generateParagraphs(7);\r\n```\r\n\r\n## Using the Function\r\n\r\n`lorem-ipsum` version 2 exports a function that is backwards-\r\ncompatible with the default function exported by `lorem-ipsum` version\r\n1. Users of version 1 should be able to upgrade to version 2 without \r\nany issue; they can just continue using this library as they did before.\r\n\r\n```\r\nimport { loremIpsum } from \"lorem-ipsum\";\r\n// const loremIpsum = require(\"lorem-ipsum\").loremIpsum;\r\n\r\nloremIpsum(); // generates one sentence\r\n```\r\n\r\nLike before, you can pass in a number of options to customize the output.\r\nThe example below shows the default options.\r\n\r\n```\r\nimport { loremIpsum } from \"lorem-ipsum\";\r\n\r\nloremIpsum({\r\n  count: 1,                // Number of \"words\", \"sentences\", or \"paragraphs\"\r\n  format: \"plain\",         // \"plain\" or \"html\"\r\n  paragraphLowerBound: 3,  // Min. number of sentences per paragraph.\r\n  paragraphUpperBound: 7,  // Max. number of sentences per paragarph.\r\n  random: Math.random,     // A PRNG function\r\n  sentenceLowerBound: 5,   // Min. number of words per sentence.\r\n  sentenceUpperBound: 15,  // Max. number of words per sentence.\r\n  suffix: \"\\n\",            // Line ending, defaults to \"\\n\" or \"\\r\\n\" (win32)\r\n  units: \"sentences\",      // paragraph(s), \"sentence(s)\", or \"word(s)\"\r\n  words: [\"ad\", ...]       // Array of words to draw from\r\n})\r\n```\r\n\r\n## Using the CLI\r\n\r\n`lorem-ipsum` includes a command line interface (CLI) program for generating \r\npassages of lorem ipsum text directly from your terminal. This CLI program \r\nis compatible with Mac OSX, Windows, and Linux. On Linux you will need to \r\ninstall xclip. On Ubuntu: `apt-get install xclip`.\r\n\r\nSimply install the module globally to take advantage of this feature.\r\n\r\n```\r\nnpm i -g lorem-ipsum\r\n```\r\n\r\nExecute the statement `lorem-ipsum [count] [units]` from your terminal to\r\ngenerate a passage of lorem ipsum text. You can additional arguments to\r\nthe program.\r\n\r\n```\r\nlorem-ipsum --version\r\n# Displays the version number\r\n\r\nlorem-ipsum --help\r\n# Displays the help documentation\r\n\r\nlorem-ipsum 1 word\r\n# Prints one word\r\n\r\nlorem-ipsum 2 words\r\n# Prints two words\r\n\r\nlorem-ipsum 1 sentence\r\n# Prints one sentence\r\n\r\nlorem-ipsum 2 sentences\r\n# Prints two sentences\r\n\r\nlorem-ipsum 1 paragraph\r\n# Prints one paragraph\r\n\r\nlorem-ipsum 2 paragraphs\r\n# Prints two paragraphs\r\n\r\nlorem-ipsum 2 paragraphs --copy\r\n# Prints two pargraphs and copies it to your clipboard\r\n\r\nlorem-ipsum 2 pargraphs --format html\r\n# Prints two paragraphs in HTML format\r\n\r\nlorem-ipsum 2 paragraphs --format html --copy\r\n# Prints two paragraphs in HTML format and copies it to your clipboard.\r\n```\r\n\r\nUprading from version 1.x? The `--count` and `--units` options have been \r\ndropped in favor of the natural language interface shown in the examples\r\nabove.\r\n\r\n## License\r\n\r\nCopyright (c) 2012-2022 Nickolas Kenyeres <nickolas@knicklabs.com>\r\n\r\nPermission to use, copy, modify, and/or distribute this software for any\r\npurpose with or without fee is hereby granted, provided that the above\r\ncopyright notice and this permission notice appear in all copies.\r\n\r\nTHE SOFTWARE IS PROVIDED \"AS IS\" AND THE AUTHOR DISCLAIMS ALL WARRANTIES\r\nWITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF\r\nMERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR\r\nANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES\r\nWHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN\r\nACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF\r\nOR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE."},"npm":{"downloads":[{"from":"2022-07-07T00:00:00.000Z","to":"2022-07-08T00:00:00.000Z","count":19508},{"from":"2022-07-01T00:00:00.000Z","to":"2022-07-08T00:00:00.000Z","count":95922},{"from":"2022-06-08T00:00:00.000Z","to":"2022-07-08T00:00:00.000Z","count":403151},{"from":"2022-04-09T00:00:00.000Z","to":"2022-07-08T00:00:00.000Z","count":2471555},{"from":"2022-01-09T00:00:00.000Z","to":"2022-07-08T00:00:00.000Z","count":3752447},{"from":"2021-07-08T00:00:00.000Z","to":"2022-07-08T00:00:00.000Z","count":6382075}],"starsCount":14},"github":{"homepage":"https://www.npmjs.com/package/lorem-ipsum","starsCount":234,"forksCount":38,"subscribersCount":2,"issues":{"count":75,"openCount":1,"distribution":{"3600":25,"10800":1,"32400":1,"97200":2,"291600":4,"874800":6,"2624400":6,"7873200":9,"23619600":12,"70858800":6,"212576400":3},"isDisabled":false},"contributors":[{"username":"FlorianWendelborn","commitsCount":1},{"username":"dubzzz","commitsCount":2},{"username":"lil5","commitsCount":1},{"username":"knicklabs","commitsCount":176},{"username":"rart","commitsCount":1},{"username":"marcobiedermann","commitsCount":7},{"username":"mgrandrath","commitsCount":1},{"username":"dependabot[bot]","commitsCount":12},{"username":"bbenoist","commitsCount":2},{"username":"jaredly","commitsCount":1},{"username":"sneakertack","commitsCount":1},{"username":"beenotung","commitsCount":2}],"commits":[{"from":"2022-07-01T00:00:00.000Z","to":"2022-07-08T00:00:00.000Z","count":0},{"from":"2022-06-08T00:00:00.000Z","to":"2022-07-08T00:00:00.000Z","count":0},{"from":"2022-04-09T00:00:00.000Z","to":"2022-07-08T00:00:00.000Z","count":18},{"from":"2022-01-09T00:00:00.000Z","to":"2022-07-08T00:00:00.000Z","count":18},{"from":"2021-07-08T00:00:00.000Z","to":"2022-07-08T00:00:00.000Z","count":34}],"statuses":[{"context":"coverage/coveralls","state":"success"},{"context":"Coveralls - windows-latest-node-","state":"failure"},{"context":"Coveralls - ubuntu-latest-node-","state":"failure"}]},"source":{"files":{"readmeSize":5381,"testsSize":19131,"hasNpmIgnore":true},"badges":[{"urls":{"original":"https://coveralls.io/repos/github/knicklabs/lorem-ipsum.js/badge.svg?branch=main","service":"https://coveralls.io/repos/github/knicklabs/lorem-ipsum.js/badge.svg?branch=main","shields":"https://img.shields.io/coveralls/knicklabs/lorem-ipsum.js/main.svg","content":"https://img.shields.io/coveralls/knicklabs/lorem-ipsum.js/main.json"},"info":{"service":"coveralls","type":"coverage","modifiers":{"branch":"main"}}}],"linters":["prettier","tslint"],"coverage":0.99}},"evaluation":{"quality":{"carefulness":0.9199999999999999,"tests":0.8318333333333333,"health":1,"branding":0.15},"popularity":{"communityInterest":300,"downloadsCount":823851.6666666666,"downloadsAcceleration":-171.24488203957435,"dependentsCount":0},"maintenance":{"releasesFrequency":1,"commitsFrequency":0.9,"openIssues":1,"issuesDistribution":0.9}},"score":{"final":0.7203976917825174,"detail":{"quality":0.9541551166335019,"popularity":0.2404704397027992,"maintenance":0.9999614368471064}}}