Merge pull request #1417 from OpenGeoscience/update-eslint-jsdoc

docs: Update eslint jsdoc

Author: manthey

.git-blame-ignore-revs

@@ -0,0 +1,9 @@
+# This file contains a list of commits that are not likely what
+# you are looking for in `git blame`. You can set this file as
+# a default ignore file for blame by running the following
+# command.
+#
+# $ git config blame.ignoreRevsFile .git-blame-ignore-revs
+
+# jsdoc linting updates
+f39996085682acc91ef3474bb2c3732dd9646c04

eslint.config.js

@@ -71,7 +71,7 @@ module.exports = [
   }, {
     files: ['src/**/*.js'],
     plugins: {
-      jsdoc,
+      jsdoc, 'jsdoc-overrides': require('./jsdoc/linting')
     },
     rules: {
       'jsdoc/check-types': ['warn', {
@@ -88,9 +88,13 @@ module.exports = [
       'jsdoc/check-param-names': 'off',
       'jsdoc/check-tag-names': 'off',
       'jsdoc/no-undefined-types': 'off',
+      'jsdoc/reject-any-type': 'off',
+      'jsdoc/reject-function-type': 'off',
       'jsdoc/require-param-description': 'off',
       'jsdoc/require-returns-description': 'off',
       'jsdoc/tag-lines': 'off',
+      'jsdoc/valid-types': 'off',
+      'jsdoc-overrides/valid-types': 'warn',
       'no-console': 'error',
     }
   }, {
@@ -104,6 +108,7 @@ module.exports = [
       'jsdoc/no-defaults': 'off',
       'jsdoc/no-multi-asterisks': 'off',
       'jsdoc/no-undefined-types': 'off',
+      'jsdoc/reject-function-type': 'off',
       'jsdoc/require-jsdoc': 'off',
       'jsdoc/require-param': 'off',
       'jsdoc/require-param-description': 'off',

examples/blog-lines/main.js

@@ -245,7 +245,7 @@ function updateSelect() {
  * @param {string|number|undefined} defaultValue: the value to return if the
  *      specified value is null, undefined, or the empty string.
  * @param {boolean} isString: if falsy, convert values to floats.
- * @returns {string|number|function}: a converted value.
+ * @returns {string|number|Function}: a converted value.
  */
 function getStyleParam(val, defaultValue, isString) {
   'use strict';

examples/build-utils.js

@@ -103,7 +103,7 @@ function writeYamlList(dir, filename, records) {
  *
  * @param {string} sourceFile The path of the javascript file being processed.
  * @param {string} outputPath The output directory.
- * @returns {function} A function to call from docco to fix the results.
+ * @returns {Function} A function to call from docco to fix the results.
  */
 function fixupDocco(sourceFile, outputPath) {
   return function () {

examples/lines/main.js

@@ -256,7 +256,7 @@ $(function () {
    *    cycle across lines.  Without that prefix, these are applied in a cycle
    *    across vertices.  If neither { or , are in the value, then the value is
    *    used as is, uniformly.
-   * @return {string|function} the style string or function.
+   * @return {string|Function} the style string or function.
    */
   function getStyle(key, value) {
     if (value === undefined || value === null || value === '') {

jsdoc/linting.js

@@ -0,0 +1,28 @@
+module.exports.rules = {
+  'valid-types': {
+    meta: {
+      docs: {
+        description: 'Override jsdoc/valid-types to ignore typedef names',
+        category: 'Best Practices',
+        recommended: false,
+      },
+      type: 'problem',
+      fixable: null,
+      schema: [], // we just delegate to original rule
+    },
+    create(context) {
+      // Load the original rule
+      const originalRule = require('eslint-plugin-jsdoc').rules['valid-types'];
+      const original = originalRule.create(context);
+      return {
+        JSDoc: (node) => {
+          const tags = (node.tags || []).filter(tag => {
+            if (tag.tag !== 'typedef') return true;
+            return (tag.name || '').startsWith('geo.');
+          });
+          if (tags.length) original.JSDoc({ ...node, tags });
+        },
+      };
+    },
+  },
+};

karma-base.js

@@ -79,7 +79,7 @@ function getScreenImage(name, left, top, width, height) {
  * @param {string} image: a base64 encoded png image.
  * @param {number} threshold: allowed difference between this image and the
  *    base image.
- * @param {function} callback: a function to call when complete.
+ * @param {Function} callback: a function to call when complete.
  */
 function compareImage(name, image, threshold, callback) {
   var resemble = require('resemblejs');