soldoc - npm Package Compare versions

Comparing version 0.1.2-beta.6 to 0.1.2-beta.7

dist/organize.js

@@ -64,2 +64,4 @@ "use strict";
         functions: [],
+        structs: [],
+        variables: [],
     };
@@ -79,18 +81,21 @@ // visit all the methods and add the commands to it
         FunctionDefinition: function (node) {
-            if (node.isConstructor) {
-                data = __assign({ constructor: {
+            if ((node.natspec !== null && node.natspec.dev !== 'soldoc-ignore' ||
+                node.natspec === null)) {
+                if (node.isConstructor) {
+                    data = __assign({ constructor: {
+                            ast: node,
+                            parameters: extendParamsAstWithNatspec(node),
+                            returnParameters: extendReturnParamsAstWithNatspec(node),
+                        } }, data);
+                }
+                else {
+                    data.functions.push({
                         ast: node,
                         parameters: extendParamsAstWithNatspec(node),
                         returnParameters: extendReturnParamsAstWithNatspec(node),
-                    } }, data);
+                        stateMutability: extendsStateMutability(node),
+                        visibility: extendsVisibility(node),
+                    });
+                }
             }
-            else {
-                data.functions.push({
-                    ast: node,
-                    parameters: extendParamsAstWithNatspec(node),
-                    returnParameters: extendReturnParamsAstWithNatspec(node),
-                    stateMutability: extendsStateMutability(node),
-                    visibility: extendsVisibility(node),
-                });
-            }
         },
@@ -100,2 +105,8 @@ InheritanceSpecifier: function (node) {
         },
+        StateVariableDeclaration: function (node) {
+            data.variables.push({
+                ast: __assign(__assign({}, node), { variable: node.variables[0] }),
+                visibility: extendsVisibility(node),
+            });
+        },
     });
@@ -102,0 +113,0 @@ var name = ast.children.filter(function (child) { return child.type === 'ContractDefinition'; })[0].name;

package.json

 {
     "name": "soldoc",
-    "version": "0.1.2-beta.6",
-    "description": "An html page and pdf solidity documentation generator, based in NatSpec format.",
+    "version": "0.1.2-beta.7",
+    "description": "An solidity documentation generator, based in NatSpec format.",
     "main": "dist/index.js",
@@ -17,3 +17,3 @@ "bin": {
         "demo:pdf": "./dist/cli.js --output pdf docs/ test/contracts/Plane.sol",
-        "lint": "tslint -p .",
+        "lint": "eslint \"src/**/*.ts\"",
         "build": "tsc && cp -r src/template dist && chmod u+x dist/cli.js",
@@ -52,39 +52,42 @@ "pretest": "yarn build",
     "peerDependencies": {
-        "directory-tree": "2.2.x",
-        "highlight.js": "9.17.x",
-        "markdown-it": "10.0.x",
-        "markdown-it-emoji": "1.4.x",
-        "meow": "6.0.x",
-        "mustache": "3.1.x",
-        "node-emoji": "1.10.x",
-        "pdf-from-html": "0.1.x"
+        "directory-tree": "^2.2.0",
+        "highlight.js": "^9.18.0",
+        "markdown-it": "^10.0.0",
+        "markdown-it-emoji": "^1.4.0",
+        "meow": "^6.0.0",
+        "mustache": "^4.0.0",
+        "node-emoji": "^1.10.0",
+        "pdf-from-html": "^0.1.0"
     },
     "dependencies": {
-        "solidity-parser-antlr": "git://github.com/obernardovieira/solidity-parser-antlr.git#80086a4"
+        "@hq20/solidity-parser-antlr": "0.4.12-alpha.0"
     },
     "devDependencies": {
-        "highlight.js": "9.17.1",
-        "markdown-it": "10.0.0",
-        "markdown-it-emoji": "1.4.0",
-        "meow": "6.0.0",
-        "mustache": "3.2.1",
-        "node-emoji": "1.10.0",
-        "pdf-from-html": "0.1.1",
         "@types/highlight.js": "9.12.3",
+        "@types/jest": "24.9.1",
         "@types/meow": "5.0.0",
-        "@types/mustache": "0.8.32",
-        "@types/node": "13.1.2",
+        "@types/mustache": "4.0.0",
+        "@types/node": "13.5.0",
         "@types/node-emoji": "1.8.1",
-        "typescript": "3.7.4",
-        "@types/jest": "24.0.25",
+        "@typescript-eslint/eslint-plugin": "2.17.0",
+        "@typescript-eslint/eslint-plugin-tslint": "2.17.0",
+        "@typescript-eslint/parser": "2.17.0",
         "coveralls": "3.0.9",
         "directory-tree": "2.2.4",
+        "eslint": "6.8.0",
+        "eslint-plugin-import": "2.20.0",
         "expect.js": "0.3.1",
-        "jest": "24.9.0",
-        "jest-puppeteer": "4.4.0",
+        "highlight.js": "9.18.0",
+        "jest": "25.1.0",
+        "markdown-it": "10.0.0",
+        "markdown-it-emoji": "1.4.0",
+        "meow": "6.0.0",
+        "mustache": "4.0.0",
+        "node-emoji": "1.10.0",
+        "pdf-from-html": "0.1.1",
         "pdf-to-text": "0.0.7",
         "puppeteer": "2.0.0",
-        "tslint": "5.20.1",
-        "typedoc": "0.15.6",
-        "typescript-tslint-plugin": "0.5.5"
+        "tslint": "^5.0.0",
+        "typedoc": "0.16.9",
+        "typescript": "3.7.5"
     },
@@ -91,0 +94,0 @@ "jest": {

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

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

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

Git dependency

Supply chain risk

Contains a dependency which resolves to a remote git URL. Dependencies fetched from git URLs are not immutable can be used to inject untrusted code or reduce the likelihood of a reproducible install.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

96290

increased by1.12%

Lines of code

590

increased by1.9%

Number of high supply chain risk alerts

0

decreased by-100%

Worsened metrics

Dev dependency count

27

increased by12.5%

Number of medium supply chain risk alerts

1

increased byInfinity%

Dependency changes

• + Added@hq20/solidity-parser-antlr@0.4.12-alpha.0

• + Added@hq20/solidity-parser-antlr@0.4.12-alpha.0(transitive)

• + Addeddirectory-tree@2.4.0(transitive)

• + Addedhighlight.js@9.18.5(transitive)

• + Addedlodash@4.17.21(transitive)

• + Addedmeow@6.1.1(transitive)

• + Addednode-emoji@1.11.0(transitive)

• - Removedsolidity-parser-antlr@git://github.com/obernardovieira/solidity-parser-antlr.git#80086a4

• - Removeddirectory-tree@2.2.9(transitive)

• - Removedhandlebars@4.7.8(transitive)

• - Removedhighlight.js@9.17.1(transitive)

• - Removedlodash.toarray@4.4.0(transitive)

• - Removedmeow@6.0.1(transitive)

• - Removedminimist@1.2.8(transitive)

• - Removedmustache@3.1.0(transitive)

• - Removedneo-async@2.6.2(transitive)

• - Removednode-emoji@1.10.0(transitive)

• - Removedsource-map@0.6.1(transitive)

• - Removeduglify-js@3.19.3(transitive)

• - Removedwordwrap@1.0.0(transitive)

• - Removedyargs-parser@16.1.0(transitive)