arrayiffy-if-string - npm Package Compare versions

Comparing version 1.0.2 to 3.0.0

changelog.md

@@ -7,4 +7,11 @@ # Change Log
 
+## [2.0.0] - 2017-11-22
+### Changed
+- ✨ Rewrote in ES modules, now serving UMD, Common JS and native ES modules builds. Bumping major just in case.
+- ✨ Removed JS Standard and switched to raw ESLint on `airbnb-base` preset, with no-semicolon override.
+
 ## 1.0.0 - 2017-05-22
 ### New
-- First public release
+- ✨ First public release
+
+[2.0.0]: https://github.com/codsen/arrayiffy-if-string/compare/v1.0.0...v2.0.0

package.json

 {
   "name": "arrayiffy-if-string",
-  "version": "1.0.2",
+  "version": "3.0.0",
   "description": "Put non-empty strings into arrays, turn empty-ones into empty arrays. Bypass everything else.",
-  "main": "index.js",
+  "license": "MIT",
+  "engines": {
+    "node": ">=4",
+    "npm": ">=5",
+    "yarn": ">=1"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/codsen/arrayiffy-if-string.git"
+  },
+  "bugs": {
+    "url": "https://github.com/codsen/arrayiffy-if-string/issues"
+  },
+  "homepage": "https://github.com/codsen/arrayiffy-if-string#readme",
+  "author": {
+    "email": "[e-mail]",
+    "name": "Roy Revelt",
+    "url": "codsen.com"
+  },
+  "main": "dist/arrayiffy-if-string.cjs.js",
+  "module": "dist/arrayiffy-if-string.esm.js",
+  "browser": "dist/arrayiffy-if-string.umd.js",
   "scripts": {
+    "build": "rollup -c",
     "coverage": "nyc report --reporter=text-lcov | coveralls",
-    "precommit": "npm test && doctoc readme.md",
-    "test": "standard && nyc --reporter=html --reporter=text ava",
-    "watch": "nodemon --quiet --watch . --exec npm run test"
+    "dev": "rollup -c -w",
+    "precommit": "npm test",
+    "prepare": "npm run build",
+    "pretest": "npm run build",
+    "test": "./node_modules/.bin/eslint src/*.js test/*.js && nyc --reporter=html --reporter=text ava"
   },
-  "repository": "codsen/arrayiffy-if-string",
+  "ava": {
+    "verbose": true
+  },
+  "clinton": {
+    "rules": {
+      "xo": 0
+    }
+  },
   "keywords": [
@@ -21,27 +52,90 @@ "arrayiffy",
   ],
-  "author": {
-    "name": "Roy Revelt",
-    "email": "[e-mail]",
-    "url": "codsen.com"
+  "lector": {
+    "babelrc": {
+      "override": false,
+      "set": false
+    },
+    "badges": {
+      "contributors": true,
+      "cov": true,
+      "deps": true,
+      "deps2d": true,
+      "dev": true,
+      "downloads": true,
+      "license": true,
+      "node": true,
+      "npm": true,
+      "overall": true,
+      "runkit": true,
+      "travis": true,
+      "vulnerabilities": true
+    },
+    "contribution_types": [
+      "Answering Questions",
+      "Blogposts",
+      "Bug reports*",
+      "Code*",
+      "Documentation*",
+      "Design",
+      "Examples",
+      "Event Organizers",
+      "Financial Support",
+      "Funding/Grant Finders",
+      "Ideas & Planning",
+      "Infrastructure (Hosting, Build-Tools, etc)",
+      "Plugin/utility libraries",
+      "Reviewed Pull Requests",
+      "Tools",
+      "Translation",
+      "Tests*",
+      "Tutorials",
+      "Talks",
+      "Videos"
+    ],
+    "contributors": [
+      {
+        "contribution": [
+          "Code",
+          "Documentation",
+          "Tests"
+        ],
+        "username": "revelt"
+      }
+    ],
+    "eslintrc": {
+      "add": [],
+      "remove": []
+    },
+    "header": {
+      "dontQuoteDescription": false,
+      "rightFloatedBadge": ""
+    },
+    "licence": {
+      "extras": []
+    },
+    "various": {
+      "back_to_top": {
+        "enabled": true,
+        "label": ""
+      }
+    }
   },
-  "license": "MIT",
-  "bugs": {
-    "url": "https://github.com/codsen/arrayiffy-if-string/issues"
-  },
-  "homepage": "https://github.com/codsen/arrayiffy-if-string#readme",
   "dependencies": {},
   "devDependencies": {
     "ava": "*",
+    "babel-preset-env": "^1.6.1",
     "coveralls": "*",
+    "eslint": "^4.11.0",
+    "eslint-config-airbnb-base": "^12.1.0",
+    "eslint-plugin-ava": "^4.2.2",
+    "eslint-plugin-import": "^2.8.0",
     "husky": "*",
-    "nodemon": "*",
     "nyc": "*",
-    "standard": "^10.0.2"
-  },
-  "ava": {
-    "verbose": false
-  },
-  "engines": {
-    "node": ">=4"
+    "rollup": "^0.51.8",
+    "rollup-plugin-babel": "^3.0.2",
+    "rollup-plugin-commonjs": "^8.2.6",
+    "rollup-plugin-node-resolve": "^3.0.0",
+    "rollup-plugin-uglify": "^2.0.1",
+    "uglify-es": "^3.1.10"
   }
 }

readme.md

 # arrayiffy-if-string
 
-<a href="https://standardjs.com" style="float: right; padding: 0 0 20px 20px;"><img src="https://cdn.rawgit.com/feross/standard/master/sticker.svg" alt="Standard JavaScript" width="100" align="right"></a>
+<a href="https://github.com/revelt/eslint-on-airbnb-base-badge" style="float: right; padding: 0 0 20px 20px;"><img src="https://cdn.rawgit.com/revelt/eslint-on-airbnb-base-badge/0c3e46c9/lint-badge.svg" alt="ESLint on airbnb-base with caveats" width="100" align="right"></a>
 
 > Put non-empty strings into arrays, turn empty-ones into empty arrays. Bypass everything else.
 
+[![Minimum Node version required][node-img]][node-url]
+[![Link to npm page][npm-img]][npm-url]
 [![Build Status][travis-img]][travis-url]
-[![Coverage Status][cov-img]][cov-url]
-[![bitHound Score][bithound-img]][bithound-url]
+[![Coverage][cov-img]][cov-url]
+[![bitHound Overall Score][overall-img]][overall-url]
 [![bitHound Dependencies][deps-img]][deps-url]
+[![View dependencies as 2D chart][deps2d-img]][deps2d-url]
 [![bitHound Dev Dependencies][dev-img]][dev-url]
+[![Known Vulnerabilities][vulnerabilities-img]][vulnerabilities-url]
 [![Downloads/Month][downloads-img]][downloads-url]
+[![Test in browser][runkit-img]][runkit-url]
+[![MIT License][license-img]][license-url]
 
@@ -30,5 +36,22 @@ ## Table of Contents
 ```bash
-$ npm i -S arrayiffy-if-string
+$ npm i arrayiffy-if-string
 ```
 
+```js
+// consume as ES module:
+import arrayiffy from 'arrayiffy-if-string'
+// or as CommonJS require:
+const arrayiffy = require('require arrayiffy-if-string')
+```
+
+Here's what you'll get:
+
+Type            | Key in `package.json` | Path  | Size
+----------------|-----------------------|-------|--------
+Main export - **CommonJS version**, transpiled, contains `require` and `module.exports` | `main`                | `dist/arrayiffy-if-string.cjs.js` | 303&nbsp;B
+**ES module** build that Webpack/Rollup understands. Untranspiled ES6 code with `import`/`export`. | `module`              | `dist/arrayiffy-if-string.esm.js` | 286&nbsp;B
+**UMD build** for browsers, transpiled, minified, containing `iife`'s and has all dependencies baked-in | `browser`            | `dist/arrayiffy-if-string.umd.js` | 257&nbsp;B
+
+**[⬆ &nbsp;back to top](#)**
+
 ## Idea
@@ -63,48 +86,58 @@
 
+**[⬆ &nbsp;back to top](#)**
+
 ## Contributing
 
-All contributions are welcome. Please stick to [Standard JavaScript](https://standardjs.com) notation and supplement the `test.js` with new unit tests covering your feature(s).
+Hi! 99% of people in the society are passive - consumers. They wait for others to take action, they prefer to blend in. The remaining 1% are proactive citizens who will _do_ something rather than _wait_. If you are one of that 1%, you're in luck because I am the same and _together_ we can make something happen.
 
-If you see anything incorrect whatsoever, do [raise an issue](https://github.com/codsen/arrayiffy-if-string/issues). If you file a pull request, I'll do my best to help you to get it merged as soon as possible. If you have any comments on the code, including ideas how to improve something, don't hesitate to contact me by email.
+* If you **want a new feature** in this package or you would like to change some of its functionality, raise an [issue on this repo](https://github.com/codsen/arrayiffy-if-string/issues). Also, you can [email me](mailto:[e-mail]). Just let it out.
 
+* If you tried to use this library but it misbehaves, or **you need an advice setting it up**, and its readme doesn't make sense, just document it and raise an [issue on this repo](https://github.com/codsen/arrayiffy-if-string/issues). Alternatively, you can [email me](mailto:[e-mail]).
+
+* If you don't like the code in here and would like to **give an advice** about how something could be done better, please do. Same drill - [GitHub issues](https://github.com/codsen/arrayiffy-if-string/issues) or [email](mailto:[e-mail]), your choice.
+
+* If you would like to **add or change some features**, just fork it, hack away, and file a pull request. I'll do my best to merge it quickly. Code style is `airbnb`, only without semicolons. If you use a good code editor, it will pick up the established ESLint setup.
+
+**[⬆ &nbsp;back to top](#)**
+
 ## Licence
 
-> MIT License (MIT)
+MIT License (MIT)
 
-> Copyright (c) 2017 Codsen Ltd, Roy Revelt
+Copyright © 2017 Codsen Ltd, Roy Revelt
 
-> 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:
+[node-img]: https://img.shields.io/node/v/arrayiffy-if-string.svg?style=flat-square&label=works%20on%20node
+[node-url]: https://www.npmjs.com/package/arrayiffy-if-string
 
-> The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
+[npm-img]: https://img.shields.io/npm/v/arrayiffy-if-string.svg?style=flat-square&label=release
+[npm-url]: https://www.npmjs.com/package/arrayiffy-if-string
 
-> 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.
-
-[travis-img]: https://travis-ci.org/codsen/arrayiffy-if-string.svg?branch=master
+[travis-img]: https://img.shields.io/travis/codsen/arrayiffy-if-string.svg?style=flat-square
 [travis-url]: https://travis-ci.org/codsen/arrayiffy-if-string
 
-[cov-img]: https://coveralls.io/repos/github/codsen/arrayiffy-if-string/badge.svg?branch=master
+[cov-img]: https://coveralls.io/repos/github/codsen/arrayiffy-if-string/badge.svg?style=flat-square?branch=master
 [cov-url]: https://coveralls.io/github/codsen/arrayiffy-if-string?branch=master
 
-[bithound-img]: https://www.bithound.io/github/codsen/arrayiffy-if-string/badges/score.svg
-[bithound-url]: https://www.bithound.io/github/codsen/arrayiffy-if-string
+[overall-img]: https://img.shields.io/bithound/code/github/codsen/arrayiffy-if-string.svg?style=flat-square
+[overall-url]: https://www.bithound.io/github/codsen/arrayiffy-if-string
 
-[deps-img]: https://www.bithound.io/github/codsen/arrayiffy-if-string/badges/dependencies.svg
+[deps-img]: https://img.shields.io/bithound/dependencies/github/codsen/arrayiffy-if-string.svg?style=flat-square
 [deps-url]: https://www.bithound.io/github/codsen/arrayiffy-if-string/master/dependencies/npm
 
-[dev-img]: https://www.bithound.io/github/codsen/arrayiffy-if-string/badges/devDependencies.svg
+[deps2d-img]: https://img.shields.io/badge/deps%20in%202D-see_here-08f0fd.svg?style=flat-square
+[deps2d-url]: http://npm.anvaka.com/#/view/2d/arrayiffy-if-string
+
+[dev-img]: https://img.shields.io/bithound/devDependencies/github/codsen/arrayiffy-if-string.svg?style=flat-square
 [dev-url]: https://www.bithound.io/github/codsen/arrayiffy-if-string/master/dependencies/npm
 
-[downloads-img]: https://img.shields.io/npm/dm/arrayiffy-if-string.svg
-[downloads-url]: https://www.npmjs.com/package/arrayiffy-if-string
+[vulnerabilities-img]: https://snyk.io/test/github/codsen/arrayiffy-if-string/badge.svg?style=flat-square
+[vulnerabilities-url]: https://snyk.io/test/github/codsen/arrayiffy-if-string
+
+[downloads-img]: https://img.shields.io/npm/dm/arrayiffy-if-string.svg?style=flat-square
+[downloads-url]: https://npmcharts.com/compare/arrayiffy-if-string
+
+[runkit-img]: https://img.shields.io/badge/runkit-test_in_browser-a853ff.svg?style=flat-square
+[runkit-url]: https://npm.runkit.com/arrayiffy-if-string
+
+[license-img]: https://img.shields.io/npm/l/arrayiffy-if-string.svg?style=flat-square
+[license-url]: https://github.com/codsen/arrayiffy-if-string/blob/master/license.md

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

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

No repository

Supply chain risk

Package does not have a linked source code repository. Without this field, a package will have no reference to the location of the source code use to generate the package.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

14651

increased by97.99%

Number of package files

10

increased by66.67%

Lines of code

115

increased by784.62%

Number of lines in readme file

142

increased by30.28%

Number of low supply chain risk alerts

0

decreased by-100%

Worsened metrics

Dev dependency count

15

increased by150%

Number of medium supply chain risk alerts

1

increased byInfinity%

No dependency changes