gulp-typedoc - npm Package Compare versions

Comparing version 1.2.1 to 2.0.0

index.js

@@ -1,2 +0,2 @@
-// (c) Rogier Schouten <[e-mail]>
+// Copyright (c) 2015 Rogier Schouten <[e-mail]>
 // License: ICS
@@ -3,0 +3,0 @@

package.json

 {
   "name": "gulp-typedoc",
-  "version": "1.2.1",
+  "version": "2.0.0",
   "description": "Gulp plugin for the TypeDoc typescript documentation tool.",
@@ -22,12 +22,14 @@ "repository": {
   },
-  "license": "ICS",
+  "license": "ISC",
   "dependencies": {
-    "event-stream": "^3.3.1",
-    "gulp-util": "^3.0.6",
-    "typedoc": "^0.3.6"
+    "event-stream": "^3.3.2",
+    "gulp-util": "^3.0.7"
   },
   "devDependencies": {
-    "del": "^1.2.0",
-    "gulp": "^3.9.0"
+    "gulp": "^3.9.1",
+    "rimraf": "^2.5.2"
+  },
+  "peerDependencies": {
+    "typedoc": ">=0.3.9"
   }
 }

README.md

@@ -11,16 +11,20 @@ # Gulp-TypeDoc
 
-Gulp plugin to execute the TypeDoc tool by Sebastian Lenz (https://sebastian-lenz.github.io/typedoc)
+Gulp plugin to execute the TypeDoc tool by Sebastian Lenz
+http://typedoc.io/
+https://github.com/TypeStrong/typedoc
+https://github.com/TypeStrong/typedoc
 
-
 ## Installation
 
-You do not need to install typedoc separately, just install gulp-typedoc:
+Install both gulp-typedoc and typedoc:
 
 ```
-npm install --save-dev gulp-typedoc
+npm install --save-dev gulp-typedoc typedoc
 ```
 
+The reason for installing typedoc separately is that it allows you to choose the version of typedoc, independent from the version of gulp-typedoc.
+
 ## Usage
 
-The plugin takes an object, of which all properties are passed transparently to typedoc. Pipe in TypeScript files. The documentation files are not piped out. 
+The plugin takes an object, of which all properties are passed transparently to typedoc. Pipe in TypeScript files. The documentation files are not piped out.
 
@@ -35,14 +39,14 @@ ## Code Example
 		.src(["data/*.ts"])
-		.pipe(typedoc({ 
+		.pipe(typedoc({
 			// TypeScript options (see typescript docs)
-			module: "commonjs", 
+			module: "commonjs",
 			target: "es5",
 			includeDeclarations: true,
-			
+
 			// Output options (see typedoc docs)
-			out: "./out", 
+			out: "./out",
 			json: "output/to/file.json",
 
 			// TypeDoc options (see typedoc docs)
-			name: "my-project", 
+			name: "my-project",
 			theme: "/path/to/my/theme",
@@ -59,31 +63,36 @@ plugins: ["my", "plugins"],
 
+### 2.0.0
+* Have typedoc as peer dependency (thanks @mizunashi-mana)
+* Ensure it works with https://github.com/TypeStrong/typedoc
+* Upgrade all packages, replace "del" by "rimraf"
+* Fix bugs in README.md
+
 ### 1.2.0
-Don't start a child process anymore.
-FIX: having many .ts files no longer causes "command line too long" error.
+* Don't start a child process anymore.
+* FIX: having many .ts files no longer causes "command line too long" error.
 
 ### 1.1.0
-Allow specifying boolean arguments for typedoc;
-Replace module "gulp-clean" by "del"
+* Allow specifying boolean arguments for typedoc;
+* Replace module "gulp-clean" by "del"
 
 ### 1.0.6
-Moved to typedoc version 0.2.x
+* Moved to typedoc version 0.2.x
 
 ### 1.0.5
-Moved to typedoc version 0.1.x
+* Moved to typedoc version 0.1.x
 
 ### 1.0.3
-Use require.resolve() to find typedoc more reliably
+* Use require.resolve() to find typedoc more reliably
 
 ### 1.0.2
-Allow any typedoc version 0.0.x
+* Allow any typedoc version 0.0.x
 
 ## Contributors
 
-* Rogier Schouten <[e-mail]>
-* Daan Wissing <[e-mail]>
+* Rogier Schouten
+* Daan Wissing
+* Mizunashi Mana
 
 ## License
 
-Apache-2.0
-
-
+ISC

test/gulpfile.js

 // (c) Rogier Schouten <[e-mail]>
 // License: Apache-2.0
 
-var del = require("del");
 var gulp = require("gulp");
 var gulpTypedoc = require("../index");
+var path = require("path")
+var rimraf = require("rimraf");
 
 gulp.task("default", ["typedoc"]);
 
-gulp.task("clean", function(cb) {  
-	del(["out/"], cb);
-}); 
+gulp.task("clean", function(cb) {
+	rimraf(path.join(__dirname, "out"), cb);
+});
 
@@ -17,8 +18,8 @@ gulp.task("typedoc", ["clean"], function() {
 		.src(["data/*.ts"])
-		.pipe(gulpTypedoc({ 
+		.pipe(gulpTypedoc({
 			version: true,
-			module: "commonjs", 
-			out: "./out", 
-			json: "./out/test.json", 
-			name: "gulp-typedoc-test", 
+			module: "commonjs",
+			out: "./out",
+			json: "./out/test.json",
+			name: "gulp-typedoc-test",
 			target: "es5",
@@ -43,3 +44,3 @@ includeDeclarations: true
 function trapError(e) {
-	if (e.plugin && e.message) { 
+	if (e.plugin && e.message) {
 		// it is a gulp plugin error
@@ -51,4 +52,4 @@ console.log("Error in plugin: " + e.plugin);
 		// some other error
-		gutil.log(e); 
-	}	
+		gutil.log(e);
+	}
 	exitCode++;
@@ -55,0 +56,0 @@ }

Fixed alerts

Misc. License Issues

License

(Experimental) A package's licensing information has fine-grained problems.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

8183

increased by5.7%

Number of medium license alerts

0

decreased by-100%

Lines of code

139

increased by0.72%

Number of lines in readme file

96

increased by10.34%

Dependency changes

• + Added@gerrit0/mini-shiki@1.27.2(transitive)

• + Added@shikijs/engine-oniguruma@1.29.2(transitive)

• + Added@shikijs/types@1.29.2(transitive)

• + Added@shikijs/vscode-textmate@10.0.2(transitive)

• + Added@types/hast@3.0.4(transitive)

• + Added@types/unist@3.0.3(transitive)

• + Addedargparse@2.0.1(transitive)

• + Addedbrace-expansion@2.0.1(transitive)

• + Addedentities@4.5.0(transitive)

• + Addedlinkify-it@5.0.0(transitive)

• + Addedlunr@2.3.9(transitive)

• + Addedmarkdown-it@14.1.0(transitive)

• + Addedmdurl@2.0.0(transitive)

• + Addedminimatch@9.0.5(transitive)

• + Addedpunycode.js@2.3.1(transitive)

• + Addedtypedoc@0.27.9(transitive)

• + Addedtypescript@5.8.2(transitive)

• + Addeduc.micro@2.1.0(transitive)

• + Addedyaml@2.7.0(transitive)

• - Removedtypedoc@^0.3.6

• - Removedamdefine@1.0.1(transitive)

• - Removedasync@0.2.10(transitive)

• - Removedbrace-expansion@1.1.11(transitive)

• - Removedconcat-map@0.0.1(transitive)

• - Removedfs-extra@0.22.1(transitive)

• - Removedfs.realpath@1.0.0(transitive)

• - Removedglob@7.2.3(transitive)

• - Removedgraceful-fs@4.2.11(transitive)

• - Removedhandlebars@3.0.3(transitive)

• - Removedhighlight.js@8.9.1(transitive)

• - Removedinflight@1.0.6(transitive)

• - Removedjsonfile@2.4.0(transitive)

• - Removedmarked@0.3.19(transitive)

• - Removedminimatch@2.0.103.1.2(transitive)

• - Removedminimist@0.0.10(transitive)

• - Removedonce@1.4.0(transitive)

• - Removedoptimist@0.3.70.6.1(transitive)

• - Removedpath-is-absolute@1.0.1(transitive)

• - Removedprogress@1.1.8(transitive)

• - Removedrimraf@2.7.1(transitive)

• - Removedshelljs@0.5.3(transitive)

• - Removedsource-map@0.1.43(transitive)

• - Removedtypedoc@0.3.12(transitive)

• - Removedtypedoc-default-themes@0.3.4(transitive)

• - Removedtypescript@1.6.2(transitive)

• - Removeduglify-js@2.3.6(transitive)

• - Removedwordwrap@0.0.3(transitive)

• - Removedwrappy@1.0.2(transitive)

• Updatedevent-stream@^3.3.2

• Updatedgulp-util@^3.0.7