feat: use eslint-plugin-jsdoc #555 (#556)

* feat: use `eslint-plugin-jsdoc` #555 * fix: fix lint errors
Robot-Inventor · Mar 15, 2024 · b706013 · b706013
1 parent 1b8f3da
commit b706013
Show file tree

Hide file tree

Showing 7 changed files with 113 additions and 7 deletions.
diff --git a/.eslintrc.json b/.eslintrc.json
@@ -3,11 +3,13 @@
         "eslint:all",
         "plugin:@typescript-eslint/recommended",
         "plugin:@typescript-eslint/recommended-requiring-type-checking",
+        "plugin:jsdoc/recommended-typescript-error",
         "prettier"
     ],
     "parser": "@typescript-eslint/parser",
     "plugins": [
-        "@typescript-eslint"
+        "@typescript-eslint",
+        "jsdoc"
     ],
     "root": true,
     "parserOptions": {

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -59,6 +59,7 @@
   "devDependencies": {
     "@types/addons-linter": "^6.16.0",
     "@types/webextension-polyfill": "^0.10.4",
+    "eslint-plugin-jsdoc": "^48.2.1",
     "knip": "^5.0.0"
   }
 }
diff --git a/src/ts/background.ts b/src/ts/background.ts
@@ -23,7 +23,6 @@ const onUpdated = (details: browser.Runtime.OnInstalledDetailsType, isJapanese:
 /**
  * This function is called when the extension is installed.
  * This function opens the onboarding page.
- * @param isJapanese if the user's language is Japanese
  */
 const onInstalled = (): void => {
     const url = browser.runtime.getURL(ONBOARDING_PATH);

diff --git a/src/ts/components/sbsMessage.ts b/src/ts/components/sbsMessage.ts
@@ -44,10 +44,6 @@ class SbsMessage extends LitElement {
     @property({ reflect: true, type: String })
     public textColor = "white";
 
-    /**
-     * This is a comment to disable Knip.
-     * @public
-     */
     public static styles = css`
         * {
             font-family: sans-serif;

diff --git a/src/ts/core/parser/parserBase.ts b/src/ts/core/parser/parserBase.ts
@@ -16,6 +16,7 @@ class ParserBase {
 
     /**
      * Get the React props.
+     * @param element element to parse
      * @returns React props
      */
     protected getProps(element: Element = this.sourceElement): unknown {

diff --git a/src/ts/core/translationKeyProvider.ts b/src/ts/core/translationKeyProvider.ts
@@ -16,7 +16,7 @@ class TranslationKeyProvider {
 
     /**
      * Get the message summary from the tweet analysis result.
-     * @param status tweet analysis result
+     * @param analyzer tweet analysis result
      * @returns message summary
      */
     private static summarizeForTweet(analyzer: TweetAnalysisResult): TranslationKey {
@@ -61,6 +61,11 @@ class TranslationKeyProvider {
         return formattedText;
     }
 
+    /**
+     * Get the account details from the tweet analysis result.
+     * @param analyzer tweet analysis result
+     * @returns account details
+     */
     private static getAccountDetails(analyzer: TweetAnalysisResult): SbsMessageDetails {
         const accountStatus = analyzer.user.shadowbanned
             ? "accountIsShadowbannedOrFlaggedAsSensitive"