grunt-jsdoc - npm Package Compare versions

Comparing version 0.4.0 to 0.4.1

package.json

 {
   "name": "grunt-jsdoc",
   "description": "Integrates jsdoc3 generation into your Grunt build",
-  "version": "0.4.0",
+  "version": "0.4.1",
   "homepage": "https://github.com/krampstudio/grunt-jsdoc-plugin",
@@ -46,4 +46,4 @@ "author": {
   "dependencies": {
-    "jsdoc3": "git+https://github.com/jsdoc3/jsdoc.git#v3.2.0",
-    "docstrap" : "git+https://github.com/terryweiss/docstrap"
+    "jsdoc": "git+https://github.com/jsdoc3/jsdoc.git#v3.2.0",
+    "ink-docstrap" : "git+https://github.com/terryweiss/docstrap"
   },
@@ -50,0 +50,0 @@ "peerDependencies": {

README.md

@@ -1,2 +0,2 @@
-# grunt-jsdoc-plugin [![Build Status](https://travis-ci.org/krampstudio/grunt-jsdoc-plugin.png)](https://travis-ci.org/krampstudio/grunt-jsdoc-plugin)
+# grunt-jsdoc-plugin [![Build Status](https://travis-ci.org/krampstudio/grunt-jsdoc-plugin.png)](https://travis-ci.org/krampstudio/grunt-jsdoc-plugin) [![NPM version](https://badge.fury.io/js/grunt-jsdoc.png)](http://badge.fury.io/js/grunt-jsdoc)
 
@@ -30,3 +30,3 @@ This plugin enables you to integrate the generation of comments based documentation into your Grunt build.
 ## Documentation
-
+ 
 ### Configuration
@@ -68,8 +68,12 @@
 ```
+ 
+### Code Documentation
 
-### Documentation
-
 The current version supports only [jsdoc3] documentation style. The sources configured 
 must contains valid [jsdoc3] tags. Consult the [usejsdoc] website for the details.
+ 
+### Templates
 
+The plugin includes [docstrap](https://github.com/terryweiss/docstrap), as well as the default template provided by jsdoc3. You can have a look to the [Gruntfile.js](Gruntfile.js) for the configuration.
+
 ### Build
@@ -88,22 +92,23 @@
 ```
-
+ 
 ## Contributing
 
 Any contribution is welcome! Please check the [issues](https://github.com/krampstudio/grunt-jsdoc-plugin/issues). Do some unit tests as far as possible.
-
+ 
 ## Release History
- * _0.4.0_ Update to jsdoc 3.2.0 stable, Fix [bug #37](https://github.com/krampstudio/grunt-jsdoc-plugin/issues/37), add integration tests
- * _0.3.0_ Partial rewrite, Fix [bug #29](https://github.com/krampstudio/grunt-jsdoc-plugin/pull/30) and minor typos fixs
-   * _0.3.1_ Fix [bug #29](https://github.com/krampstudio/grunt-jsdoc-plugin/issues/29)
-   * _0.3.2_ Fix [bug #32](https://github.com/krampstudio/grunt-jsdoc-plugin/issues/32)
-   * _0.3.3_ Fix [bug #34](https://github.com/krampstudio/grunt-jsdoc-plugin/issues/34) and [bug #36](https://github.com/krampstudio/grunt-jsdoc-plugin/issues/34)
+ * _0.4.0_ Update to jsdoc 3.2.0 stable, Fix [#37](https://github.com/krampstudio/grunt-jsdoc-plugin/issues/37), add integration tests
+   * _0.4.1_ Fix [#53](https://github.com/krampstudio/grunt-jsdoc-plugin/issues/53) and [#54](https://github.com/krampstudio/grunt-jsdoc-plugin/issues/54) 
+ * _0.3.0_ Partial rewrite, Fix [#29](https://github.com/krampstudio/grunt-jsdoc-plugin/pull/30) and minor typos fixs
+   * _0.3.1_ Fix [#29](https://github.com/krampstudio/grunt-jsdoc-plugin/issues/29)
+   * _0.3.2_ Fix [#32](https://github.com/krampstudio/grunt-jsdoc-plugin/issues/32)
+   * _0.3.3_ Fix [#34](https://github.com/krampstudio/grunt-jsdoc-plugin/issues/34) and [#36](https://github.com/krampstudio/grunt-jsdoc-plugin/issues/34)
  * _0.2.0_ Migrate to grunt 0.4
-   * _0.2.1_ Fix [bug #10](https://github.com/krampstudio/grunt-jsdoc-plugin/issues/10)
-   * _0.2.2_ Fix [bug #11](https://github.com/krampstudio/grunt-jsdoc-plugin/issues/11)
-   * _0.2.3_ Fix [bug #14](https://github.com/krampstudio/grunt-jsdoc-plugin/pull/14) and [bug #15](https://github.com/krampstudio/grunt-jsdoc-plugin/issues/15)
-   * _0.2.4_ Fix Jsdoc 3 dependency to 3.1.1 tag, enables jsdoc options [issue #19](https://github.com/krampstudio/grunt-jsdoc-plugin/issues/19), enable to add jsdoc path [issue #13](https://github.com/krampstudio/grunt-jsdoc-plugin/issues/13) and add peerDependencies
+   * _0.2.1_ Fix [#10](https://github.com/krampstudio/grunt-jsdoc-plugin/issues/10)
+   * _0.2.2_ Fix [#11](https://github.com/krampstudio/grunt-jsdoc-plugin/issues/11)
+   * _0.2.3_ Fix [#14](https://github.com/krampstudio/grunt-jsdoc-plugin/pull/14) and [#15](https://github.com/krampstudio/grunt-jsdoc-plugin/issues/15)
+   * _0.2.4_ Fix Jsdoc 3 dependency to 3.1.1 tag, enables jsdoc options [#19](https://github.com/krampstudio/grunt-jsdoc-plugin/issues/19), enable to add jsdoc path [#13](https://github.com/krampstudio/grunt-jsdoc-plugin/issues/13) and add peerDependencies
  * _0.1.0_ First release, includes basic support of [jsdoc3]
-   * _0.1.1_ Fix [bug #2](https://github.com/krampstudio/grunt-jsdoc-plugin/issues/2)
-   * _0.1.2_ Fix [bug #4](https://github.com/krampstudio/grunt-jsdoc-plugin/issues/4) 
-   * _0.1.3_ Fix [bug #7](https://github.com/krampstudio/grunt-jsdoc-plugin/pull/7), Add [feature #8](https://github.com/krampstudio/grunt-jsdoc-plugin/pull/8)
+   * _0.1.1_ Fix [#2](https://github.com/krampstudio/grunt-jsdoc-plugin/issues/2)
+   * _0.1.2_ Fix [#4](https://github.com/krampstudio/grunt-jsdoc-plugin/issues/4) 
+   * _0.1.3_ Fix [#7](https://github.com/krampstudio/grunt-jsdoc-plugin/pull/7), Add [feature #8](https://github.com/krampstudio/grunt-jsdoc-plugin/pull/8)
    * _0.1.4_ Use `child_process.spawn` instead of `exec` to run the command
@@ -110,0 +115,0 @@

tasks/jsdoc-plugin.js

@@ -35,3 +35,2 @@ /**
 			srcs			= grunt.task.current.filesSrc,
-			javaHome		= process.env.JAVA_HOME,
 			jsDocPath		= grunt.task.current.data.jsdoc,
@@ -65,3 +64,2 @@ jsDocNpmPath	= 'node_modules/jsdoc/jsdoc',
 
-
 		if(jsDocPath && grunt.file.exists(jsDocPath) && grunt.file.isFile(jsDocPath)){
@@ -78,9 +76,2 @@ //use the given jsdoc path if set
 
-		//check if java is set
-		if(!javaHome){
-			grunt.log.error("JAVA_HOME is not set. Jsdoc requires Java to run.");
-		} else {
-			grunt.log.debug("JAVA_HOME : " + javaHome);
-		}
-
 		//check if jsdoc npm module is installedz
@@ -87,0 +78,0 @@ if(jsDoc === undefined){

New alerts

Git dependency

Supply chain risk

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

Found 2 instances 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

Git dependency

Supply chain risk

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

Found 2 instances 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

Environment variable access

Supply chain risk

Package accesses environment variables, which may be a sign of credential stuffing or data theft.

Found 1 instance in 1 package

Mixed license

License

(Experimental) Package contains multiple licenses.

Found 1 instance in 1 package

Improved metrics

Number of low license alerts

0

decreased by-100%

Number of lines in readme file

127

increased by4.1%

Number of low supply chain risk alerts

4

decreased by-20%

Worsened metrics

Total package byte prevSize

19746

decreased by-99.21%

Number of package files

10

decreased by-84.13%

Lines of code

364

decreased by-99.6%

Dependency changes

• + Addedink-docstrap@git+https://github.com/terryweiss/docstrap

• + Addedjsdoc@git+https://github.com/jsdoc3/jsdoc.git#v3.2.0

• - Removeddocstrap@git+https://github.com/terryweiss/docstrap

• - Removedjsdoc3@git+https://github.com/jsdoc3/jsdoc.git#v3.2.0