angular-jsdoc - npm Package Compare versions

Comparing version 0.3.8 to 1.0.0

LICENSE.md

 The MIT License (MIT)
 
-Copyright (c) 2014 Allen Kim
+Copyright (c) 2014-2015 Allen Kim
 
@@ -5,0 +5,0 @@ Permission is hereby granted, free of charge, to any person obtaining a copy of

package.json

 {
   "name": "angular-jsdoc",
-  "version": "0.3.8",
+  "version": "1.0.0",
   "description": "JsDoc Plugin and Template for AngularJs",
@@ -19,10 +19,12 @@ "main": "index.js",
   "dependencies": {
-    "jsdoc": "~3.3.0-alpha11"
+    "js-template": "~0.1.3",
+    "jsdoc": "~3.3.0-alpha11",
+    "q": "^1.4.1"
   },
   "devDependencies": {
-    "gulp-tap": "~0.1.1",
     "gulp": "~3.8.5",
-    "gulp-util": "~2.2.19",
     "gulp-bump": "~0.1.10",
-    "gulp-shell": "~0.2.7"
+    "gulp-shell": "~0.2.7",
+    "gulp-tap": "~0.1.1",
+    "gulp-util": "~2.2.19"
   },
@@ -29,0 +31,0 @@ "readme": "Angular-JSDoc\n=============\nAngularJS Template for JSDoc 3.  \nA simple collection of JSDoc plugin and template for AngularJS, nothing else!  \n\nFeatures\n----------\n  * Right side table of contents for navigation by Directives, Services, Controllers, etc\n  * Read and process @ngdoc tag\n\nHow Does It Look Like\n---------------------\n  * [angularjs-goolge-maps Documentation](https://rawgit.com/allenhwkim/angularjs-google-maps/master/build/docs/index.html)\n\nInstall\n-------\n    $ npm install jsdoc angular-jsdoc --save-dev\n  \nRun\n---\nRun jsdoc command to generate your documentation. \nAll command line options are the options of [jsdoc](http://usejsdoc.org/about-commandline.html)  \n    \n    $ path/to/jsdoc -c path to conf> -t <template> <your source code>\n\nIn example,  \n\n    `$ node_modules/jsdoc/jsdoc.js -c node_modules/angular-jsdoc/conf -t node_modules/angular-jsdoc/template -r myDir`\n\nRun with gulp-jsdoc\n-------------------\n\n1. install gulp-jsdoc  \n    `$ npm install gulp-shell --save-dev`\n\n2. add the following to the gulpfile.json  \n   ```\n   var shell = require('gulp-shell'); \n   gulp.task('docs', shell.task([ \n     'node_modules/jsdoc/jsdoc.js '+ \n       '-c node_modules/angular-jsdoc/conf.json '+   // config file\n       '-t node_modules/angular-jsdoc/template '+    // template file\n       '-d build/docs '+                             // output directory\n       '-r app/scripts'                              // source code directory\n   ])); \n   ```\n3. run gulp task  \n    `$ gulp docs`\n",

README.md

 Angular-JSDoc
 =============
+
 JSDoc 3 Template for AngularJS.  
 A JSDoc plugin and template for AngularJS, nothing else!  
 
+Blog: [Sigh, AngularJS Documentation](http://allenhwkim.tumblr.com/post/92161523693/sigh-angularjs-documentation)
+
 <img src=http://i.imgur.com/FPo9x25.gif width=50%  />
@@ -13,45 +16,79 @@
 
-How Does It Look Like
----------------------
+How Does It Look Like?
+------------------------
   * [angularjs-google-maps Documentation](https://rawgit.com/allenhwkim/angularjs-google-maps/master/build/docs/index.html)
 
+
 Install
 -------
+
     $ npm install jsdoc angular-jsdoc --save-dev
-  
-Run In Command Line
--------------------
-Run jsdoc command to generate your documentation. 
-All command line options are the options of [jsdoc](http://usejsdoc.org/about-commandline.html)  
-    
-    $ path/to/jsdoc -c path to conf> -t <template> <your source code>
 
-In example,  
+Quick Start
+-----------
 
-    `$ node_modules/jsdoc/jsdoc.js -c node_modules/angular-jsdoc/conf.json -t node_modules/angular-jsdoc/template -r myDir`
+    var angularJsdoc = require('angualr-jsdoc');
+    angularJsdoc(['my-source1', 'my-source2']); 
 
-Run with gulp-jsdoc
--------------------
 
-1. install gulp-shell  
-    `$ npm install gulp-shell --save-dev`
+    // or with options
+    angularJsdoc('sample-codes', {
+      template: 'default',
+      destination: 'default/docs',
+      readme: "sample-codes/README.md"
+    });
 
-2. add the following to the gulpfile.json  
-   ```
-   var shell = require('gulp-shell'); 
-   gulp.task('docs', shell.task([ 
-     'node_modules/jsdoc/jsdoc.js '+ 
-       '-c node_modules/angular-jsdoc/conf.json '+   // config file
-       '-t node_modules/angular-jsdoc/template '+    // template file
-       '-d build/docs '+                             // output directory
-       './README.md ' +                              // to include README.md as index contents
-       '-r app/scripts'                              // source code directory
-   ])); 
-   ```
-3. run gulp task  
-    `$ gulp docs`
+Specification
+--------------
 
+  angularJsdoc(sourceDirectory, options)
 
-[Example of Directive Documentation](https://github.com/allenhwkim/angularjs-google-maps/blob/master/app/scripts/directives/map.js)
+  - sourceDirectory: list of source code directories. e.g. ['dir1', 'dir2']
 
-[Example of Service Documentation](https://github.com/allenhwkim/angularjs-google-maps/blob/master/app/scripts/services/attr2_options.js)
+  - options:
+
+    - configure: The path to the configuration file.
+                 Default: angular-jsdoc/common/conf.json
+    - destination: The path to the output folder. 
+                 Default: ./docs
+    - template:  The path to the template to use
+                 Default: angular-jsdoc/default
+    - readme: The path to the project's README file.
+                 Default: 'README.md'
+
+Example
+--------
+
+   - Directive: sample-codes/ngmap/map.js 
+     [Output](https://rawgit.com/allenhwkim/angular-jsdoc/master/default/docs/map.html)
+   - Service: sample-codes/ngmap/attr2-optins.js 
+     [Output](https://rawgit.com/allenhwkim/angular-jsdoc/master/default/docs/Attr2Options.html)
+   - Controller: sample-codes/ngmap/mpa-controller.js 
+     [Output](https://rawgit.com/allenhwkim/angular-jsdoc/master/default/docs/MapController.html)
+
+Customization
+-------------
+To make your own template, please copy the default directory to your own, then, make your own css, js, and html files. Then, run angularJsdoc with your own template. e.g., `angularJsDoc({template:'myown'})`
+
+If you want to share your template with others, please send a pull request after adding your template directory where `default` directory is.
+
+The following is the example of directory with explanation;
+
+
+    my-template
+      ├── css
+      │   └── my.css          # css used in layout.html
+      ├── js
+      │   └── my.js           # javascript used in layout.html
+      ├── fonts
+      │   └── my.woff         # font used in layout.html
+      ├── html
+      │   ├── class.html      # template used by layout.html
+      │   └── layout.html     # layout file
+      └── publish.js          # the main file that generate jsdoc
+
+
+Copyright
+--------
+  MIT licence
+>>>>>>> ngTemplate

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

Native code

Supply chain risk

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

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

Shell access

Supply chain risk

This module accesses the system shell. Accessing the system shell increases the risk of executing arbitrary code.

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

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

2201022

increased by2400.25%

Number of package files

73

increased by135.48%

Lines of code

4478

increased by269.47%

Number of low quality alerts

2

decreased by-33.33%

Number of lines in readme file

94

increased by64.91%

Worsened metrics

Dependency count

3

increased by200%

Number of low supply chain risk alerts

4

increased byInfinity%

Number of medium supply chain risk alerts

26

increased byInfinity%

Dependency changes

• + Addedjs-template@~0.1.3

• + Addedq@^1.4.1

• + Addedjs-template@0.1.4(transitive)

• + Addedq@1.5.1(transitive)