apidoc-core - npm Package Compare versions

Comparing version 0.1.0 to 0.2.0

package.json

 {
   "name": "apidoc-core",
-  "version": "0.1.0",
-  "description": "apiDoc Core - RESTful web API Documentation Generator",
+  "version": "0.2.0",
+  "description": "Core parser library to generate apidoc result following the apidoc-spec",
   "author": "Peter Rottmann <[e-mail]>",
-  "homepage": "http://apidocjs.com",
+  "license": {
+    "type": "MIT",
+    "url": "https://github.com/apidoc/apidoc-core/blob/master/LICENSE"
+  },
+  "main": "./lib/index.js",
+  "homepage": "https://github.com/apidoc/apidoc-core",
   "repository": {
@@ -11,10 +16,9 @@ "type": "git",
   },
-  "license": {
-    "type": "MIT",
-    "url": "https://github.com/apidoc/apidoc-core/blob/master/LICENSE.md"
-  },
   "bugs": {
     "url": "https://github.com/apidoc/apidoc-core/issues"
   },
-  "main": "index.js",
+  "scripts": {
+    "test": "npm run jshint && mocha test/",
+    "jshint": "jshint lib/ test/ --exclude test/fixtures/"
+  },
   "keywords": [
@@ -26,4 +30,3 @@ "api",
     "rest",
-    "restful",
-    "generator"
+    "restful"
   ],
@@ -34,5 +37,31 @@ "engines": {
   "dependencies": {
+    "lodash": "~2.4.1",
+    "semver": "^4.1.0",
+    "wrench": "~1.5.8"
   },
   "devDependencies": {
+    "jshint": "^2.5.10",
+    "marked": "^0.3.2",
+    "mocha": "^2.0.1",
+    "should": "~4.2.1"
+  },
+  "jshintConfig": {
+    "camelcase": true,
+    "curly": false,
+    "eqeqeq": true,
+    "forin": true,
+    "latedef": false,
+    "newcap": true,
+    "undef": true,
+    "unused": true,
+    "trailing": true,
+    "node": true,
+    "browser": true,
+    "predef": [
+      "it",
+      "describe",
+      "before",
+      "after"
+    ]
   }
 }

README.md

 # apidoc-core
 
-Generates a RESTful web API Documentation.
+Core parser library to generate apidoc result following the [apidoc-spec](https://github.com/apidoc/apidoc-spec)
 
-Work in progress.
+[![Build Status](https://travis-ci.org/apidoc/apidoc-core.svg?branch=master)](https://travis-ci.org/apidoc/apidoc-core)
+[![Dependency Status](https://david-dm.org/apidoc/apidoc-core.svg)](https://david-dm.org/apidoc/apidoc-core)
+[![NPM version](https://badge.fury.io/js/apidoc-core.svg)](http://badge.fury.io/js/apidoc-core)
 
+If you are an end user, please proceed to [apidoc](https://github.com/apidoc/apidoc) or [apidoc-documentation](http://apidocjs.com).
+
+[Changelog](https://github.com/apidoc/apidoc/blob/master/CHANGELOG.md).
+
+The apidoc-core major and minor version represent the used apidoc-spec version.

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

Dynamic require

Supply chain risk

Dynamic require can indicate the package is performing dangerous or unsafe dynamic code execution.

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

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

Trivial Package

Supply chain risk

Packages less than 10 lines of code are easily copied into your own project and may not warrant the additional supply chain risk of an external dependency.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

100077

increased by4908.86%

Number of package files

65

increased by1200%

Lines of code

2838

increased by283700%

Number of lines in readme file

14

increased by100%

Worsened metrics

Dependency count

3

increased byInfinity%

Dev dependency count

4

increased byInfinity%

Number of low supply chain risk alerts

5

increased byInfinity%

Dependency changes

• + Addedlodash@~2.4.1

• + Addedsemver@^4.1.0

• + Addedwrench@~1.5.8

• + Addedlodash@2.4.2(transitive)

• + Addedsemver@4.3.6(transitive)

• + Addedwrench@1.5.9(transitive)