soldoc - npm Package Compare versions

Comparing version 0.1.2-beta.7 to 0.1.2

package.json

 {
     "name": "soldoc",
-    "version": "0.1.2-beta.7",
+    "version": "0.1.2",
     "description": "An solidity documentation generator, based in NatSpec format.",
@@ -65,3 +65,3 @@ "main": "dist/index.js",
         "@types/highlight.js": "9.12.3",
-        "@types/jest": "24.9.1",
+        "@types/jest": "25.1.0",
         "@types/meow": "5.0.0",
@@ -71,5 +71,5 @@ "@types/mustache": "4.0.0",
         "@types/node-emoji": "1.8.1",
-        "@typescript-eslint/eslint-plugin": "2.17.0",
-        "@typescript-eslint/eslint-plugin-tslint": "2.17.0",
-        "@typescript-eslint/parser": "2.17.0",
+        "@typescript-eslint/eslint-plugin": "2.18.0",
+        "@typescript-eslint/eslint-plugin-tslint": "2.18.0",
+        "@typescript-eslint/parser": "2.18.0",
         "coveralls": "3.0.9",
@@ -89,3 +89,3 @@ "directory-tree": "2.2.4",
         "pdf-to-text": "0.0.7",
-        "puppeteer": "2.0.0",
+        "puppeteer": "2.1.0",
         "tslint": "^5.0.0",
@@ -92,0 +92,0 @@ "typedoc": "0.16.9",

README.md

@@ -1,11 +0,26 @@
-<p align="center">
-    <img width="90%" src="soldoc.png">
-</p>
+<div align="center">
+    <img width="768" src="soldoc.png">
+</div>
 
-[![npm](https://img.shields.io/npm/dm/soldoc.svg)](https://www.npmjs.com/package/soldoc)
-[![Build Status](https://travis-ci.org/HQ20/soldoc.svg?branch=master)](https://travis-ci.org/HQ20/soldoc)
-[![Coverage Status](https://coveralls.io/repos/github/HQ20/soldoc/badge.svg?branch=master)](https://coveralls.io/github/HQ20/soldoc?branch=master)
-[![Netlify Status](https://api.netlify.com/api/v1/badges/084d2d9e-5f67-46c8-a8e7-22d73f2f707d/deploy-status)](https://app.netlify.com/sites/soldoc-demo/deploys)
+> soldoc is a solidity documentation generator. This generator was created due to a need of giving documentation to developers and clients. Thinking about it, we first created this tool to generate a standalone HTML page, but then we also decided to generate a PDF.
 
-> soldoc is a solidity documentation generator. This generator was created due to a need of giving documentation to developers and clients. Thinking about it, we first created this tool to generate an HTML self hosted page, but then we also decided to generate a PDF.
+<div align="center">
+    <div>
+        <a
+            href="https://www.npmjs.com/package/soldoc"><img
+                src="https://img.shields.io/npm/dm/soldoc.svg" /></a>&emsp;
+        <a
+            href="https://travis-ci.org/HQ20/soldoc"><img
+                src="https://travis-ci.org/HQ20/soldoc.svg?branch=master" /></a>&emsp;
+        <a
+            href="https://coveralls.io/github/HQ20/soldoc?branch=master"><img
+                src="https://coveralls.io/repos/github/HQ20/soldoc/badge.svg?branch=master" /></a>&emsp;
+        <a
+            href="https://app.netlify.com/sites/soldoc-demo/deploys"><img
+                src="https://api.netlify.com/api/v1/badges/084d2d9e-5f67-46c8-a8e7-22d73f2f707d/deploy-status" /></a>&emsp;
+        <a
+            href="https://dependabot.com"><img
+                src="https://api.dependabot.com/badges/status?host=github&repo=HQ20/soldoc" /></a>&emsp;
+    </div>
+</div>
 
@@ -18,3 +33,3 @@ See demo [here](https://soldoc-demo.netlify.com/).
 * Generates documentation with soft colors :eyes:
-* The generated output can be pure HTML :grin:, a PDF file :necktie:, gitbook format :scream: or docsify format :boom:
+* The generated output can be standalone HTML :grin:, a PDF file :necktie:, gitbook format :scream: or docsify format :boom:
 * All formats support emojis :speak_no_evil:
@@ -61,2 +76,5 @@ * Ignore documentation generator for some specific files :sunglasses:
 
+## License
+[GPL-3.0](LICENSE)
+
 ## Credits
@@ -70,4 +88,1 @@ Credits to all external open/free material used.
 Thank you. Danke. Merci. Grazie. Gracias. Arigato. Obrigado.
-
-## License
-[GPL-3.0](LICENSE)

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

Empty package

Supply chain risk

Package does not contain any code. It may be removed, is name squatting, or the result of a faulty package publish.

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

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

Filesystem access

Supply chain risk

Accesses the file system, and could potentially read sensitive data.

Found 1 instance in 1 package

Improved metrics

Number of lines in readme file

86

increased by21.13%

Number of low supply chain risk alerts

0

decreased by-100%

Worsened metrics

Total package byte prevSize

41729

decreased by-56.66%

Number of package files

3

decreased by-76.92%

Lines of code

0

decreased by-100%

Number of medium supply chain risk alerts

2

increased by100%

No dependency changes