feat: add rule check-syntax

Author: vulkd

src/index.js

@@ -1,6 +1,7 @@
 /* eslint-disable import/max-dependencies */
 import checkExamples from './rules/checkExamples';
 import checkParamNames from './rules/checkParamNames';
+import checkSyntax from './rules/checkSyntax';
 import checkTagNames from './rules/checkTagNames';
 import checkTypes from './rules/checkTypes';
 import newlineAfterDescription from './rules/newlineAfterDescription';
@@ -25,6 +26,7 @@ export default {
       rules: {
         'jsdoc/check-examples': 'off',
         'jsdoc/check-param-names': 'warn',
+        'jsdoc/check-syntax': 'off',
         'jsdoc/check-tag-names': 'warn',
         'jsdoc/check-types': 'warn',
         'jsdoc/newline-after-description': 'warn',
@@ -48,6 +50,7 @@ export default {
   rules: {
     'check-examples': checkExamples,
     'check-param-names': checkParamNames,
+    'check-syntax': checkSyntax,
     'check-tag-names': checkTagNames,
     'check-types': checkTypes,
     'newline-after-description': newlineAfterDescription,

src/rules/checkSyntax.js

@@ -0,0 +1,17 @@
+import iterateJsdoc from '../iterateJsdoc';
+
+export default iterateJsdoc(({
+  jsdoc,
+  report
+}) => {
+  if (!jsdoc.tags.length) {
+    return;
+  }
+
+  for (const tag of jsdoc.tags) {
+    if (tag.type.slice(-1) === '=') {
+      report('Syntax should not be Google Closure Compiler style.');
+      break;
+    }
+  }
+});

test/rules/assertions/checkSyntax.js

@@ -0,0 +1,31 @@
+export default {
+  invalid: [
+    {
+      code: `
+          /**
+           * @param {string=} foo
+           */
+          function quux (foo) {
+
+          }
+      `,
+      errors: [
+        {
+          message: 'Syntax should not be Google Closure Compiler style.'
+        }
+      ]
+    }
+  ],
+  valid: [
+    {
+      code: `
+          /**
+           * @param {string} [foo]
+           */
+          function quux (foo) {
+
+          }
+      `
+    }
+  ]
+};

test/rules/index.js

@@ -9,6 +9,7 @@ const ruleTester = new RuleTester();
 _.forEach([
   'check-examples',
   'check-param-names',
+  'check-syntax',
   'check-tag-names',
   'check-types',
   'newline-after-description',