validate-polish - npm Package Compare versions

Comparing version 1.1.1 to 2.0.0

package.json

 {
-  "name": "validate-polish",
-  "version": "1.1.1",
-  "description": "Utility library for validation of PESEL, NIP, REGON, identity card etc. Aimed at mostly at Polish enviroment. [Polish] Walidacja numerów pesel, nip, regon, dowodu osobistego.",
-  "main": "build/main/index.js",
-  "typings": "build/main/index.d.ts",
-  "module": "build/module/index.js",
-  "repository": "https://github.com/radarsu/validate-polish",
-  "license": "MIT",
-  "keywords": [],
-  "scripts": {
-    "build:main": "tsc -p tsconfig.json",
-    "build:module": "tsc -p tsconfig.module.json",
-    "build": "run-s clean && run-p build:*",
-    "clean": "trash build test",
-    "cov:check": "nyc report && nyc check-coverage --lines 100 --functions 100 --branches 100",
-    "cov:html": "nyc report --reporter=html",
-    "cov:send": "nyc report --reporter=lcov > coverage.lcov && codecov",
-    "cov": "run-s build test:unit cov:html && opn coverage/index.html",
-    "doc:html": "typedoc src/ --target ES6 --mode file --out build/docs",
-    "doc:json": "typedoc src/ --target ES6 --mode file --json build/docs/typedoc.json",
-    "doc:publish": "gh-pages -m \"[ci skip] Updates\" -d build/docs",
-    "doc": "run-s doc:html && opn build/docs/index.html",
-    "fix:prettier": "prettier \"src/**/*.ts\" --write",
-    "fix:tslint": "tslint --fix --project .",
-    "fix": "run-s fix:*",
-    "info": "npm-scripts-info",
-    "reset": "git clean -dfx && git reset --hard && npm i",
-    "test:lint": "tslint --project . && prettier \"src/**/*.ts\" --list-different",
-    "test:unit": "nyc --silent ava",
-    "test": "run-s build test:*",
-    "version": "standard-version",
-    "watch": "run-s clean build:main && run-p \"build:main -- -w\" \"test:unit -- --watch\"",
-    "all": "run-s reset test cov:check doc:html",
-    "prepare-release": "run-s all version doc:publish"
-  },
-  "scripts-info": {
-    "info": "Display information about the package scripts",
-    "build": "Clean and rebuild the project",
-    "fix": "Try to automatically fix any linting problems",
-    "test": "Lint and unit test the project",
-    "watch": "Watch and rebuild the project on save, then rerun relevant tests",
-    "cov": "Rebuild, run tests, then create and open the coverage report",
-    "doc": "Generate HTML API documentation and open it in a browser",
-    "doc:json": "Generate API documentation in typedoc JSON format",
-    "version": "Bump package.json version, update CHANGELOG.md, tag release",
-    "reset": "Delete all untracked files and reset the repo to the last commit",
-    "prepare-release": "One-step: clean, build, test, publish docs, and prep a release"
-  },
-  "engines": {
-    "node": ">=8.9"
-  },
-  "dependencies": {},
-  "devDependencies": {
-    "@types/inquirer": "0.0.43",
-    "@types/uuid": "^3.4.4",
-    "ava": "1.0.0-beta.7",
-    "codecov": "^3.1.0",
-    "cz-conventional-changelog": "^2.1.0",
-    "gh-pages": "^2.0.0",
-    "npm-run-all": "^4.1.3",
-    "nyc": "^13.0.1",
-    "opn-cli": "^3.1.0",
-    "prettier": "^1.14.3",
-    "standard-version": "^4.4.0",
-    "trash-cli": "^1.4.0",
-    "tslint": "^5.11.0",
-    "tslint-config-prettier": "^1.15.0",
-    "tslint-immutable": "^4.7.0",
-    "typedoc": "^0.13.0",
-    "typescript": "^3.0.3"
-  },
-  "ava": {
-    "failFast": true,
-    "files": [
-      "build/main/**/*.spec.js"
-    ],
-    "sources": [
-      "build/main/**/*.js"
-    ]
-  },
-  "config": {
-    "commitizen": {
-      "path": "cz-conventional-changelog"
-    }
-  },
-  "prettier": {
-    "singleQuote": true
-  },
-  "nyc": {
-    "exclude": [
-      "**/*.spec.js"
-    ]
-  }
+	"name": "validate-polish",
+	"version": "2.0.0",
+	"description": "Utility library for validation of PESEL, NIP, REGON, identity card etc. Aimed at mostly at Polish enviroment. [Polish] Walidacja numerów pesel, nip, regon, dowodu osobistego.",
+	"keywords": [
+		"pesel",
+		"nip",
+		"regon",
+		"walidacja",
+		"validation",
+		"identity-card",
+		"polish"
+	],
+	"license": "GPL-3.0",
+	"files": [
+		"dist"
+	],
+	"author": "Artur Kurowski <[e-mail]>",
+	"homepage": "https://github.com/radarsu/validate-polish#readme",
+	"main": "dist/index.js",
+	"types": "dist/index.d.ts",
+	"devDependencies": {
+		"@radrat-scripts/package": "0.0.79-14",
+		"@radrat-scripts/readme": "0.0.79-14",
+		"@radrat/cli": "0.0.79-15",
+		"@types/jest": "^26.0.13",
+		"@types/node": "^14.10.0",
+		"jest": "^26.4.2",
+		"ts-jest": "^26.3.0",
+		"typescript": "^4.0.2"
+	}
 }

README.md

 <p align="center">
-    <a href="https://github.com/radarsu/validate-polish/" target="blank"><img src="https://raw.githubusercontent.com/radarsu/validate-polish/master/assets/logo.png" alt="validate-polish" /></a><br/>
-    <strong>Simple validation of PESEL, NIP, REGON, identity card.</strong>
+    <h1>validate-polish</h1>
+    <div>Utility library for validation of PESEL, NIP, REGON, identity card etc. Aimed at mostly at Polish enviroment. [Polish] Walidacja numerów pesel, nip, regon, dowodu osobistego.</div>
 </p>
 
-<p align="center">
-<a href="https://github.com/Microsoft/TypeScript" target="blank">TypeScript</a> utility for Polish developers.<br/>
-</p>
+## Table of contents
 
-<p align="center">
-	<a href="https://www.npmjs.com/package/validate-polish" target="_blank" alt="npm validate-polish"><img src="https://img.shields.io/npm/v/validate-polish.svg" alt="npm" /></a>
-	<img src="https://img.shields.io/github/license/radarsu/validate-polish.svg" />
-	<img src="https://img.shields.io/github/stars/radarsu/validate-polish.svg" />
-	<a href="https://twitter.com/radarsujs"><img src="https://img.shields.io/twitter/url/https/github.com/radarsu/validate-polish.svg?style=social" /></a>
-</p>
+1. [Getting Started](#getting-started)
 
-## Description
+2. [Usage](#usage)
 
-Utility library for validation of PESEL, NIP, REGON, identity card etc. Aimed at mostly at Polish enviroment. [Polish] Walidacja numerów pesel, nip, regon, dowodu osobistego.
+3. [Features](#features)
 
-## Installation
 
-```sh
-npm i validate-polish
-```
 
-## Features
+## Getting Started
+`npm i validate-polish`
 
-- <strong>Fast, lightweight, no dependencies</strong> required.
-- <strong>PESEL</strong> validation.
-- <strong>NIP</strong> validation.
-- <strong>REGON</strong> validation.
-- <strong>Identity card</strong> ([Polish] <strong>dowód osobisty</strong>) validation.
 
@@ -55,1 +40,10 @@ ## Usage
 ```
+
+
+## Features
+-   **Fast, lightweight and 0 dependencies** - no dependencies ensure there are no security breaches from other packages.
+-   **Maintained** - if you need additional functionality feel free to create PR or an Issue.
+-   **Strongly typed** - library written fully in TypeScript.
+-   **Supports PESEL, REGON (9 and 14), NIP, IDENTITY CARD**.
+-   **Tested** - I wrote tests on dozens of valid and invalid chunks of data to make sure validations are performed flawlessly.
+

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

Copyleft License

License

(Experimental) Copyleft license information was found.

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

Non-permissive License

License

(Experimental) A license not known to be considered permissive was found.

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 contributors or author data

Maintenance

Package does not specify a list of contributors or an author in package.json.

Found 1 instance in 1 package

No website

Quality

Package does not have a website.

Found 1 instance in 1 package

Improved metrics

Dev dependency count

8

decreased by-52.94%

Number of low maintenance alerts

1

decreased by-50%

Number of low quality alerts

0

decreased by-100%

Worsened metrics

Total package byte prevSize

8381

decreased by-74.88%

Number of package files

4

decreased by-66.67%

Number of low license alerts

2

increased byInfinity%

License quality

70

decreased by-30%

Lines of code

213

decreased by-38.97%

Number of lines in readme file

49

decreased by-10.91%

Number of medium supply chain risk alerts

1

increased byInfinity%

No dependency changes