fix: event declaration additional tags (#253)

* fix: event declaration additional tags.

* add a test for create a tag-only comment.

Author: tr2-harada

src/module-declaration.ts

@@ -180,7 +180,11 @@ export const generateModuleDeclaration = (
           listener = `(${args.join(`,\n${indent}`)}) => void`;
         }
 
-        for (let method of ['on', 'off', 'once', 'addListener', 'removeListener']) {
+        const methods = ['on', 'off', 'once', 'addListener', 'removeListener'];
+        for (const method of methods) {
+          if (methods.indexOf(method) > 0) {
+            utils.extendArray(moduleAPI, utils.wrapComment('', moduleEvent.additionalTags));
+          }
           moduleAPI.push(`${method}(event: '${moduleEvent.name}', listener: ${listener}): this;`);
         }
       });
@@ -220,7 +224,11 @@ export const generateModuleDeclaration = (
           );
         }
 
-        for (let method of ['addEventListener', 'removeEventListener']) {
+        const methods = ['addEventListener', 'removeEventListener'];
+        for (const method of methods) {
+          if (methods.indexOf(method) > 0) {
+            utils.extendArray(moduleAPI, utils.wrapComment('', domEvent.additionalTags));
+          }
           moduleAPI.push(
             `${method}(event: '${domEvent.name}', listener: (event: ${eventType}) => void${
               method === 'addEventListener' ? ', useCapture?: boolean' : ''

test/utils_spec.js

@@ -1,5 +1,6 @@
 const expect = require('chai').expect;
 const utils = require('../dist/utils');
+const { DocumentationTag } = require('@electron/docs-parser');
 
 describe('utils', () => {
   describe('extendArray', () => {
@@ -56,6 +57,14 @@ describe('utils', () => {
       );
       expect(wrapped.length).equal(4);
     });
+
+    it('should create a tag-only comment', () => {
+      const wrapped = utils.wrapComment('', [DocumentationTag.STABILITY_DEPRECATED]);
+      expect(wrapped.length).equal(3);
+      expect(wrapped[0]).to.be.equal('/**');
+      expect(wrapped[1].endsWith('@deprecated')).to.eq(true);
+      expect(wrapped[wrapped.length - 1]).to.be.equal(' */');
+    });
   });
 
   describe('typify', () => {