Skip to content

Commit

Permalink
dependencies support and class dependency view in html app
Browse files Browse the repository at this point in the history
  • Loading branch information
cancerberoSgx committed Apr 26, 2015
1 parent 8152e83 commit 76985f8
Show file tree
Hide file tree
Showing 46 changed files with 37,112 additions and 166 deletions.
21 changes: 21 additions & 0 deletions .jshintrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
{
"predef": [
]
,"globals": {
}
, "forin":true
, "noarg":true
, "noempty":true
, "eqeqeq":true
, "bitwise":false
, "undef":true
, "unused":true
, "curly":true
, "browser":true
, "quotmark":"single"
, "maxerr":50
, "laxcomma":true
, "expr":true
, "newcap": false
, "node": true
}
3 changes: 2 additions & 1 deletion Changelist.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,4 +53,5 @@
* show properties partial text in class view

##0.1.9
* html application runs without server - just open the local html. for pure json output pass --json-output argument
* html application runs without server - just open the local html. for pure json output pass --json-output argument
* @depends class OtherClass - dependencies plugin/tool - must be run manually - not executed automatically since we don't want to make the tool slow. Also implemented a view in the html app to show the class dependency graph using visjs
3 changes: 3 additions & 0 deletions Gruntfile.js
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ var uglifyFiles = [
, 'html/src/js/AbstractTreeView.js'
, 'html/src/js/TreeView.js'
, 'html/src/js/HierarchyTreeView.js'
, 'html/src/js/DependenciesView.js'

];

Expand All @@ -33,6 +34,7 @@ var uglifyLibFiles = [
, 'html/lib/twitter-typeahead/typeahead.bundle.js'
, 'html/lib/marked/marked.js'
, 'html/lib/prettify/prettify.js'
, 'html/lib/toast/toast.min.js'

];

Expand Down Expand Up @@ -110,6 +112,7 @@ module.exports = function (grunt) {
'esprima'
// , 'underscore'
]
, debug: true
}
, client: {
src: ['src/jsdocmaker/main.js'],
Expand Down
10 changes: 10 additions & 0 deletions TODO.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@
Listed from more important to less important - kind of:


* issue this seems to fail: @module m @class A @method p @property {B} @class B - the error is class 'undefined.B'

* remove @?link and see if is faster.

* support globs in nodejs API
Expand All @@ -29,6 +31,10 @@ Listed from more important to less important - kind of:

all primary annotation rules (class, module,method, property) should be defined using this hooking api. so the jsdoc rules for this are defined in a readable json.


plugin that allow to declare generic new primary annotations support new custom primary annotations
* IDEA: plugin for amd-commonjs dependency information - implementation 1) define a primary tag @dependency Class1 Class2,Class3 - meaning that Class 1 depends on Class21,Class3. 2) a esprima/

* @return {{a:1,b:2}} - yes with 2 {{ like closure-compiler.

* @property @type plugin - to support closure compiler syntax.
Expand Down Expand Up @@ -61,6 +67,7 @@ all primary annotation rules (class, module,method, property) should be defined

* list properties in html app alphabetically or at least have that option.


* detect overriden methods and add a link to the overriden in the text

* IMPORTANT by default, delete the property theRestOfTheString that is dumping in the data.json to minimize its size
Expand Down Expand Up @@ -270,3 +277,6 @@ the idea is that the parser look in the javascript ast for the next function dec



#weird ideas

* BIG IDEA: javascript source parsing and custom primary annotations: implementation steps 1) a plugin that let us register (PluginContainer) a visitor function that will be called traversing the ast using estraverse or similar. 2) a plugin that let us safely insert a new primary annotation in a file by appending it 3) concrete plugins that uses these two tools that will search for AMD or commonjs expressions and create @dependency class MyView Backbone.View Chart.Widget meaning that MyView depends on Backbone.View Chart.Widget. this is a primary annotation. it could also be @dependency module Backbone jQuery undrscore. The plugin could be runned only inthe frontend...
2 changes: 1 addition & 1 deletion html/all.min.js

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion html/all.min.js.map

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion html/data.json

Large diffs are not rendered by default.

10 changes: 9 additions & 1 deletion html/index-dev.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@
<meta charset="utf-8"/>
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=no"/>

<!-- not UI related dependencies - only required for the Online Parser view -->
<!-- not UI related dependencies - only required for the Online Parser view
can be removed if online parser is disabled.-->
<script src="../lib/esprima.js" type="text/javascript"></script>
<script src="../lib/underscore.js" type="text/javascript"></script>
<script src="src/JsDocMaker_browser.js" type="text/javascript"></script>
Expand All @@ -29,6 +30,7 @@
<script src="lib/twitter-typeahead/typeahead.bundle.js" type="text/javascript"></script>

<script src="lib/marked/marked.js" type="text/javascript"></script>
<script src="lib/toast/toast.min.js" type="text/javascript"></script>

<link href="lib/prettify/prettify.css" type="text/css" rel="stylesheet" />
<script type="text/javascript" src="lib/prettify/prettify.js"></script>
Expand All @@ -54,11 +56,17 @@
<script src="src/js/AbstractTreeView.js" type="text/javascript"></script>
<script src="src/js/TreeView.js" type="text/javascript"></script>
<script src="src/js/HierarchyTreeView.js" type="text/javascript"></script>
<script src="src/js/DependenciesView.js" type="text/javascript"></script>

<script src="template-output.js" type="text/javascript"></script>

<link href="src/styles/styles.css" rel="stylesheet">


<!--
<script type="text/javascript" src="lib/vis/dist/vis.min.js"></script>
<link href="lib/vis/dist/vis.min.css" type="text/css" rel="stylesheet" />
-->
</head>

<body>
Expand Down
1 change: 0 additions & 1 deletion html/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@

<link href="lib/prettify/prettify.css" type="text/css" rel="stylesheet" />


<link href="src/styles/styles.css" rel="stylesheet">

</head>
Expand Down
2 changes: 2 additions & 0 deletions html/lib/toast/toast.min.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added html/lib/vis/dist/img/network/addNodeIcon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added html/lib/vis/dist/img/network/backIcon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added html/lib/vis/dist/img/network/connectIcon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added html/lib/vis/dist/img/network/cross.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added html/lib/vis/dist/img/network/cross2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added html/lib/vis/dist/img/network/deleteIcon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added html/lib/vis/dist/img/network/downArrow.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added html/lib/vis/dist/img/network/editIcon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added html/lib/vis/dist/img/network/leftArrow.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added html/lib/vis/dist/img/network/minus.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added html/lib/vis/dist/img/network/plus.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added html/lib/vis/dist/img/network/rightArrow.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added html/lib/vis/dist/img/network/upArrow.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added html/lib/vis/dist/img/network/zoomExtends.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added html/lib/vis/dist/img/timeline/delete.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 76985f8

Please sign in to comment.