Merge pull request #259 from SassDoc/revert-258-unify-annotation-names-2.0

Revert "Unify annotation names 2.0"

Author: FWeinb

src/annotation/annotations/parameter.js renamed to src/annotation/annotations/parameters.js

@@ -25,7 +25,7 @@ module.exports = {
 
     return obj;
   },
-  alias: ['arg', 'arguments', 'param', 'parameters'],
+  alias: ['arg', 'arguments', 'param'],
 
   allowedOn : ['function', 'mixin']
 };

src/annotation/annotations/property.js renamed to src/annotation/annotations/prop.js

@@ -26,7 +26,7 @@ module.exports = {
     return obj;
   },
 
-  alias: ['prop'],
+  alias: ['property'],
 
   allowedOn: ['variable']
 };

src/annotation/annotations/require.js renamed to src/annotation/annotations/requires.js

@@ -106,8 +106,8 @@ module.exports = {
           all = all.concat(variables);
 
       // Merge in user supplyed requires if there are any
-      if (item.require && item.require.length > 0){
-        all = all.concat(item.require);
+      if (item.requires && item.requires.length > 0){
+        all = all.concat(item.requires);
       }
 
       if (all.length > 0){
@@ -118,8 +118,8 @@ module.exports = {
 
   resolve: function (byTypeAndName) {
     utils.eachItem(byTypeAndName, function (item) {
-      if (utils.isset(item.require)) {
-        item.require = item.require.map(function (req) {
+      if (utils.isset(item.requires)) {
+        item.requires = item.requires.map(function (req) {
           if (req.external === true) {
             return req;
           }
@@ -153,7 +153,7 @@ module.exports = {
           return req;
         });
 
-        item.require.toJSON = utils.mapArray.bind(null, item.require,
+        item.requires.toJSON = utils.mapArray.bind(null, item.requires,
           function (item) {
             var obj = {
               type: item.type,
@@ -175,5 +175,5 @@ module.exports = {
 
   },
 
-  alias: ['requires']
+  alias: ['require']
 };

src/annotation/annotations/return.js renamed to src/annotation/annotations/returns.js

@@ -26,7 +26,7 @@ module.exports = {
     return obj;
   },
 
-  alias: ['returns'],
+  alias: ['return'],
 
   allowedOn : ['function']
 };

src/annotation/annotations/throw.js renamed to src/annotation/annotations/throws.js

@@ -16,6 +16,6 @@ module.exports = {
       return throwing;
     }
   },
-  alias: ['throws', 'exception'],
+  alias: ['throw', 'exception'],
   allowedOn: ['function', 'mixin', 'placeholder']
 };

src/annotation/annotations/todo.js renamed to src/annotation/annotations/todos.js

@@ -4,5 +4,5 @@ module.exports = {
   parse: function (text) {
     return text.trim();
   },
-  alias: ['todos']
+  alias: ['todo']
 };

test/annotations/parameter.test.js renamed to test/annotations/parameters.test.js

@@ -3,8 +3,8 @@
 
 var assert = require('assert');
 
-describe('#parameter', function () {
-  var param = (new (require('../../src/annotation'))()).list.parameter;
+describe('#parameters', function () {
+  var param = (new (require('../../src/annotation'))()).list.parameters;
 
   it('should return an object', function () {
     assert.deepEqual(param.parse('{type} $hyphenated-name (default) - description'), { type: 'type', name: 'hyphenated-name', default: 'default', description: 'description' });

test/annotations/property.test.js renamed to test/annotations/prop.test.js

@@ -3,8 +3,8 @@
 
 var assert = require('assert');
 
-describe('#property', function () {
-  var prop = (new (require('../../src/annotation'))()).list.property;
+describe('#prop', function () {
+  var prop = (new (require('../../src/annotation'))()).list.prop;
 
   it('should parse the prop annotation', function () {
     assert.deepEqual(prop.parse('base'), {

test/annotations/require.test.js renamed to test/annotations/requires.test.js

@@ -3,8 +3,8 @@
 
 var assert = require('assert');
 
-describe('#require', function () {
-  var requires = (new (require('../../src/annotation'))()).list.require;
+describe('#requires', function () {
+  var requires = (new (require('../../src/annotation'))()).list.requires;
 
   it('should default to function', function () {
     assert.deepEqual(requires.parse('name - description'), { type: 'function', name: 'name', description: 'description', 'external': false });

test/annotations/return.test.js renamed to test/annotations/returns.test.js

@@ -3,8 +3,8 @@
 
 var assert = require('assert');
 
-describe('#return', function () {
-  var returns = (new (require('../../src/annotation'))()).list.return;
+describe('#parameters', function () {
+  var returns = (new (require('../../src/annotation'))()).list.returns;
 
   it('should return an object', function () {
     assert.deepEqual(returns.parse('{type} $hyphenated-name (default) - description'), { type: 'type', name: 'hyphenated-name', default: 'default', description: 'description' });

test/annotations/throw.test.js

@@ -0,0 +1,15 @@
+/* global describe, it */
+'use strict';
+
+var assert = require('assert');
+
+describe('#throws', function () {
+  var _throws = (new (require('../../src/annotation'))()).list.throws;
+
+  it('should return the trimmed string', function () {
+    assert.equal(_throws.parse('   '), '');
+    assert.equal(_throws.parse('   '), '');
+    assert.equal(_throws.parse('\ntest\t'), 'test');
+    assert.equal(_throws.parse('\nte\nst\t'), 'te\nst');
+  });
+});

test/annotations/throws.test.js

@@ -0,0 +1,15 @@
+/* global describe, it */
+'use strict';
+
+var assert = require('assert');
+
+describe('#throws', function () {
+  var todos = (new (require('../../src/annotation'))()).list.todos;
+
+  it('should return the trimmed string', function () {
+    assert.equal(todos.parse('   '), '');
+    assert.equal(todos.parse('   '), '');
+    assert.equal(todos.parse('\ntest\t'), 'test');
+    assert.equal(todos.parse('\nte\nst\t'), 'te\nst');
+  });
+});

test/annotations/todo.test.js

@@ -11,7 +11,7 @@
           "end": 6
         }
       },
-      "parameter": [
+      "parameters": [
         {
           "type": "String",
           "name": "foo",
@@ -37,4 +37,4 @@
       }
     }
   }
-}
+}

test/annotations/todos.test.js

@@ -0,0 +1,6 @@
+
+/**
+ * @param {String} $foo - the foo parameter
+ * @param {Map | Arglist} $bar - the bar parameter
+ */
+@function test-function-param($foo, $bar) {}

test/data/fixture/parameter/expected.json renamed to test/data/fixture/param/expected.json

@@ -15,7 +15,7 @@
       "type": [
         "Map"
       ],
-      "property": [
+      "prop": [
         {
           "type": "String",
           "name": "foo",
@@ -43,4 +43,4 @@
       }
     }
   }
-}
+}

test/data/fixture/param/input.scss

@@ -11,7 +11,7 @@
           "end": 5
         }
       },
-      "require": [
+      "requires": [
         {
           "type": "function",
           "name": "test-function-required",
@@ -70,4 +70,4 @@
       ]
     }
   }
-}
+}

test/data/fixture/parameter/input.scss

@@ -1,6 +1,6 @@
 
 /**
- * @require test-function-required
+ * @requires test-function-required
  */
 @function test-function-requires() {}
 

test/data/fixture/property/expected.json renamed to test/data/fixture/prop/expected.json

@@ -11,7 +11,7 @@
           "end": 5
         }
       },
-      "return": [
+      "returns": [
         {
           "type": "String",
           "description": "A description fo returns"
@@ -31,4 +31,4 @@
       }
     }
   }
-}
+}

test/data/fixture/property/input.scss renamed to test/data/fixture/prop/input.scss

@@ -11,7 +11,7 @@
           "end": 5
         }
       },
-      "throw": [
+      "throws": [
         "Error warn you on wrong argument type"
       ],
       "access": [
@@ -28,4 +28,4 @@
       }
     }
   }
-}
+}

test/data/fixture/require/expected.json renamed to test/data/fixture/requires/expected.json

@@ -11,7 +11,7 @@
           "end": 5
         }
       },
-      "todo": [
+      "todos": [
         "Improve that function"
       ],
       "access": [
@@ -28,4 +28,4 @@
       }
     }
   }
-}
+}

test/data/fixture/require/input.scss renamed to test/data/fixture/requires/input.scss

@@ -3,11 +3,11 @@
 
 var assert = require('assert');
 
-describe('#parameter', function () {
+describe('#param', function () {
   var getData = require('../../src/file').getData;
 
-  var expected = require('./fixture/parameter/expected');
-  var input = 'test/data/fixture/parameter';
+  var expected = require('./fixture/param/expected');
+  var input = 'test/data/fixture/param';
   var data;
 
   before(function (done) {

test/data/fixture/return/expected.json renamed to test/data/fixture/returns/expected.json

@@ -3,11 +3,11 @@
 
 var assert = require('assert');
 
-describe('#property', function () {
+describe('#prop', function () {
   var getData = require('../../src/file').getData;
 
-  var expected = require('./fixture/property/expected');
-  var input = 'test/data/fixture/property';
+  var expected = require('./fixture/prop/expected');
+  var input = 'test/data/fixture/prop';
   var data;
 
   before(function (done) {

test/data/fixture/return/input.scss renamed to test/data/fixture/returns/input.scss

@@ -4,11 +4,11 @@
 var assert = require('assert');
 var _ = require('lodash');
 
-describe('#require', function () {
+describe('#requires', function () {
   var getData = require('../../src/file').getData;
 
-  var expected = require('./fixture/require/expected');
-  var input = 'test/data/fixture/require';
+  var expected = require('./fixture/requires/expected');
+  var input = 'test/data/fixture/requires';
   var data;
 
   before(function (done) {
@@ -30,12 +30,12 @@ describe('#require', function () {
     var requires = dataClone['function']['test-function-requires'];
     var required = dataClone['function']['test-function-required'];
 
-    assert.equal(requires.require[0].item, required);
+    assert.equal(requires.requires[0].item, required);
     assert.equal(required.usedBy[0], requires);
 
     // Remove circular structure from the clone
-    delete requires.require.toJSON;
-    delete requires.require[0].item;
+    delete requires.requires.toJSON;
+    delete requires.requires[0].item;
     delete required.usedBy.toJSON;
 
     // Include the reference

test/data/fixture/throw/expected.json renamed to test/data/fixture/throws/expected.json

@@ -6,8 +6,8 @@ var assert = require('assert');
 describe('#returns', function () {
   var getData = require('../../src/file').getData;
 
-  var expected = require('./fixture/return/expected');
-  var input = 'test/data/fixture/return';
+  var expected = require('./fixture/returns/expected');
+  var input = 'test/data/fixture/returns';
   var data;
 
   before(function (done) {

test/data/fixture/throw/input.scss renamed to test/data/fixture/throws/input.scss

@@ -6,8 +6,8 @@ var assert = require('assert');
 describe('#throws', function () {
   var getData = require('../../src/file').getData;
 
-  var expected = require('./fixture/throw/expected');
-  var input = 'test/data/fixture/throw';
+  var expected = require('./fixture/throws/expected');
+  var input = 'test/data/fixture/throws';
   var data;
 
   before(function (done) {