blork - npm Package Compare versions

Comparing version 9.0.0 to 9.0.1

CONTRIBUTING.md

@@ -18,10 +18,12 @@ # Blork: Contributing
 
-Blork is written in Javascript, uses ESLint for linting, Prettier for code style, and Jest for unit testing. Blork is deployed to NPM through Travis CI whenever a new tagged release is created on GitHub. TravisCI automatically checks (and rejects) pull requests that fail the unit tests or are improperly linted.
+Blork is written in Javascript, uses ESLint for linting, Prettier for code style, and Jest for unit testing. Blork is deployed to NPM through Travis CI whenever a new tagged release is created on GitHub. 
 
-### 1. Clone and install (Git and npm)
+TravisCI automatically checks (and rejects) pull requests that fail the unit tests or are improperly linted. If the tests pass the code is deployed to [npm](https://www.npmjs.com/) with [semantic-release](https://github.com/semantic-release/semantic-release). Version numbers are automatically bumped based on commit messages following the [Conventional Commits](https://conventionalcommits.org) format.
 
+### 1. Clone and install (Git and yarn)
+
 ```sh
 git clone https://github.com/dhoulb/blork.git
 cd blork
-npm install
+yarn install
 ```
@@ -38,6 +40,6 @@
 ```sh
-npm run fix
+yarn eslint:fix
 ```
 
-Blork is linted using ESLint and code formatting is done with Prettier. ESLint will fix as many issues as it can, but any leftover linting should be fixed. Configuring your editor to report linting issues as-you-type and automatically run `eslint --fix` or `npm run fix` on save makes this all a lot easier!
+Blork is linted using ESLint and code formatting is done with Prettier. ESLint will fix as many issues as it can, but any leftover linting should be fixed. Configuring your editor to report linting issues as-you-type and run `eslint --fix` on save makes this all a lot easier!
 
@@ -49,8 +51,8 @@ All code is reformatted using Prettier, so write using whatever style you like leave Prettier to fix it.
 ```sh
-npm test
+yarn test
 ```
 
-Tests are written in Jest and are in the `test/` directory. Run the test suite using `npm test` on the command line, which will lint, style, and test the code.
+Tests are written in Jest and are in the `test/` directory. Run the test suite using `yarn test` on the command line, which will lint, style, and test the code.
 
-Code coverage must be 100% or `npm test` will also fail (this means every file, function, and branch of your code must be covered by a unit test.)
+Code coverage must be 100% or `yarn test` will also fail (this means every file, function, and branch of your code must be covered by a unit test.)
 
@@ -61,6 +63,8 @@ ### Commit (Git)
 git add .
-git commit -m "My changes"
+git commit -m "feat: My changes"
 git push origin
 ```
 
-Jest unit tests, ESLint, and Prettier run as a precommit hook (using [Husky](https://www.npmjs.com/package/husky)) so any Git commit you try to do will fail if code isn't linted correctly or fails tests. 
+All commits on the master branch are automatically versioned and deployed with [semantic-release](https://github.com/semantic-release/semantic-release) so commit messages must follow the [Conventional Commits](https://conventionalcommits.org) format. This is enforced on commit by [commitlint](https://github.com/marionebl/commitlint).
+
+commitlint, Jest, ESLint, and Prettier are run as a precommit hook (via [Husky](https://www.npmjs.com/package/husky)) so commits will fail if these don't pass.

lib/modifiers/modifiers.js

@@ -440,3 +440,7 @@ const debug = require("../helpers/debug");
 				? parseInt(matches[2], 10)
-				: matches[4] ? parseInt(matches[4], 10) : matches[5] ? parseInt(matches[5]) : null;
+				: matches[4]
+					? parseInt(matches[4], 10)
+					: matches[5]
+						? parseInt(matches[5])
+						: null;
 
@@ -443,0 +447,0 @@ // Create a length checker for this type.

package.json

 {
 	"name": "blork",
 	"description": "Blork! Mini runtime type checking in Javascript",
-	"version": "9.0.0",
+	"version": "9.0.1",
 	"license": "0BSD",
@@ -9,3 +9,6 @@ "author": "Dave Houlbrooke <[e-mail]>",
 	"engineStrict": true,
-	"engines": { "node": ">=8.0.0" },
+	"engines": {
+		"node": ">=8.0.0",
+		"yarn": ">=1.0.0"
+	},
 	"repository": {
@@ -17,8 +20,10 @@ "type": "git",
 	"devDependencies": {
-		"eslint": "^4.17.0",
-		"eslint-config-prettier": "^2.9.0",
-		"eslint-plugin-prettier": "^2.6.0",
-		"husky": "^0.14.3",
-		"jest": "^22.1.4",
-		"prettier": "^1.10.2"
+		"commitlint": "^7.2.1",
+		"eslint": "^5.7.0",
+		"eslint-config-prettier": "^3.1.0",
+		"eslint-plugin-prettier": "^3.0.0",
+		"husky": "^1.1.2",
+		"jest": "^23.6.0",
+		"prettier": "^1.10.2",
+		"semantic-release": "^15.10.5"
 	},
@@ -28,8 +33,12 @@ "scripts": {
 		"jest": "jest --coverage",
-		"test": "jest --coverage",
 		"lint": "eslint ./",
 		"fix": "eslint --fix ./",
-		"pretest": "npm run lint",
-		"prepush": "npm run test"
+		"test": "yarn lint && yarn jest"
 	},
+	"husky": {
+		"hooks": {
+			"commit-msg": "commitlint -E HUSKY_GIT_PARAMS",
+			"pre-commit": "yarn test"
+		}
+	},
 	"eslintConfig": {
@@ -81,2 +90,3 @@ "parserOptions": {
 	"jest": {
+		"testURL": "http://localhost",
 		"collectCoverage": true,
@@ -83,0 +93,0 @@ "coverageThreshold": {

README.md

 # Blork! Mini runtime type checking in Javascript
 
-[![Build Status](https://travis-ci.org/dhoulb/blork.svg?branch=master)](https://travis-ci.org/dhoulb/blork)
+[![Travis CI](https://travis-ci.org/dhoulb/blork.svg?branch=master)](https://travis-ci.org/dhoulb/blork)
+[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg?style=flat)](https://github.com/semantic-release/semantic-release)
+[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg)](https://conventionalcommits.org)
 [![Prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://github.com/prettier/prettier)
@@ -14,3 +16,3 @@ [![npm](https://img.shields.io/npm/dm/blork.svg)](https://www.npmjs.com/package/blork)
 ```sh
-npm install blork
+yarn install blork
 ```
@@ -17,0 +19,0 @@

test/checkers/checkers.test.js

@@ -79,4 +79,4 @@ const checkers = require("../../lib/checkers/checkers");
 		expect(mockCheck({ "0": "abc", length: 1 }, "arraylike")).toBe(undefined);
-		expect(mockCheck(arguments, "arguments")).toBe(undefined);
-		expect(mockCheck(arguments, "args")).toBe(undefined);
+		expect(mockCheck({ length: 0 }, "arguments")).toBe(undefined);
+		expect(mockCheck({ length: 0 }, "args")).toBe(undefined);
 		expect(mockCheck(new Date(), "date")).toBe(undefined);
@@ -83,0 +83,0 @@ expect(mockCheck(new Date(2080, 0, 1), "future")).toBe(undefined);

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

Improved metrics

Total package byte prevSize

447388

increased by173.15%

Number of package files

59

increased by1.72%

Lines of code

3113

increased by0.13%

Number of lines in readme file

632

increased by0.32%

Worsened metrics

Dev dependency count

8

increased by33.33%

No dependency changes