feat(lint): check descriptions of static members

Author: caugner

lint/linter/test-descriptions.js

@@ -79,6 +79,19 @@ const processApiData = (data, path, errors) => {
       `\`${featureName.replace('_permission', '')}\` permission`,
       errors,
     );
+  } else if (featureName.endsWith('_static')) {
+    const memberName = featureName.slice(0, -'_static'.length);
+    const methodForm = `\`${memberName}()\` static method`;
+    const propertyForm = `\`${memberName}\` static property`;
+    const actual = data.description || '';
+    if (!actual.startsWith(methodForm) && !actual.startsWith(propertyForm)) {
+      errors.push({
+        ruleName: 'static',
+        path,
+        actual,
+        expected: methodForm,
+      });
+    }
   } else if (featureName == 'secure_context_required') {
     checkDescription(
       'secure context required',

lint/linter/test-descriptions.test.js

@@ -69,6 +69,86 @@ describe('test-descriptions', () => {
       );
     });
 
+    it('should check description for static method', () => {
+      const path = 'api.Interface.create_static';
+      /** @type {CompatStatement} */
+      const data = {
+        description: '',
+        support: {},
+      };
+
+      const errors = processData(data, 'api', path);
+      assert.equal(errors.length, 1);
+      assert.equal(
+        /** @type {DescriptionError} */ (errors[0]).ruleName,
+        'static',
+      );
+    });
+
+    it('should accept static method description', () => {
+      const path = 'api.Interface.create_static';
+      /** @type {CompatStatement} */
+      const data = {
+        description: '`create()` static method',
+        support: {},
+      };
+
+      const errors = processData(data, 'api', path);
+      assert.equal(errors.length, 0);
+    });
+
+    it('should accept static property description', () => {
+      const path = 'api.Interface.maxActions_static';
+      /** @type {CompatStatement} */
+      const data = {
+        description: '`maxActions` static property',
+        support: {},
+      };
+
+      const errors = processData(data, 'api', path);
+      assert.equal(errors.length, 0);
+    });
+
+    it('should accept static method description with trailing context', () => {
+      const path = 'api.console.exception_static';
+      /** @type {CompatStatement} */
+      const data = {
+        description: '`exception()` static method (an alias for `error()`)',
+        support: {},
+      };
+
+      const errors = processData(data, 'api', path);
+      assert.equal(errors.length, 0);
+    });
+
+    it('should reject static description with wrong name', () => {
+      const path = 'api.Interface.only_static';
+      /** @type {CompatStatement} */
+      const data = {
+        description: '`lowerBound()` static method',
+        support: {},
+      };
+
+      const errors = processData(data, 'api', path);
+      assert.equal(errors.length, 1);
+      assert.equal(
+        /** @type {DescriptionError} */ (errors[0]).ruleName,
+        'static',
+      );
+    });
+
+    it('should ignore _static_property suffix', () => {
+      const path = 'api.Interface.disabledFeatures_static_property';
+      /** @type {CompatStatement} */
+      const data = {
+        description: 'Supports `disabledFeatures` static property',
+        support: {},
+      };
+
+      const errors = processData(data, 'api', path);
+      assert.equal(errors.length, 0);
+    });
+
     it('should check description for secure context required', () => {
       const path = 'api.Interface.secure_context_required';
       /** @type {CompatStatement} */