support the nosideeffects tag (Closure Compiler only) (jsdoc#605)

ammanvedi · Jul 22, 2017 · 7738610 · 7738610
1 parent 2f99af8
commit 7738610
Show file tree

Hide file tree

Showing 3 changed files with 32 additions and 0 deletions.
diff --git a/lib/jsdoc/tag/dictionary/definitions.js b/lib/jsdoc/tag/dictionary/definitions.js
@@ -931,6 +931,12 @@ exports.closureTags = {
         onTagged: ignore
     },
     // Closure Compiler only
+    nosideeffects: {
+        onTagged: function(doclet) {
+            doclet.modifies = [];
+        }
+    },
+    // Closure Compiler only
     override: {
         mustNotHaveValue: true,
         onTagged: function(doclet) {

diff --git a/test/fixtures/nosideeffectstag.js b/test/fixtures/nosideeffectstag.js
@@ -0,0 +1,5 @@
+/**
+ * A function that does nothing.
+ * @nosideeffects
+ */
+function doNothing() {}
diff --git a/test/specs/tags/nosideeffectstag.js b/test/specs/tags/nosideeffectstag.js
@@ -0,0 +1,21 @@
+'use strict';
+
+describe('@nosideeffects tag', function() {
+    afterEach(function() {
+        jasmine.restoreTagDictionary();
+    });
+
+    describe('Closure Compiler tags', function() {
+        beforeEach(function() {
+            jasmine.replaceTagDictionary('closure');
+        });
+
+        it('should set the doclet\'s `modifies` property to an empty array', function() {
+            var docSet = jasmine.getDocSetFromFile('test/fixtures/nosideeffectstag.js');
+            var doNothing = docSet.getByLongname('doNothing')[0];
+
+            expect(Array.isArray(doNothing.modifies)).toBe(true);
+            expect(doNothing.modifies.length).toBe(0);
+        });
+    });
+});