sassdoc - npm Package Compare versions

Comparing version 1.3.2 to 1.4.0-rc.1

CHANGELOG.md

 # Changelog
 
+## 1.4.0-rc.1
+
+* Added placeholder support ([#154](https://github.com/SassDoc/sassdoc/issues/154))
+* Prevented a crash when using invalid annotations; throwing a warning instead
+* Added `@source` as an alias for `@link` to provide more semantic
+
 ## 1.3.2
@@ -4,0 +10,0 @@

package.json

@@ -20,3 +20,3 @@ {
   ],
-  "version": "1.3.2",
+  "version": "1.4.0-rc.1",
   "license": {
@@ -45,7 +45,7 @@ "type": "MIT",
   "dependencies": {
-    "sassdoc-theme-default": "^1.0.0",
+    "sassdoc-theme-default": "^1.1.0",
     "q": "^1.0.1",
     "rimraf": "~2.2.8",
     "ncp": "^0.6.0",
-    "scss-comment-parser": "^0.2.4",
+    "scss-comment-parser": "^0.3.2",
     "mkdirp": "^0.5.0",
@@ -59,2 +59,3 @@ "docopt": "^0.4.0",
     "assert": "^1.1.1",
+    "atom-screenshot": "^0.1.2",
     "grunt": "^0.4.5",
@@ -66,3 +67,5 @@ "grunt-autoprefixer": "^1.0.0",
     "grunt-contrib-sass": "^0.7.3",
+    "grunt-contrib-uglify": "^0.5.1",
     "grunt-contrib-watch": "^0.6.1",
+    "grunt-gh-pages": "^0.9.1",
     "grunt-mocha-test": "^0.11.0",
@@ -69,0 +72,0 @@ "load-grunt-tasks": "^0.6.0",

README.md

@@ -5,3 +5,3 @@ # SassDoc
 
-![SassDoc](http://i.imgur.com/zN7UPua.png)
+![SassDoc](http://sassdoc.com/preview-image.png)
 ---
@@ -8,0 +8,0 @@

src/annotation/annotations/link.js

@@ -13,3 +13,4 @@ 'use strict';
     };
-  }
+  },
+  alias : ['source']
 };

src/annotation/annotations/output.js

@@ -6,5 +6,4 @@ 'use strict';
     return text.trim();
-  }
+  },
+  alias : ['outputs']
 };
-
-module.exports.alias = ['outputs'];

src/annotation/annotations/parameters.js

@@ -27,5 +27,4 @@ 'use strict';
     return obj;
-  }
+  },
+  alias : ['arg', 'arguments', 'param']
 };
-
-module.exports.alias = ['arg', 'arguments', 'param'];

src/annotation/annotations/returns.js

@@ -27,5 +27,4 @@ 'use strict';
     return obj;
-  }
+  },
+  alias : ['return']
 };
-
-module.exports.alias = ['return'];

src/annotation/annotations/throws.js

@@ -6,5 +6,4 @@ 'use strict';
     return text.trim();
-  }
+  },
+  alias : ['throw', 'exception']
 };
-
-module.exports.alias = ['throw', 'exception'];

src/annotation/annotations/todos.js

@@ -6,5 +6,4 @@ 'use strict';
     return text.trim();
-  }
+  },
+  alias : ['todo']
 };
-
-module.exports.alias = ['todo'];

src/parser.js

@@ -6,4 +6,10 @@ 'use strict';
 
+var logger = require('./log');
+
 var parser = new ScssCommentParser(annotations);
 
+parser.commentParser.on('warning', function(warning){
+  logger.warn(warning);
+});
+
 module.exports = {
@@ -10,0 +16,0 @@

New alerts

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

171146

increased by0.25%

Lines of code

1377

increased by0.44%

Worsened metrics

Dev dependency count

14

increased by27.27%

Number of low quality alerts

1

increased byInfinity%

Dependency changes

• + Addedcdocparser@0.2.2(transitive)

• + Addedlodash.assign@2.4.1(transitive)

• + Addedscss-comment-parser@0.3.3(transitive)

• - Removedcdocparser@0.1.1(transitive)

• - Removedscss-comment-parser@0.2.4(transitive)

• Updatedsassdoc-theme-default@^1.1.0

• Updatedscss-comment-parser@^0.3.2