test: another test

* CI: Avoid test workflow duplicate

* dev

* dev

.eslintrc.json

@@ -9,7 +9,8 @@
         "prettier"
     ],
     "parserOptions": {
-        "sourceType": "module"
+        "sourceType": "module",
+        "ecmaVersion": 2022
     },
     "rules": {
         // Possible Errors (overrides from recommended set)

.github/workflows/test.yml

@@ -2,7 +2,7 @@ name: Test
 on:
   push:
     branches:
-      - "*"
+      - master
   pull_request:
     branches:
       - master
@@ -33,7 +33,7 @@ jobs:
 
       - name: Run ESLint
         run: |
-          npm run lints
+          npm run lint
 
       - name: Run Prettier
         run: |

.husky/pre-commit

@@ -2,5 +2,5 @@
 . "$(dirname -- "$0")/_/husky.sh"
 
 npm test
-npm run lints
+npm run lint
 npx lint-staged

package-lock.json

@@ -5920,9 +5920,9 @@
       }
     },
     "node_modules/tough-cookie": {
-      "version": "4.1.2",
-      "resolved": "https://registry.npmjs.org/tough-cookie/-/tough-cookie-4.1.2.tgz",
-      "integrity": "sha512-G9fqXWoYFZgTc2z8Q5zaHy/vJMjm+WV0AkAeHxVCQiEB1b+dGvWzFW6QV07cY5jQ5gRkeid2qIkzkxUnmoQZUQ==",
+      "version": "4.1.3",
+      "resolved": "https://registry.npmjs.org/tough-cookie/-/tough-cookie-4.1.3.tgz",
+      "integrity": "sha512-aX/y5pVRkfRnfmuX+OdbSdXvPe6ieKX/G2s7e98f4poJHnqH3281gDPm/metm6E/WRamfx7WC4HUqkWHfQHprw==",
       "dev": true,
       "dependencies": {
         "psl": "^1.1.33",
@@ -10742,9 +10742,9 @@
       }
     },
     "tough-cookie": {
-      "version": "4.1.2",
-      "resolved": "https://registry.npmjs.org/tough-cookie/-/tough-cookie-4.1.2.tgz",
-      "integrity": "sha512-G9fqXWoYFZgTc2z8Q5zaHy/vJMjm+WV0AkAeHxVCQiEB1b+dGvWzFW6QV07cY5jQ5gRkeid2qIkzkxUnmoQZUQ==",
+      "version": "4.1.3",
+      "resolved": "https://registry.npmjs.org/tough-cookie/-/tough-cookie-4.1.3.tgz",
+      "integrity": "sha512-aX/y5pVRkfRnfmuX+OdbSdXvPe6ieKX/G2s7e98f4poJHnqH3281gDPm/metm6E/WRamfx7WC4HUqkWHfQHprw==",
       "dev": true,
       "requires": {
         "psl": "^1.1.33",

package.json

@@ -30,7 +30,7 @@
     "format": "prettier --write .",
     "format:check": "prettier --check .",
     "prepare": "husky install",
-    "lints": "npx eslint --max-warnings 0 \"./src/**.js\" \"./scripts/**.js\" \"./tests/**.js\" \"./api/**.js\" \"./themes/**.js\""
+    "lint": "npx eslint --max-warnings 0 \"./src/**.js\" \"./scripts/**.js\" \"./tests/**.js\" \"./api/**.js\" \"./themes/**.js\""
   },
   "author": "Anurag Hazra",
   "license": "MIT",

readme.md

@@ -68,6 +68,8 @@
   </p>
 </p>
 
+<p align="center">Please note that documentation translations may be outdated, try to use english documentation if possible.</p>
+
 <p align="center">Love the project? Please consider <a href="https://www.paypal.me/anuraghazra">donating</a> to help it improve!</p>
 
 <a href="https://indiafightscorona.giveindia.org">
@@ -78,7 +80,7 @@ Are you considering supporting the project by donating to me? Please DO NOT!!
 
 <img src="https://cfstatic.give.do/910ede2a-7892-43fe-8c8a-dea45e96d950.webp" alt="Picture of Coromandel Express train tragedy" width="35%">
 
-India just suffered one of the most devastating train accident and your help will be immensely valuable for the people who were effected by this tragedy.
+India just suffered one of the most devastating train accident and your help will be immensely valuable for the people who were affected by this tragedy.
 
 Please visit [this link](https://give.do/fundraisers/stand-beside-the-victims-of-the-coromandel-express-train-tragedy-in-odisha-donate-now) and make a small donation to help the people in need. A small donation goes a long way. :heart:
 
@@ -86,38 +88,38 @@ Please visit [this link](https://give.do/fundraisers/stand-beside-the-victims-of
 
 # Features <!-- omit in toc -->
 
-- [GitHub Stats Card](#github-stats-card)
-    - [Hiding individual stats](#hiding-individual-stats)
-    - [Showing additional individual stats](#showing-additional-individual-stats)
-    - [Showing icons](#showing-icons)
-    - [Themes](#themes)
-    - [Customization](#customization)
-- [GitHub Extra Pins](#github-extra-pins)
-    - [Usage](#usage)
-    - [Demo](#demo)
-- [Top Languages Card](#top-languages-card)
-    - [Usage](#usage-1)
-    - [Language stats algorithm](#language-stats-algorithm)
-    - [Exclude individual repositories](#exclude-individual-repositories)
-    - [Hide individual languages](#hide-individual-languages)
-    - [Show more languages](#show-more-languages)
-    - [Compact Language Card Layout](#compact-language-card-layout)
-    - [Donut Chart Language Card Layout](#donut-chart-language-card-layout)
-    - [Donut Vertical Chart Language Card Layout](#donut-vertical-chart-language-card-layout)
-    - [Pie Chart Language Card Layout](#pie-chart-language-card-layout)
-    - [Hide Progress Bars](#hide-progress-bars)
-    - [Demo](#demo-1)
-- [Wakatime Stats Card](#wakatime-stats-card)
-    - [Demo](#demo-2)
-- [All Demos](#all-demos)
-  - [Quick Tip (Align The Cards)](#quick-tip-align-the-cards)
-- [Deploy on your own](#deploy-on-your-own)
-  - [On Vercel](#on-vercel)
-    - [:film\_projector: Check Out Step By Step Video Tutorial By @codeSTACKr](#film_projector-check-out-step-by-step-video-tutorial-by-codestackr)
-  - [On other platforms](#on-other-platforms)
-  - [Disable rate limit protections](#disable-rate-limit-protections)
-  - [Keep your fork up to date](#keep-your-fork-up-to-date)
-- [:sparkling\_heart: Support the project](#sparkling_heart-support-the-project)
+*   [GitHub Stats Card](#github-stats-card)
+    *   [Hiding individual stats](#hiding-individual-stats)
+    *   [Showing additional individual stats](#showing-additional-individual-stats)
+    *   [Showing icons](#showing-icons)
+    *   [Themes](#themes)
+    *   [Customization](#customization)
+*   [GitHub Extra Pins](#github-extra-pins)
+    *   [Usage](#usage)
+    *   [Demo](#demo)
+*   [Top Languages Card](#top-languages-card)
+    *   [Usage](#usage-1)
+    *   [Language stats algorithm](#language-stats-algorithm)
+    *   [Exclude individual repositories](#exclude-individual-repositories)
+    *   [Hide individual languages](#hide-individual-languages)
+    *   [Show more languages](#show-more-languages)
+    *   [Compact Language Card Layout](#compact-language-card-layout)
+    *   [Donut Chart Language Card Layout](#donut-chart-language-card-layout)
+    *   [Donut Vertical Chart Language Card Layout](#donut-vertical-chart-language-card-layout)
+    *   [Pie Chart Language Card Layout](#pie-chart-language-card-layout)
+    *   [Hide Progress Bars](#hide-progress-bars)
+    *   [Demo](#demo-1)
+*   [Wakatime Stats Card](#wakatime-stats-card)
+    *   [Demo](#demo-2)
+*   [All Demos](#all-demos)
+    *   [Quick Tip (Align The Cards)](#quick-tip-align-the-cards)
+*   [Deploy on your own](#deploy-on-your-own)
+    *   [On Vercel](#on-vercel)
+        *   [:film\_projector: Check Out Step By Step Video Tutorial By @codeSTACKr](#film_projector-check-out-step-by-step-video-tutorial-by-codestackr)
+    *   [On other platforms](#on-other-platforms)
+    *   [Disable rate limit protections](#disable-rate-limit-protections)
+    *   [Keep your fork up to date](#keep-your-fork-up-to-date)
+*   [:sparkling\_heart: Support the project](#sparkling_heart-support-the-project)
 
 # Important Notice <!-- omit in toc -->
 
@@ -180,7 +182,7 @@ Use `&theme=THEME_NAME` parameter like so :
 
 #### All inbuilt themes
 
-GitHub readme stats comes with several built-in themes (e.g. `dark`, `radical`, `merko`, `gruvbox`, `tokyonight`, `onedark`, `cobalt`, `synthwave`, `highcontrast`, `dracula`).
+GitHub Readme Stats comes with several built-in themes (e.g. `dark`, `radical`, `merko`, `gruvbox`, `tokyonight`, `onedark`, `cobalt`, `synthwave`, `highcontrast`, `dracula`).
 
 <img src="https://res.cloudinary.com/anuraghazra/image/upload/v1595174536/grs-themes_l4ynja.png" alt="GitHub Readme Stats Themes" width="600px"/>
 
@@ -287,9 +289,9 @@ You can customize the appearance of your `Stats Card` or `Repo Card` however you
 *   `border_color` - Card's border color *(hex color)*. Default: `e4e2e2` (Does not apply when `hide_border` is enabled).
 *   `bg_color` - Card's background color *(hex color)* **or** a gradient in the form of *angle,start,end*. Default: `fffefe`
 *   `hide_border` - Hides the card's border *(boolean)*. Default: `false`
-*   `theme` - name of the theme, choose from [all available themes](./themes/README.md). Default: `default` theme.
-*   `cache_seconds` - set the cache header manually *(min: 14400, max: 86400)*. Default: `14400 seconds (4 hours)`.
-*   `locale` - set the language in the card *(e.g. cn, de, es, etc.)*. Default: `en`.
+*   `theme` - Name of the theme, choose from [all available themes](./themes/README.md). Default: `default` theme.
+*   `cache_seconds` - Sets the cache header manually *(min: 14400, max: 86400)*. Default: `14400 seconds (4 hours)`.
+*   `locale` - Sets the language in the card *(e.g. cn, de, es, etc.)*. Default: `en`.
 *   `border_radius` - Corner rounding on the card. Default: `4.5`.
 
 > **Warning**
@@ -305,38 +307,38 @@ You can provide multiple comma-separated values in the bg\_color option to rende
 
 *   `hide` - Hides the [specified items](#hiding-individual-stats) from stats *(Comma-separated values)*. Default: `[] (blank array)`.
 *   `hide_title` - *(boolean)*. Default: `false`.
-*   `card_width` - Set the card's width manually *(number)*. Default: `500px  (approx.)`.
+*   `card_width` - Sets the card's width manually *(number)*. Default: `500px  (approx.)`.
 *   `hide_rank` - *(boolean)* hides the rank and automatically resizes the card width. Default: `false`.
 *   `rank_icon` - Shows alternative rank icon (i.e. `github`, `percentile` or `default`). Default: `default`.
 *   `show_icons` - *(boolean)*. Default: `false`.
-*   `include_all_commits` - Count total commits instead of just the current year commits *(boolean)*. Default: `false`.
+*   `include_all_commits` - Counts total commits instead of just the current year commits *(boolean)*. Default: `false`.
 *   `line_height` - Sets the line height between text *(number)*. Default: `25`.
-*   `exclude_repo` - Exclude stars from specified repositories *(Comma-separated values)*. Default: `[] (blank array)`.
+*   `exclude_repo` - Excludes stars from specified repositories *(Comma-separated values)*. Default: `[] (blank array)`.
 *   `custom_title` - Sets a custom title for the card. Default:  `<username> GitHub Stats`.
-*   `text_bold` - Use bold text *(boolean)*. Default: `true`.
+*   `text_bold` - Uses bold text *(boolean)*. Default: `true`.
 *   `disable_animations` - Disables all animations in the card *(boolean)*. Default: `false`.
 *   `ring_color` - Color of the rank circle *(hex color)*. Defaults to the theme ring color if it exists and otherwise the title color.
-*   `number_format` - Switch between two available formats for displaying the card values `short` (i.e. `6.6k`) and `long` (i.e. `6626`). Default: `short`.
-*   `show` - Show [additional items](#showing-additional-individual-stats) on stats card (i.e. `reviews`, `discussions_started` or `discussions_answered`) *(Comma-separated values)*. Default: `[] (blank array)`.
+*   `number_format` - Switches between two available formats for displaying the card values `short` (i.e. `6.6k`) and `long` (i.e. `6626`). Default: `short`.
+*   `show` - Shows [additional items](#showing-additional-individual-stats) on stats card (i.e. `reviews`, `discussions_started` or `discussions_answered`) *(Comma-separated values)*. Default: `[] (blank array)`.
 
 > **Note**
 > When hide\_rank=`true`, the minimum card width is 270 px + the title length and padding.
 
 #### Repo Card Exclusive Options
 
-*   `show_owner` - Show the repo's owner name *(boolean)*. Default: `false`.
+*   `show_owner` - Shows the repo's owner name *(boolean)*. Default: `false`.
 
 #### Language Card Exclusive Options
 
-*   `hide` - Hide the languages specified from the card *(Comma-separated values)*. Default: `[] (blank array)`.
+*   `hide` - Hides the languages specified from the card *(Comma-separated values)*. Default: `[] (blank array)`.
 *   `hide_title` - *(boolean)*. Default: `false`.
-*   `layout` - Switch between five available layouts `normal` & `compact` & `donut` & `donut-vertical` & `pie`. Default: `normal`.
-*   `card_width` - Set the card's width manually *(number)*. Default `300`.
-*   `langs_count` - Show more languages on the card, between 1-20 *(number)*. Default: `5` for `normal` and `donut`, `6` for other layouts.
-*   `exclude_repo` - Exclude specified repositories *(Comma-separated values)*. Default: `[] (blank array)`.
+*   `layout` - Switches between five available layouts `normal` & `compact` & `donut` & `donut-vertical` & `pie`. Default: `normal`.
+*   `card_width` - Sets the card's width manually *(number)*. Default `300`.
+*   `langs_count` - Shows more languages on the card, between 1-20 *(number)*. Default: `5` for `normal` and `donut`, `6` for other layouts.
+*   `exclude_repo` - Excludes specified repositories *(Comma-separated values)*. Default: `[] (blank array)`.
 *   `custom_title` - Sets a custom title for the card *(string)*. Default `Most Used Languages`.
 *   `disable_animations` - Disables all animations in the card *(boolean)*. Default: `false`.
-*   `hide_progress` - It uses the compact layout option, hides percentages, and removes the bars. Default: `false`.
+*   `hide_progress` - Uses the compact layout option, hides percentages, and removes the bars. Default: `false`.
 *   `size_weight` - Configures language stats algorithm *(number)* (see [Language stats algorithm](#Language-stats-algorithm)), defaults to 1.
 *   `count_weight` - Configures language stats algorithm *(number)* (see [Language stats algorithm](#Language-stats-algorithm)), defaults to 0.
 
@@ -347,20 +349,20 @@ You can provide multiple comma-separated values in the bg\_color option to rende
 
 #### Wakatime Card Exclusive Options
 
-*   `hide` - Hide the languages specified from the card *(Comma-separated values)*. Default: `[] (blank array)`.
+*   `hide` - Hides the languages specified from the card *(Comma-separated values)*. Default: `[] (blank array)`.
 *   `hide_title` - *(boolean)*. Default `false`.
 *   `line_height` - Sets the line height between text *(number)*. Default `25`.
 *   `hide_progress` - Hides the progress bar and percentage *(boolean)*. Default `false`.
 *   `custom_title` - Sets a custom title for the card *(string)*. Default `Wakatime Stats`.
-*   `layout` - Switch between two available layouts `default` & `compact`.  Default `default`.
-*   `langs_count` - Limit the number of languages on the card, defaults to all reported languages *(number)*.
-*   `api_domain` - Set a custom API domain for the card, e.g. to use services like [Hakatime](https://github.com/mujx/hakatime) or [Wakapi](https://github.com/muety/wakapi) *(string)*. Default `Waka API`.
+*   `layout` - Switches between two available layouts `default` & `compact`.  Default `default`.
+*   `langs_count` - Limits the number of languages on the card, defaults to all reported languages *(number)*.
+*   `api_domain` - Sets a custom API domain for the card, e.g. to use services like [Hakatime](https://github.com/mujx/hakatime) or [Wakapi](https://github.com/muety/wakapi) *(string)*. Default `Waka API`.
 
 ***
 
 # GitHub Extra Pins
 
-GitHub extra pins allow you to pin more than six repositories in your profile using a GitHub readme profile.
+GitHub extra pins allow you to pin more than 6 repositories in your profile using a GitHub readme profile.
 
 Yay! You are no longer limited to 6 pinned repositories.
 
@@ -384,7 +386,7 @@ Use [show\_owner](#repo-card-exclusive-options) query option to include the repo
 
 # Top Languages Card
 
-The top languages card shows a GitHub user's most frequently used top language.
+The top languages card shows a GitHub user's most frequently used languages.
 
 > **Warning**
 > By default, the language card shows language results only from public repositories. To include languages used in private repositories, you should [deploy your own instance](#deploy-on-your-own) using your own GitHub API token.
@@ -730,3 +732,5 @@ Thanks! :heart:
 Contributions are welcome! <3
 
 Made with :heart: and JavaScript.
+
+test2

scripts/close-stale-theme-prs.js

@@ -25,10 +25,12 @@ const getReviewer = () => {
 
 /**
  * Fetch open PRs from a given repository.
- * @param user The user name of the repository owner.
- * @param repo The name of the repository.
- * @param reviewer The reviewer to filter by.
- * @returns The open PRs.
+ *
+ * @param {module:@actions/github.Octokit} octokit The octokit client.
+ * @param {string} user The user name of the repository owner.
+ * @param {string} repo The name of the repository.
+ * @param {string} reviewer The reviewer to filter by.
+ * @returns {Promise<Object[]>} The open PRs.
  */
 export const fetchOpenPRs = async (octokit, user, repo, reviewer) => {
   const openPRs = [];
@@ -88,8 +90,10 @@ export const fetchOpenPRs = async (octokit, user, repo, reviewer) => {
 
 /**
  * Retrieve pull requests that have a given label.
- * @param pull The pull requests to check.
- * @param label The label to check for.
+ *
+ * @param {Object[]} pulls The pull requests to check.
+ * @param {string} label The label to check for.
+ * @returns {Object[]} The pull requests that have the given label.
  */
 export const pullsWithLabel = (pulls, label) => {
   return pulls.filter((pr) => {
@@ -99,9 +103,10 @@ export const pullsWithLabel = (pulls, label) => {
 
 /**
  * Check if PR is stale. Meaning that it hasn't been updated in a given time.
+ *
  * @param {Object} pullRequest request object.
- * @param {number} days number of days.
- * @returns Boolean indicating if PR is stale.
+ * @param {number} staleDays number of days.
+ * @returns {boolean} indicating if PR is stale.
  */
 const isStale = (pullRequest, staleDays) => {
   const lastCommitDate = new Date(
@@ -122,6 +127,8 @@ const isStale = (pullRequest, staleDays) => {
 
 /**
  * Main function.
+ *
+ * @returns {Promise<void>} A promise.
  */
 const run = async () => {
   try {

scripts/helpers.js

@@ -10,7 +10,7 @@ const REPO = "github-readme-stats";
 /**
  * Retrieve information about the repository that ran the action.
  *
- * @param {Object} context Action context.
+ * @param {Object} ctx Action context.
  * @returns {Object} Repository information.
  */
 export const getRepoInfo = (ctx) => {

scripts/preview-theme.js

@@ -110,8 +110,9 @@ const isPreviewComment = (inputs, comment) => {
  *
  * @param {Object} octokit Octokit instance.
  * @param {number} issueNumber Issue number.
- * @param {string} repo Repository name.
  * @param {string} owner Owner of the repository.
+ * @param {string} repo Repository name.
+ * @param {string} commenter Comment author.
  * @returns {Object} The GitHub comment object.
  */
 const findComment = async (octokit, issueNumber, owner, repo, commenter) => {
@@ -151,7 +152,7 @@ const findComment = async (octokit, issueNumber, owner, repo, commenter) => {
  * @param {Object} owner Owner of the repository.
  * @param {number} commentId Comment ID.
  * @param {string} body Comment body.
- * @return {string} The comment URL.
+ * @returns {string} The comment URL.
  */
 const upsertComment = async (
   octokit,
@@ -189,6 +190,7 @@ const upsertComment = async (
  * @param {string} repo Repository name.
  * @param {string} reviewState The review state. Options are (APPROVE, REQUEST_CHANGES, COMMENT, PENDING).
  * @param {string} reason The reason for the review.
+ * @returns {Promise<void>} Promise.
  */
 const addReview = async (
   octokit,
@@ -215,6 +217,7 @@ const addReview = async (
  * @param {string} owner Repository owner.
  * @param {string} repo Repository name.
  * @param {string[]} labels Labels to add.
+ * @returns {Promise<void>} Promise.
  */
 const addLabel = async (octokit, prNumber, owner, repo, labels) => {
   await octokit.issues.addLabels({
@@ -233,6 +236,7 @@ const addLabel = async (octokit, prNumber, owner, repo, labels) => {
  * @param {string} owner Repository owner.
  * @param {string} repo Repository name.
  * @param {string} label Label to add or remove.
+ * @returns {Promise<void>} Promise.
  */
 const removeLabel = async (octokit, prNumber, owner, repo, label) => {
   await octokit.issues.removeLabel({
@@ -252,6 +256,7 @@ const removeLabel = async (octokit, prNumber, owner, repo, label) => {
  * @param {string} repo Repository name.
  * @param {string} label Label to add or remove.
  * @param {boolean} add Whether to add or remove the label.
+ * @returns {Promise<void>} Promise.
  */
 const addRemoveLabel = async (octokit, prNumber, owner, repo, label, add) => {
   const res = await octokit.pulls.get({
@@ -359,6 +364,8 @@ const DRY_RUN = process.env.DRY_RUN === "true" || false;
 
 /**
  * Main function.
+ *
+ * @returns {Promise<void>} Promise.
  */
 export const run = async () => {
   try {

src/cards/stats-card.js

@@ -33,7 +33,7 @@ const RANK_ONLY_CARD_DEFAULT_WIDTH = 290;
  * @param {number} createTextNodeParams.shiftValuePos Number of pixels the value has to be shifted to the right.
  * @param {boolean} createTextNodeParams.bold Whether to bold the label.
  * @param {string} createTextNodeParams.number_format The format of numbers on card.
- * @returns
+ * @returns {string} The stats card text item SVG object.
  */
 const createTextNode = ({
   icon,
@@ -77,11 +77,11 @@ const createTextNode = ({
 /**
  * Renders the stats card.
  *
- * @param {Partial<import('../fetchers/types').StatsData>} stats The stats data.
+ * @param {import('../fetchers/types').StatsData} stats The stats data.
  * @param {Partial<import("./types").StatCardOptions>} options The card options.
  * @returns {string} The stats card SVG object.
  */
-const renderStatsCard = (stats = {}, options = {}) => {
+const renderStatsCard = (stats, options = {}) => {
   const {
     name,
     totalStars,

src/cards/top-languages-card.js

@@ -392,7 +392,7 @@ const renderCompactLayout = (langs, width, totalLanguageSize, hideProgress) => {
       ${createLanguageTextNode({
         langs,
         totalSize: totalLanguageSize,
-        hideProgress: hideProgress,
+        hideProgress,
       })}
     </g>
   `;

src/cards/wakatime-card.js

@@ -28,7 +28,7 @@ const languageColors = require("../common/languageColors.json"); // now works
  * @param {object} props The function properties.
  * @param {string} props.color No coding activity text color.
  * @param {string} props.text No coding activity translated text.
- * @return {string} No coding activity SVG node string.
+ * @returns {string} No coding activity SVG node string.
  */
 const noCodingActivityNode = ({ color, text }) => {
   return `
@@ -41,11 +41,10 @@ const noCodingActivityNode = ({ color, text }) => {
  *
  * @param {Object} args The function arguments.
  * @param {import("../fetchers/types").WakaTimeLang} args.lang The languages array.
- * @param {number} args.totalSize The total size of the languages.
  * @param {number} args.x The x position of the language node.
  * @param {number} args.y The y position of the language node.
  */
-const createCompactLangNode = ({ lang, totalSize, x, y }) => {
+const createCompactLangNode = ({ lang, x, y }) => {
   const color = languageColors[lang.name] || "#858585";
 
   return `
@@ -63,25 +62,21 @@ const createCompactLangNode = ({ lang, totalSize, x, y }) => {
  *
  * @param {Object} args The function arguments.
  * @param {import("../fetchers/types").WakaTimeLang[]} args.langs The language objects.
- * @param {number} args.totalSize The total size of the languages.
- * @param {number} args.x The x position of the language node.
  * @param {number} args.y The y position of the language node.
  */
-const createLanguageTextNode = ({ langs, totalSize, x, y }) => {
+const createLanguageTextNode = ({ langs, y }) => {
   return langs.map((lang, index) => {
     if (index % 2 === 0) {
       return createCompactLangNode({
         lang,
         x: 25,
         y: 12.5 * index + y,
-        totalSize,
       });
     }
     return createCompactLangNode({
       lang,
       x: 230,
       y: 12.5 + 12.5 * index,
-      totalSize,
     });
   });
 };
@@ -143,7 +138,7 @@ const createTextNode = ({
  * hiding languages.
  *
  * @param {import("../fetchers/types").WakaTimeLang[]} languages The languages array.
- * @return {void} The recalculated languages array.
+ * @returns {void} The recalculated languages array.
  */
 const recalculatePercentages = (languages) => {
   const totalSum = languages.reduce(
@@ -274,10 +269,8 @@ const renderWakatimeCard = (stats = {}, options = { hide: [] }) => {
       ${
         filteredLanguages.length
           ? createLanguageTextNode({
-              x: 0,
               y: 25,
               langs: filteredLanguages,
-              totalSize: 100,
             }).join("")
           : noCodingActivityNode({
               // @ts-ignore
@@ -298,7 +291,7 @@ const renderWakatimeCard = (stats = {}, options = { hide: [] }) => {
               id: language.name,
               label: language.name,
               value: language.text,
-              index: index,
+              index,
               percent: language.percent,
               // @ts-ignore
               progressBarColor: titleColor,

src/common/Card.js

@@ -54,12 +54,18 @@ class Card {
     this.a11yDesc = "";
   }
 
+  /**
+   * @returns {void}
+   */
   disableAnimations() {
     this.animations = false;
   }
 
   /**
-   * @param {{title: string, desc: string}} prop
+   * @param {Object} props The props object.
+   * @param {string} props.title Accessibility title.
+   * @param {string} props.desc Accessibility description.
+   * @returns {void}
    */
   setAccessibilityLabel({ title, desc }) {
     this.a11yTitle = title;
@@ -67,21 +73,24 @@ class Card {
   }
 
   /**
-   * @param {string} value
+   * @param {string} value The CSS to add to the card.
+   * @returns {void}
    */
   setCSS(value) {
     this.css = value;
   }
 
   /**
-   * @param {boolean} value
+   * @param {boolean} value Whether to hide the border or not.
+   * @returns {void}
    */
   setHideBorder(value) {
     this.hideBorder = value;
   }
 
   /**
-   * @param {boolean} value
+   * @param {boolean} value Whether to hide the title or not.
+   * @returns {void}
    */
   setHideTitle(value) {
     this.hideTitle = value;
@@ -91,12 +100,16 @@ class Card {
   }
 
   /**
-   * @param {string} text
+   * @param {string} text The title to set.
+   * @returns {void}
    */
   setTitle(text) {
     this.title = text;
   }
 
+  /**
+   * @returns {string} The rendered card title.
+   */
   renderTitle() {
     const titleText = `
       <text
@@ -133,6 +146,9 @@ class Card {
     `;
   }
 
+  /**
+   * @returns {string} The rendered card gradient.
+   */
   renderGradient() {
     if (typeof this.colors.bgColor !== "object") return "";
 
@@ -156,7 +172,8 @@ class Card {
   }
 
   /**
-   * @param {string} body
+   * @param {string} body The inner body of the card.
+   * @returns {string} The rendered card.
    */
   render(body) {
     return `

src/common/retryer.js

@@ -9,11 +9,10 @@ const RETRIES = PATs ? PATs : 7;
 /**
  * Try to execute the fetcher function until it succeeds or the max number of retries is reached.
  *
- * @param {object[]} retryerParams Object that contains the createTextNode parameters.
- * @param {object[]} retryerParams.fetcher The fetcher function.
- * @param {object[]} retryerParams.variables Object with arguments to pass to the fetcher function.
- * @param {number} retryerParams.retries How many times to retry.
- * @returns Promise<retryer>
+ * @param {object[]} fetcher The fetcher function.
+ * @param {object[]} variables Object with arguments to pass to the fetcher function.
+ * @param {number} retries How many times to retry.
+ * @returns {Promise<T>} The response from the fetcher function.
  */
 const retryer = async (fetcher, variables, retries = 0) => {
   if (retries > RETRIES) {

src/fetchers/wakatime-fetcher.js

@@ -1,6 +1,5 @@
 import axios from "axios";
 import { CustomError, MissingParamError } from "../common/utils.js";
-import { I18n } from "../common/I18n.js";
 
 /**
  * WakaTime data fetcher.