Feature Request: eslint & eslint-plugin-jsdoc integration

Description

I’m attempting to integrate this plugin into my workflow, but it doesn’t seem the plugin is integrated with eslint-plugin-jsdoc, nor eslint itself.

Specifically, the lack of support for the tagNamePreference setting in eslint-plugin-jsdoc results in faulty errors regarding tags.

I’m not entirely sure, but I also suspect that the lack of integration with eslint (or maybe prettier-vscode?) means the following:

• Issues yielded by this plugin are only displayed by directly running eslint
  • If I open a file with alleged issues, my editor (VSCode) doesn’t show any red squigglies where the plugin identified the issues; I have to run eslint to get a full report
• Issues that are auto-fixable are not fixed on save
  • Normally when I save a file that has auto-fixable issues (even if the file doesn’t have any changes), those issues are fixed on save. This does not happen with issues yielded by this plugin; I have to run eslint --fix instead

Example

tagNamePreference settings:

{
    jsdoc: {
      tagNamePreference: {
        augments: 'extends',
        constant: 'const',
        fileoverview: 'file',
        returns: 'return'
      }
    }
}

Take the following file:

/**
 * @file Katas - tribonacci
 * @module katas/tribonacci
 */

/**
 * Given a starting sequence, `[a, b, c]`, the function returns an array with
 * the first `n` elements of the sequence.
 *
 * @see https://codewars.com/kata/556deca17c58da83c00002db
 *
 * @example tribonacci([1, 1, 1], 10) => [1, 1, 1, 3, 5, 9, 17, 31, 57, 105]
 * @example tribonacci([0, 0, 1], 10) => [0, 0, 1, 1, 2, 4, 7, 13, 24, 44]
 *
 * @param {[number, number, number]} args - Starting sequence
 * @param {number} n - Total number of elements in sequence
 * @return {number[]} First `n` elements of sequence
 */
const tribonacci = (
  [a, b, c]: [number, number, number],
  n: number
): number[] => {
  // Base case: If n is less than or equal to zero, return empty array
  if (n <= 0) return []

  /** @const {number} sum - Sum of {@link a}, {@link b}, and {@link c} */
  const sum: number = a + b + c

  // Generate and return sequence
  return [a, ...tribonacci([b, c, sum], n - 1)]
}

export default tribonacci

After running eslint ./src/katas/tribonacci.ts --exit-on-fatal-error --report-unused-disable-directives --fix:

/Users/lex/Projects/UNICORNWARE/katas/src/katas/tribonacci.ts
  17:11  error  Insert `s`                                                                       prettier/prettier
  26:12  error  Insert `tan`                                                                     prettier/prettier

✖ 8 problems (8 errors, 0 warnings)
  8 errors and 0 warnings potentially fixable with the `--fix` option.

• 17:11: the plugin wants me to use @returns => my settings dictate using @return
• 26:12: the plugin wants me to use @constant => my settings dictate using @const

[hosseinmd]

My suggestion is, don’t use eslint-plugin-jsdoc and prettier-plugin-jsdoc both.

[hosseinmd]

Please don’t make that a goal of this project. Its main value is consistency within a codebase and making it inflexible makes it harder to adopt into codebases. The default settings suffice to nudge people towards your chosen norms.

Yes you are totaly right. but implemention is hard, some logic was hard code,