Update links to eslint-plugin-jsdoc

remcohaszing · Aug 5, 2023 · 648c0d1 · 648c0d1
1 parent 16f0631
commit 648c0d1
Showing 1 changed file with 53 additions and 53 deletions.
diff --git a/plugins/jsdoc.js b/plugins/jsdoc.js
@@ -69,19 +69,19 @@ module.exports = {
   },
   rules: {
     /**
-     * https://github.com/gajus/eslint-plugin-jsdoc/blob/master/.README/rules/check-access.md
+     * https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/check-access.md
      */
     'jsdoc/check-access': 'error',
 
     /**
-     * https://github.com/gajus/eslint-plugin-jsdoc/blob/master/.README/rules/check-alignment.md
+     * https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/check-alignment.md
      *
      * Prettier.
      */
     'jsdoc/check-alignment': 'off',
 
     /**
-     * https://github.com/gajus/eslint-plugin-jsdoc/blob/master/.README/rules/check-examples.md
+     * https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/check-examples.md
      *
      * @see https://github.com/gajus/eslint-plugin-jsdoc/releases/tag/v37.0.0
      */
@@ -91,75 +91,75 @@ module.exports = {
     ],
 
     /**
-     * https://github.com/gajus/eslint-plugin-jsdoc/blob/master/.README/rules/check-indentation.md
+     * https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/check-indentation.md
      */
     'jsdoc/check-indentation': [
       'error',
       { excludeTags: ['example', 'param', 'returns', 'throws', 'todo'] }
     ],
 
     /**
-     * https://github.com/gajus/eslint-plugin-jsdoc/blob/master/.README/rules/check-line-alignment.md
+     * https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/check-line-alignment.md
      */
     'jsdoc/check-line-alignment': ['error', 'never', { wrapIndent: '  ' }],
 
     /**
-     * https://github.com/gajus/eslint-plugin-jsdoc/blob/master/.README/rules/check-param-names.md
+     * https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/check-param-names.md
      */
     'jsdoc/check-param-names': ['error', { checkDestructured: false }],
 
     /**
-     * https://github.com/gajus/eslint-plugin-jsdoc/blob/master/.README/rules/check-property-names.md
+     * https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/check-property-names.md
      */
     'jsdoc/check-property-names': 'off',
 
     /**
-     * https://github.com/gajus/eslint-plugin-jsdoc/blob/master/.README/rules/check-syntax.md
+     * https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/check-syntax.md
      */
     'jsdoc/check-syntax': 'off',
 
     /**
-     * https://github.com/gajus/eslint-plugin-jsdoc/blob/master/.README/rules/check-tag-names.md
+     * https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/check-tag-names.md
      */
     'jsdoc/check-tag-names': ['error', { jsxTags: true }],
 
     /**
-     * https://github.com/gajus/eslint-plugin-jsdoc/blob/master/.README/rules/check-types.md
+     * https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/check-types.md
      */
     'jsdoc/check-types': 'off',
 
     /**
-     * https://github.com/gajus/eslint-plugin-jsdoc/blob/master/.README/rules/check-values.md
+     * https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/check-values.md
      */
     'jsdoc/check-values': 'off',
 
     /**
-     * https://github.com/gajus/eslint-plugin-jsdoc/blob/master/.README/rules/empty-tags.md
+     * https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/empty-tags.md
      */
     'jsdoc/empty-tags': 'error',
 
     /**
-     * https://github.com/gajus/eslint-plugin-jsdoc/blob/master/.README/rules/imports-as-dependencies.md
+     * https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/imports-as-dependencies.md
      */
     'jsdoc/imports-as-dependencies': 'off',
 
     /**
-     * https://github.com/gajus/eslint-plugin-jsdoc/blob/master/.README/rules/implements-on-classes.md
+     * https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/implements-on-classes.md
      */
     'jsdoc/implements-on-classes': 'off',
 
     /**
-     * https://github.com/gajus/eslint-plugin-jsdoc/blob/master/.README/rules/informative-docs.md
+     * https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/informative-docs.md
      */
     'jsdoc/informative-docs': 'off',
 
     /**
-     * https://github.com/gajus/eslint-plugin-jsdoc/blob/master/.README/rules/match-description.md
+     * https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/match-description.md
      */
     'jsdoc/match-description': 'off',
 
     /**
-     * https://github.com/gajus/eslint-plugin-jsdoc/blob/master/.README/rules/match-name.md
+     * https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/match-name.md
      */
     'jsdoc/match-name': [
       'error',
@@ -175,7 +175,7 @@ module.exports = {
     ],
 
     /**
-     * https://github.com/gajus/eslint-plugin-jsdoc/blob/master/.README/rules/multiline-blocks.md
+     * https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/multiline-blocks.md
      */
     'jsdoc/multiline-blocks': [
       'error',
@@ -187,82 +187,82 @@ module.exports = {
     ],
 
     /**
-     * https://github.com/gajus/eslint-plugin-jsdoc/blob/master/.README/rules/no-blank-block-descriptions.md
+     * https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/no-blank-block-descriptions.md
      */
     'jsdoc/no-blank-block-descriptions': 'error',
 
     /**
-     * https://github.com/gajus/eslint-plugin-jsdoc/blob/master/.README/rules/no-blank-blocks.md
+     * https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/no-blank-blocks.md
      */
     'jsdoc/no-blank-blocks': 'error',
 
     /**
-     * https://github.com/gajus/eslint-plugin-jsdoc/blob/master/.README/rules/no-bad-blocks.md
+     * https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/no-bad-blocks.md
      */
     'jsdoc/no-bad-blocks': 'error',
 
     /**
-     * https://github.com/gajus/eslint-plugin-jsdoc/blob/master/.README/rules/no-defaults.md
+     * https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/no-defaults.md
      */
     'jsdoc/no-defaults': 'error',
 
     /**
-     * https://github.com/gajus/eslint-plugin-jsdoc/blob/master/.README/rules/no-missing-syntax.md
+     * https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/no-missing-syntax.md
      */
     'jsdoc/no-missing-syntax': 'off',
 
     /**
-     * https://github.com/gajus/eslint-plugin-jsdoc/blob/master/.README/rules/no-multi-asterisks.md
+     * https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/no-multi-asterisks.md
      */
     'jsdoc/no-multi-asterisks': 'error',
 
     /**
-     * https://github.com/gajus/eslint-plugin-jsdoc/blob/master/.README/rules/no-restricted-syntax.md
+     * https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/no-restricted-syntax.md
      */
     'jsdoc/no-restricted-syntax': 'off',
 
     /**
-     * https://github.com/gajus/eslint-plugin-jsdoc/blob/master/.README/rules/no-types.md
+     * https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/no-types.md
      */
     'jsdoc/no-types': 'off',
 
     /**
-     * https://github.com/gajus/eslint-plugin-jsdoc/blob/master/.README/rules/no-undefined-types.md
+     * https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/no-undefined-types.md
      */
     'jsdoc/no-undefined-types': 'error',
 
     /**
-     * https://github.com/gajus/eslint-plugin-jsdoc/blob/master/.README/rules/require-asterisk-prefix.md
+     * https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-asterisk-prefix.md
      */
     'jsdoc/require-asterisk-prefix': 'error',
 
     /**
-     * https://github.com/gajus/eslint-plugin-jsdoc/blob/master/.README/rules/require-description.md
+     * https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-description.md
      */
     'jsdoc/require-description': 'error',
 
     /**
-     * https://github.com/gajus/eslint-plugin-jsdoc/blob/master/.README/rules/require-description-complete-sentence.md
+     * https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-description-complete-sentence.md
      */
     'jsdoc/require-description-complete-sentence': 'off',
 
     /**
-     * https://github.com/gajus/eslint-plugin-jsdoc/blob/master/.README/rules/require-example.md
+     * https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-example.md
      */
     'jsdoc/require-example': 'off',
 
     /**
-     * https://github.com/gajus/eslint-plugin-jsdoc/blob/master/.README/rules/require-file-overview.md
+     * https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-file-overview.md
      */
     'jsdoc/require-file-overview': 'off',
 
     /**
-     * https://github.com/gajus/eslint-plugin-jsdoc/blob/master/.README/rules/require-hyphen-before-param-description.md
+     * https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-hyphen-before-param-description.md
      */
     'jsdoc/require-hyphen-before-param-description': ['error', 'never'],
 
     /**
-     * https://github.com/gajus/eslint-plugin-jsdoc/blob/master/.README/rules/require-jsdoc.md
+     * https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-jsdoc.md
      */
     'jsdoc/require-jsdoc': [
       'error',
@@ -277,7 +277,7 @@ module.exports = {
     ],
 
     /**
-     * https://github.com/gajus/eslint-plugin-jsdoc/blob/master/.README/rules/require-param.md
+     * https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-param.md
      */
     'jsdoc/require-param': [
       'error',
@@ -290,92 +290,92 @@ module.exports = {
     ],
 
     /**
-     * https://github.com/gajus/eslint-plugin-jsdoc/blob/master/.README/rules/require-param-description.md
+     * https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-param-description.md
      */
     'jsdoc/require-param-description': 'error',
 
     /**
-     * https://github.com/gajus/eslint-plugin-jsdoc/blob/master/.README/rules/require-param-name.md
+     * https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-param-name.md
      */
     'jsdoc/require-param-name': 'error',
 
     /**
-     * https://github.com/gajus/eslint-plugin-jsdoc/blob/master/.README/rules/require-param-type.md
+     * https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-param-type.md
      */
     'jsdoc/require-param-type': 'error',
 
     /**
-     * https://github.com/gajus/eslint-plugin-jsdoc/blob/master/.README/rules/require-property.md
+     * https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-property.md
      */
     'jsdoc/require-property': 'off',
 
     /**
-     * https://github.com/gajus/eslint-plugin-jsdoc/blob/master/.README/rules/require-property-description.md
+     * https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-property-description.md
      */
     'jsdoc/require-property-description': 'off',
 
     /**
-     * https://github.com/gajus/eslint-plugin-jsdoc/blob/master/.README/rules/require-property-name.md
+     * https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-property-name.md
      */
     'jsdoc/require-property-name': 'off',
 
     /**
-     * https://github.com/gajus/eslint-plugin-jsdoc/blob/master/.README/rules/require-property-type.md
+     * https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-property-type.md
      */
     'jsdoc/require-property-type': 'error',
 
     /**
-     * https://github.com/gajus/eslint-plugin-jsdoc/blob/master/.README/rules/require-returns.md
+     * https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-returns.md
      */
     'jsdoc/require-returns': ['error', { contexts: [METHOD_DEFINITION, NON_COMPONENT_FUNCTION] }],
 
     /**
-     * https://github.com/gajus/eslint-plugin-jsdoc/blob/master/.README/rules/require-returns-check.md
+     * https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-returns-check.md
      */
     'jsdoc/require-returns-check': 'error',
 
     /**
-     * https://github.com/gajus/eslint-plugin-jsdoc/blob/master/.README/rules/require-returns-description.md
+     * https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-returns-description.md
      */
     'jsdoc/require-returns-description': 'error',
 
     /**
-     * https://github.com/gajus/eslint-plugin-jsdoc/blob/master/.README/rules/require-returns-type.md
+     * https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-returns-type.md
      */
     'jsdoc/require-returns-type': 'error',
 
     /**
-     * https://github.com/gajus/eslint-plugin-jsdoc/blob/master/.README/rules/require-throws.md
+     * https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-throws.md
      */
     'jsdoc/require-throws': 'off',
 
     /**
-     * https://github.com/gajus/eslint-plugin-jsdoc/blob/master/.README/rules/require-yields.md
+     * https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-yields.md
      */
     'jsdoc/require-yields': 'error',
 
     /**
-     * https://github.com/gajus/eslint-plugin-jsdoc/blob/master/.README/rules/require-yields-check.md
+     * https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-yields-check.md
      */
     'jsdoc/require-yields-check': 'error',
 
     /**
-     * https://github.com/gajus/eslint-plugin-jsdoc/blob/master/.README/rules/sort-tags.md
+     * https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/sort-tags.md
      */
     'jsdoc/sort-tags': ['error', { alphabetizeExtras: true }],
 
     /**
-     * https://github.com/gajus/eslint-plugin-jsdoc/blob/master/.README/rules/tag-lines.md
+     * https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/tag-lines.md
      */
     'jsdoc/tag-lines': ['error', 'never', { applyToEndTag: false, startLines: 1, endLines: 0 }],
 
     /**
-     * https://github.com/gajus/eslint-plugin-jsdoc/blob/master/.README/rules/text-escaping.md
+     * https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/text-escaping.md
      */
     'jsdoc/text-escaping': 'off',
 
     /**
-     * https://github.com/gajus/eslint-plugin-jsdoc/blob/master/.README/rules/valid-types.md
+     * https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/valid-types.md
      */
     'jsdoc/valid-types': 'error'
   }