angular-jsdoc - npm Package Compare versions

Comparing version 1.4.1 to 1.4.2

angular-template/publish.js

@@ -70,3 +70,3 @@ /*global env: true */
 var copyStaticFiles = function() {
-  ['css', 'js', 'fonts'].forEach(function(dirName) {
+  ['css', 'js'].forEach(function(dirName) {
     var fromDir = path.join(templatePath, dirName);
@@ -73,0 +73,0 @@ var staticFiles = fs.ls(fromDir, 3);

angular-template/README.md

@@ -20,3 +20,2 @@ Angular Template
       ├── js                  # javascript used in layout.html
-      ├── fonts               # font used in layout.html
       ├── html
@@ -23,0 +22,0 @@ │   ├── class.html      # class layout written in angular-template

common/conf.json

@@ -0,0 +0,0 @@ {

common/plugins/ngdoc.js

@@ -0,0 +0,0 @@ exports.defineTags = function(dictionary) {

common/test_conf.json

@@ -0,0 +0,0 @@ {

default/publish.js

@@ -0,0 +0,0 @@ /*global env: true */

default/README.md

@@ -0,0 +0,0 @@ Default Template

gulpfile.js

@@ -0,0 +0,0 @@ var gulp = require('gulp');

index.js

@@ -7,2 +7,3 @@ 'use strict';
 var Q = require('q');
+var util = require("util");
 
@@ -15,9 +16,17 @@ /**
 
+  console.log("cwd is: " + __dirname);
   console.log("angularJsdoc Running command\n", cmd, args.join(" "));
-  var child = spawn(cmd,args), result="";
+
+  var child = (process.platform === "win32")
+    // For windows need to spawn a "cmd" instance and pass the command to it
+    ? spawn("cmd", ["/C", cmd + " " + args.join(" ")], { cwd: process.env.PWD, env: process.env})
+    : spawn(cmd, args);
+
+  var result = "";
+
   child.stdout.on("data", function(data) {
-    result += data; 
+    result += data;
   });
-  child.stderr.on("data", function(data) {result += data;});
-  child.stdout.on("end",  function() {deferred.resolve(result);});
+  child.stderr.on("data", function(data) { result += data; });
+  child.stdout.on("end", function() { deferred.resolve(result); });
 
@@ -33,11 +42,13 @@ return deferred.promise;
   dirs = Array.isArray(dirs) ? dirs : dirs.split(" ");
+
   //default values
-  var command = 
-    optionsArg.command || path.join("node_modules", "jsdoc", "jsdoc.js");
+  var command = optionsArg.command || util.format("node %s", path.join("node_modules", "jsdoc", "jsdoc.js"));
+
   var options = extend({
-      configure: path.join(__dirname, "common", "conf.json"),
-      template: path.join(__dirname, "default"),
-      destination: "docs",
-      readme: 'README.md'
-    }, optionsArg); 
+    configure: path.join(__dirname, "common", "conf.json"),
+    template: path.join(__dirname, "default"),
+    destination: "docs",
+    readme: 'README.md'
+  }, optionsArg);
+
   // if given template a single word including dash
@@ -44,0 +55,0 @@ if (optionsArg.template && optionsArg.template.match(/^[\w-]+$/i)) {

LICENSE.md

@@ -0,0 +0,0 @@ The MIT License (MIT)

package.json

 {
   "name": "angular-jsdoc",
-  "version": "1.4.1",
+  "version": "1.4.2",
   "description": "JsDoc Plugin and Template for AngularJs",
@@ -5,0 +5,0 @@ "main": "index.js",

README.md

@@ -124,5 +124,4 @@ Angular-JSDoc
 
-The following is the example of directory with explanation;
+The following is the example of directory with explanation:
 
-
     my-template
@@ -141,4 +140,42 @@ ├── css
 
+Currently the default angular-template does not come with custom fonts. If you would like to use a template like angular-template but with custom fonts, change the `copyStaticFiles` method in your publish.js:
+
+__angular-template/publish.js__
+```js
+// copy the template's static files to outdir
+var copyStaticFiles = function() {
+  ['css', 'js'].forEach(function(dirName) {
+    var fromDir = path.join(templatePath, dirName);
+    var staticFiles = fs.ls(fromDir, 3);
+
+    staticFiles.forEach(function(fileName) {
+      var toDir = fs.toDir( fileName.replace(fromDir, path.join(outdir, dirName)) );
+      fs.mkPath(toDir);
+      fs.copyFileSync(fileName, toDir);
+    });
+  });
+};
+```
+
+to:
+
+__my-template/publish.js__
+```js
+// copy the template's static files to outdir
+var copyStaticFiles = function() {
+  ['css', 'js', 'fonts'].forEach(function(dirName) {
+    var fromDir = path.join(templatePath, dirName);
+    var staticFiles = fs.ls(fromDir, 3);
+
+    staticFiles.forEach(function(fileName) {
+      var toDir = fs.toDir( fileName.replace(fromDir, path.join(outdir, dirName)) );
+      fs.mkPath(toDir);
+      fs.copyFileSync(fileName, toDir);
+    });
+  });
+};
+```
+
 Copyright
 --------
   MIT licence

sample-codes/app/config.js

@@ -0,0 +0,0 @@ (function () {

sample-codes/app/custom-currency.js

@@ -0,0 +0,0 @@ /**

sample-codes/app/test-service.js

@@ -0,0 +0,0 @@ (function () {

sample-codes/ngmap/attr2-options.js

@@ -0,0 +0,0 @@ (function() {

sample-codes/ngmap/map-controller.js

@@ -0,0 +0,0 @@ (function() {

sample-codes/ngmap/map.js

@@ -0,0 +0,0 @@ (function () {

sample-codes/README.md

@@ -0,0 +0,0 @@ Sample Code

sample-codes/tutorials/all.json

@@ -0,0 +0,0 @@ {

sample-codes/tutorials/childA.md

@@ -0,0 +0,0 @@ child A

sample-codes/tutorials/childB.md

 child B
 
 test

sample-codes/tutorials/tutorial1.md

@@ -0,0 +0,0 @@ This

sample-codes/tutorials/tutorial2.md

@@ -0,0 +0,0 @@ tutorial 2

test.js

@@ -0,0 +0,0 @@ var angularJsdoc = require('./index.js');

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

Environment variable access

Supply chain risk

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

Found 2 instances in 1 package

AI-detected potential code anomaly

Supply chain risk

AI has identified unusual behaviors that may pose a security risk.

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

Native code

Supply chain risk

Contains native code (e.g., compiled binaries or shared libraries). Including native code can obscure malicious behavior.

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

Improved metrics

Number of lines in readme file

180

increased by25.87%

Number of medium supply chain risk alerts

25

decreased by-50%

Worsened metrics

Total package byte prevSize

2780912

decreased by-42.05%

Number of package files

128

decreased by-21.95%

Lines of code

10451

decreased by-0.18%

Number of low supply chain risk alerts

13

increased by30%

No dependency changes