esbnb - npm Package Compare versions

Comparing version 1.1.0 to 1.1.1

CHANGELOG.md

 # CHANGELOG
 
+## 1.1.1 - delivery @12/06/2021
+
+- update dependencies
+- add github community files
+- update readme
+- add todo
+- update tests
+
 ## 1.1.0 - delivery @06/01/2020
@@ -4,0 +12,0 @@

package.json

 {
   "name": "esbnb",
-  "version": "1.1.0",
+  "version": "1.1.1",
   "author": "Adrien Valcke",
@@ -11,5 +11,5 @@ "description": "The ESLint with Airbnb configuration installer",
   "scripts": {
-    "lint": "eslint bin/",
-    "pretest": "npm run lint",
-    "test": "mocha -t 120000 test/*"
+    "test:lint": "eslint bin/",
+    "test:unit": "mocha -t 120000 test/*",
+    "test": "npm run test:lint && npm run test:unit"
   },
@@ -39,7 +39,7 @@ "repository": {
   "devDependencies": {
-    "chai": "4.2.0",
-    "eslint": "6.8.0",
-    "eslint-config-airbnb-base": "14.0.0",
-    "eslint-plugin-import": "2.19.1",
-    "mocha": "6.2.2"
+    "chai": "4.3.4",
+    "eslint": "7.28.0",
+    "eslint-config-airbnb-base": "14.2.1",
+    "eslint-plugin-import": "2.23.4",
+    "mocha": "9.0.0"
   },
@@ -46,0 +46,0 @@ "preferGlobal": true,

README.md

@@ -1,10 +0,20 @@
-# esbnb, the ESLint with Airbnb configuration installer
+<h1 align="center">esbnb<h1>
 
-## Requirements
+<p align="center">
+  The ESLint with Airbnb configuration installer.
+<p>
 
-- **OS**: macOS or linux
-- **engines**: node carbon with npm >=6.13.4
+# Table of Contents
+- [Installation](#installation)
+- [Technical information](#technical-information)
+  - [Node.js](#nodejs)
+  - [Tests](#tests)
+- [Usage](#usage)
+- [Code of Conduct](#code-of-conduct)
+- [Contributing](#contributing)
+- [Support](#support)
+- [Security](#security)
+- [License](#license)
 
-## Installation
-
+# Installation
 It is recommended to install *esbnb* globally.
@@ -14,12 +24,33 @@
 
-## Usage
+# Technical information
 
-ESLint can be installed with 3 configurations from Airbnb: *airbnb*, *airbnb-base* and *airbnb-base/legacy*.
+## Node.js
 
+- Language: JavaScript ES6/ES7
+- VM: Node.js >=8.17.0
+
+## Tests
+Command to run all tests:
+
+`npm test`
+
+### Linting
+ESLint with Airbnb base rules. See [Airbnb JavaScript Style Guide](https://github.com/airbnb/javascript).
+
+`npm run test:lint`
+
+### Unit
+Mocha and Chai.
+
+`npm run test:unit`
+
+# Usage
+
+ESLint can be installed with 3 configurations from Airbnb: `airbnb`, `airbnb-base` and `airbnb-base/legacy`.
+
 For more details on which packages are installed with ESlint see :
-- [ESLint with Airbnb config](https://www.npmjs.com/package/eslint-config-airbnb)
-- [ESLint with Airbnb base and legacy config](https://www.npmjs.com/package/eslint-config-airbnb-base)
+- [ESLint with Airbnb config](https://www.npmjs.com/package/eslint-config-airbnb);
+- [ESLint with Airbnb base and legacy config](https://www.npmjs.com/package/eslint-config-airbnb-base).
 
-#### Install ESLint with the Airbnb ESLint rules, including ECMAScript 6+ and React (default)
-
+## Install ESLint with the Airbnb ESLint rules, including ECMAScript 6+ and React (default)
 At the root of your project, run:
@@ -29,4 +60,3 @@
 
-#### Install ESLint with the Airbnb ESLint rules, including ECMAScript 6+ (base)
-
+## Install ESLint with the Airbnb ESLint rules, including ECMAScript 6+ (base)
 At the root of your project, run:
@@ -36,4 +66,3 @@
 
-#### Install ESLint with the Airbnb ESLint rules, including ECMAScript 5 and below (legacy)
-
+## Install ESLint with the Airbnb ESLint rules, including ECMAScript 5 and below (legacy)
 At the root of your project, run:
@@ -43,4 +72,3 @@
 
-#### Need basic help ?
-
+## Need basic help ?
 At the root of your project, run:
@@ -50,8 +78,6 @@
 
-
 ## Configuration
-
 No configuration are required from your own.
 
-*esbnb* install and automatically configure your `.eslintrc` file. It only adds the configuration name in the `extends` property. If some values were present that are not an Airbnb config name, the `extends` property will be an array with all these values plus the Airbnb one. If another Airbnb config is found, it will be replaced by the one being installed.
+*esbnb* installs and automatically configures your `.eslintrc` file. It only adds the configuration name in the `extends` property. If some values were present that are not an Airbnb config name, the `extends` property will be an array with all these values plus the Airbnb one. If another Airbnb config is found, it will be replaced by the one being installed.
 
@@ -102,24 +128,17 @@ Before any process, a copy of your `.eslintrc` is made in the case of something would go wrong. You'll find it in the *esbnb* package installed globally in the *configs* directory.
 
-## Contribution
+# Code of Conduct
+This project has a [Code of Conduct](.github/CODE_OF_CONDUCT.md). By interacting with this repository, organization, or community you agree to abide by its terms.
 
-Please feel free to contribute to this little tool. Here are some work in progress:
+# Contributing
+Please have a look at our [TODO](TODO.md) for any work in progress.
 
-- change the first arg to be `install` / `uninstall`
-- add a command `esbnb uninstall airbnbConfigName`
-- when running an installation and another airbnb config is found, this should first uninstall all the related packages properly and then install the specified packages
+Please take also a moment to read our [Contributing Guidelines](.github/CONTRIBUTING.md) if you haven't yet done so.
 
-## Test
+# Support
+Please see our [Support](.github/SUPPORT.md) page if you have any questions or for any help needed.
 
-Run `npm test` to
-- lint with ESLint (*airbnb-base* config),
-- run mocha unit tests with Chai.
+# Security
+For any security concerns or issues, please visit our [Security Policy](.github/SECURITY.md) page.
 
-## Licence
-
-The MIT License (MIT) Copyright © 2019 Adrien Valcke
-
-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 NON INFRINGEMENT. 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.
+# License
+[MIT](LICENSE.md).

test/index.js

@@ -25,2 +25,3 @@ /**
 const packageJson = path.join(__dirname, 'package.json');
+const packageLock = path.join(__dirname, 'package-lock.json');
 
@@ -187,2 +188,3 @@ const packageConfig = {
     fs.unlinkSync(packageJson);
+    fs.unlinkSync(packageLock);
   } catch (e) {
@@ -787,4 +789,5 @@ // do nothing
       removeNodeModules();
+      removePackageJson();
     });
   });
 });

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

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

Explicitly Unlicensed Item

License

(Experimental) Something was found which is explicitly marked as unlicensed.

Found 1 instance in 1 package

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

55995

increased by38.91%

Number of package files

16

increased by100%

Number of high license alerts

0

decreased by-100%

License quality

100

increased byInfinity%

Lines of code

875

increased by0.34%

Number of lines in readme file

139

increased by15.83%

Number of medium supply chain risk alerts

2

decreased by-33.33%

No dependency changes