diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 5ed7d3c969ff8..0000000000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve -title: "" -labels: "" -assignees: "" ---- - - -**Describe the bug** -A clear and concise description of what the bug is. - -**Expected behaviour** -A clear and concise description of what you expected to happen. - -**Screenshots / Live demo link (paste the github-readme-stats link as markdown image)** -If applicable, add screenshots to help explain your problem. - -**Additional context** -Add any other context about the problem here. - - diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000000000..198bc80ef0fe4 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,60 @@ +name: Bug report +description: Create a report to help us improve. +labels: + - "bug" +body: + - type: markdown + attributes: + value: | + :warning: PLEASE FIRST READ THE FAQ [(#1770)](https://github.com/anuraghazra/github-readme-stats/discussions/1770) AND COMMON ERROR CODES [(#1772)](https://github.com/anuraghazra/github-readme-stats/issues/1772)!!! + - type: textarea + attributes: + label: Describe the bug + description: A clear and concise description of what the bug is. + validations: + required: true + - type: textarea + attributes: + label: Expected behaviour + description: + A clear and concise description of what you expected to happen. + - type: textarea + attributes: + label: Screenshots / Live demo link + description: If applicable, add screenshots to help explain your problem. + placeholder: Paste the github-readme-stats link as markdown image + - type: textarea + attributes: + label: Additional context + description: Add any other context about the problem here. + - type: markdown + attributes: + value: | + --- + ### FAQ (Snippet) + + Below are some questions that are found in the FAQ. The full FAQ can be found in [#1770](https://github.com/anuraghazra/github-readme-stats/discussions/1770). + + #### Q: My card displays an error + + **Ans:** First, check the common error codes (i.e. https://github.com/anuraghazra/github-readme-stats/issues/1772) and existing issues before creating a new one. + + #### Q: How to hide jupyter Notebook? + + **Ans:** `&hide=jupyter%20notebook`. + + #### Q: I could not figure out how to deploy on my own vercel instance + + **Ans:** Please check: + - Docs: https://github.com/anuraghazra/github-readme-stats/#deploy-on-your-own-vercel-instance + - YT tutorial by codeSTACKr: https://www.youtube.com/watch?v=n6d4KHSKqGk&feature=youtu.be&t=107 + + #### Q: Language Card is incorrect + + **Ans:** Please read these issues/comments before opening any issues regarding language card stats: + - https://github.com/anuraghazra/github-readme-stats/issues/136#issuecomment-665164174 + - https://github.com/anuraghazra/github-readme-stats/issues/136#issuecomment-665172181 + + #### Q: How to count private stats? + + **Ans:** We can only count private commits & we cannot access any other private info of any users, so it's impossible. The only way is to deploy on your own instance & use your own PAT (Personal Access Token). diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000000000..5c7fb3045572c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,12 @@ +blank_issues_enabled: true +contact_links: + - name: Question + url: https://github.com/anuraghazra/github-readme-stats/discussions + about: Please ask and answer questions here. + - name: Error + url: https://github.com/anuraghazra/github-readme-stats/issues/1772 + about: + Before opening a bug report, please check the 'Common Error Codes' issue. + - name: FAQ + url: https://github.com/anuraghazra/github-readme-stats/discussions/1770 + about: Please first check the FAQ before asking a question. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index 73e080a31240f..0000000000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for this project -title: "" -labels: "" -assignees: "" ---- - -**Is your feature request related to a problem? Please describe.** -A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] - -**Describe the solution you'd like** -A clear and concise description of what you want to happen. - -**Describe alternatives you've considered** -A clear and concise description of any alternative solutions or features you've considered. - -**Additional context** -Add any other context or screenshots about the feature request here. - - diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 0000000000000..fe3a4b3411bfb --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,28 @@ +name: Feature request +description: Suggest an idea for this project. +labels: + - "enhancement" +body: + - type: textarea + attributes: + label: Is your feature request related to a problem? Please describe. + description: + A clear and concise description of what the problem is. Ex. I'm always + frustrated when [...] + validations: + required: true + - type: textarea + attributes: + label: Describe the solution you'd like + description: A clear and concise description of what you want to happen. + - type: textarea + attributes: + label: Describe alternatives you've considered + description: + A clear and concise description of any alternative solutions or features + you've considered. + - type: textarea + attributes: + label: Additional context + description: + Add any other context or screenshots about the feature request here. diff --git a/.github/labeler.yml b/.github/labeler.yml index be97765f07e42..fad3eeeb8d101 100644 --- a/.github/labeler.yml +++ b/.github/labeler.yml @@ -1,3 +1,4 @@ themes: themes/index.js doc-translation: docs/* card-i18n: src/translations.js +documentation: readme.md diff --git a/.github/workflows/deploy-prep.py b/.github/workflows/deploy-prep.py new file mode 100644 index 0000000000000..794c19a296122 --- /dev/null +++ b/.github/workflows/deploy-prep.py @@ -0,0 +1,10 @@ +import os + +file = open('./vercel.json', 'r') +str = file.read() +file = open('./vercel.json', 'w') + +str = str.replace('"maxDuration": 10', '"maxDuration": 30') + +file.write(str) +file.close() diff --git a/.github/workflows/deploy-prep.yml b/.github/workflows/deploy-prep.yml new file mode 100644 index 0000000000000..0626e13d575a7 --- /dev/null +++ b/.github/workflows/deploy-prep.yml @@ -0,0 +1,20 @@ +name: Deployment Prep +on: + workflow_dispatch: + push: + branches: + - master + +jobs: + config: + if: github.repository == 'anuraghazra/github-readme-stats' + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + - name: Deployment Prep + run: python ./.github/workflows/deploy-prep.py + - uses: stefanzweifel/git-auto-commit-action@v4 + with: + branch: vercel + create_branch: true + push_options: "--force" diff --git a/.github/workflows/e2e-test.yml b/.github/workflows/e2e-test.yml new file mode 100644 index 0000000000000..d45c76ba08e58 --- /dev/null +++ b/.github/workflows/e2e-test.yml @@ -0,0 +1,34 @@ +name: Test Deployment +on: + deployment_status: + +jobs: + e2eTests: + if: + github.repository == 'anuraghazra/github-readme-stats' && + github.event_name == 'deployment_status' && + github.event.deployment_status.state == 'success' + name: Perform 2e2 tests + runs-on: ubuntu-latest + strategy: + matrix: + node-version: [16.x] + + steps: + - uses: actions/checkout@v3 + + - name: Setup Node + uses: actions/setup-node@v3 + with: + node-version: ${{ matrix.node-version }} + cache: npm + + - name: Install dependencies + run: npm ci + env: + CI: true + + - name: Run end-to-end tests. + run: npm run test:e2e + env: + VERCEL_PREVIEW_URL: ${{ github.event.deployment_status.target_url }} diff --git a/.github/workflows/empty-issues-closer.yaml b/.github/workflows/empty-issues-closer.yaml index 5f050fe067abc..a65ea63b12dd3 100644 --- a/.github/workflows/empty-issues-closer.yaml +++ b/.github/workflows/empty-issues-closer.yaml @@ -8,10 +8,12 @@ on: jobs: closeEmptyIssuesAndTemplates: + if: github.repository == 'anuraghazra/github-readme-stats' name: Close empty issues runs-on: ubuntu-latest steps: - uses: actions/checkout@v3 # NOTE: Retrieve issue templates. + - name: Run empty issues closer action uses: rickstaa/empty-issues-closer-action@v1 env: diff --git a/.github/workflows/generate-theme-doc.yml b/.github/workflows/generate-theme-doc.yml index 23ea02100e07f..75f6511f09015 100644 --- a/.github/workflows/generate-theme-doc.yml +++ b/.github/workflows/generate-theme-doc.yml @@ -1,5 +1,4 @@ name: Generate Theme Readme - on: push: branches: @@ -8,15 +7,25 @@ on: - "themes/index.js" jobs: - build: + generateThemeDoc: runs-on: ubuntu-latest + name: Generate theme doc + strategy: + matrix: + node-version: [16.x] steps: - - uses: actions/checkout@v1 - - name: setup node - uses: actions/setup-node@v1 + - uses: actions/checkout@v3 + + - name: Setup Node + uses: actions/setup-node@v3 with: - node-version: "16.x" + node-version: ${{ matrix.node-version }} + cache: npm + + # Fix the unsafe repo error which was introduced by the CVE-2022-24765 git patches. + - name: Fix unsafe repo error + run: git config --global --add safe.directory ${{ github.workspace }} - name: npm install, generate readme run: | diff --git a/.github/workflows/label-pr.yml b/.github/workflows/label-pr.yml index 93cb767bf9a04..03715bfab00d6 100644 --- a/.github/workflows/label-pr.yml +++ b/.github/workflows/label-pr.yml @@ -4,8 +4,9 @@ on: jobs: triage: + if: github.repository == 'anuraghazra/github-readme-stats' runs-on: ubuntu-latest steps: - - uses: actions/labeler@v2 + - uses: actions/labeler@v4 with: repo-token: "${{ secrets.GITHUB_TOKEN }}" diff --git a/.github/workflows/preview-theme.yml b/.github/workflows/preview-theme.yml index db7e291daad8a..132d4eb741e14 100644 --- a/.github/workflows/preview-theme.yml +++ b/.github/workflows/preview-theme.yml @@ -1,26 +1,33 @@ name: Theme preview - on: pull_request_target: - types: [opened, synchronize, reopened] + types: [opened, edited, reopened, synchronize] branches: - master - - theme_preview_script paths: - "themes/index.js" - - "scripts/preview-theme.js" jobs: - build: - runs-on: ubuntu-latest + previewTheme: name: Install & Preview + runs-on: ubuntu-latest + strategy: + matrix: + node-version: [16.x] steps: - - uses: actions/checkout@v1 + - uses: actions/checkout@v3 + + - name: Setup Node + uses: actions/setup-node@v3 + with: + node-version: ${{ matrix.node-version }} + cache: npm + - uses: bahmutov/npm-install@v1 with: useLockFile: false + - run: npm run preview-theme env: - CI: true - PERSONAL_TOKEN: ${{ secrets.PERSONAL_TOKEN }} + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} diff --git a/.github/workflows/stale-theme-pr-closer.yaml b/.github/workflows/stale-theme-pr-closer.yaml new file mode 100644 index 0000000000000..aa104feb528ca --- /dev/null +++ b/.github/workflows/stale-theme-pr-closer.yaml @@ -0,0 +1,31 @@ +name: Close stale theme pull requests that have the 'invalid' label. +on: + schedule: + - cron: "0 0 */7 * *" + +jobs: + closeOldThemePrs: + if: github.repository == 'anuraghazra/github-readme-stats' + name: Close stale 'invalid' theme PRs + runs-on: ubuntu-latest + strategy: + matrix: + node-version: [16.x] + + steps: + - uses: actions/checkout@v3 + + - name: Setup Node + uses: actions/setup-node@v3 + with: + node-version: ${{ matrix.node-version }} + cache: npm + + - uses: bahmutov/npm-install@v1 + with: + useLockFile: false + + - run: npm run close-stale-theme-prs + env: + STALE_DAYS: 20 + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index 57fabc5e5f024..fe34668d3e8d2 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -1,5 +1,4 @@ name: Test - on: push: branches: @@ -10,15 +9,20 @@ on: jobs: build: + name: Perform tests runs-on: ubuntu-latest + strategy: + matrix: + node-version: [16.x] steps: - - uses: actions/checkout@v2 + - uses: actions/checkout@v3 - name: Setup Node - uses: actions/setup-node@v1 + uses: actions/setup-node@v3 with: - node-version: "16.x" + node-version: ${{ matrix.node-version }} + cache: npm - name: Install & Test run: | diff --git a/.github/workflows/top-issues-dashboard.yml b/.github/workflows/top-issues-dashboard.yml index 97947947befb2..3a9ec82d35149 100644 --- a/.github/workflows/top-issues-dashboard.yml +++ b/.github/workflows/top-issues-dashboard.yml @@ -1,10 +1,11 @@ name: Update top issues dashboard on: schedule: - - cron: "0 0 */7 * *" + - cron: "0 0 */3 * *" jobs: showAndLabelTopIssues: + if: github.repository == 'anuraghazra/github-readme-stats' name: Update top issues Dashboard. runs-on: ubuntu-latest steps: diff --git a/.github/workflows/update-langs.yaml b/.github/workflows/update-langs.yaml new file mode 100644 index 0000000000000..ad6bfb6213b8f --- /dev/null +++ b/.github/workflows/update-langs.yaml @@ -0,0 +1,44 @@ +name: Update supported languages +on: + schedule: + - cron: "0 0 */30 * *" + +jobs: + updateLanguages: + if: github.repository == 'anuraghazra/github-readme-stats' + name: Update supported languages + runs-on: ubuntu-latest + strategy: + matrix: + node-version: [16.x] + + steps: + - uses: actions/checkout@v3 + + - name: Setup Node + uses: actions/setup-node@v3 + with: + node-version: ${{ matrix.node-version }} + cache: npm + + - name: Install dependencies + run: npm ci + env: + CI: true + + - name: Run update-languages-json.js script + run: npm run generate-langs-json + + - name: Create Pull Request if upstream language file is changed + uses: peter-evans/create-pull-request@v4 + with: + commit-message: "refactor: update languages JSON" + branch: "update_langs/patch" + delete-branch: true + title: Update languages JSON + body: + "The + [update-langs](https://github.com/anuraghazra/github-readme-stats/actions/workflows/update-langs.yaml) + action found new/updated languages in the [upstream languages JSON + file](https://raw.githubusercontent.com/github/linguist/master/lib/linguist/languages.yml)." + labels: "ci, lang-card" diff --git a/.gitignore b/.gitignore index 2cdfa3d334808..25017502d486a 100644 --- a/.gitignore +++ b/.gitignore @@ -10,3 +10,5 @@ vercel_token # IDE .vscode *.code-workspace + +.vercel diff --git a/.husky/.gitignore b/.husky/.gitignore new file mode 100644 index 0000000000000..31354ec138999 --- /dev/null +++ b/.husky/.gitignore @@ -0,0 +1 @@ +_ diff --git a/.husky/pre-commit b/.husky/pre-commit new file mode 100755 index 0000000000000..e1c12eb032030 --- /dev/null +++ b/.husky/pre-commit @@ -0,0 +1,5 @@ +#!/usr/bin/env sh +. "$(dirname -- "$0")/_/husky.sh" + +npm test +npx lint-staged diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0d4b558abe6f1..7d450d6076d8e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,11 +2,11 @@ We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's: -- Reporting an issue -- Discussing the current state of the code -- Submitting a fix -- Proposing new features -- Becoming a maintainer +- Reporting [an issue](https://github.com/anuraghazra/github-readme-stats/issues/new?assignees=&labels=bug&template=bug_report.yml). +- [Discussing](https://github.com/anuraghazra/github-readme-stats/discussions) the current state of the code. +- Submitting [a fix](https://github.com/anuraghazra/github-readme-stats/compare). +- Proposing [new features](https://github.com/anuraghazra/github-readme-stats/issues/new?assignees=&labels=enhancement&template=feature_request.yml). +- Becoming a maintainer. ## All Changes Happen Through Pull Requests @@ -33,11 +33,15 @@ _(make sure you already have a [Vercel](https://vercel.com/) account)_ 1. Install [Vercel CLI](https://vercel.com/download). 2. Fork the repository and clone the code to your local machine. 3. Run `npm install` in the repository root. -4. Run the command "vercel" in the root and follow the steps there. +4. Run the command `vercel` in the root and follow the steps there. 5. Open `vercel.json` and set the maxDuration to 10. 6. Create a `.env` file in the root of the directory. -7. In the .env file add a new variable named "PAT_1" with your [GitHub Personal Access Token](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token). -8. Run the command "vercel dev" to start a development server at . +7. In the .env file add a new variable named `PAT_1` with your [GitHub Personal Access Token](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token). +8. Run the command `vercel dev` to start a development server at . +9. The cards will then be available from this local endpoint (i.e. `https://localhost:3000/api?username=anuraghazra`). + +> **Note** +> You can also debug any tests using the [VSCode Jest extension](https://marketplace.visualstudio.com/items?itemName=Orta.vscode-jest). For more information see https://github.com/jest-community/vscode-jest/issues/912. ## Themes Contribution diff --git a/api/index.js b/api/index.js index 10dd48478ec6b..29ff87f9af863 100644 --- a/api/index.js +++ b/api/index.js @@ -1,4 +1,3 @@ -import * as dotenv from "dotenv"; import { renderStatsCard } from "../src/cards/stats-card.js"; import { blacklist } from "../src/common/blacklist.js"; import { @@ -11,8 +10,6 @@ import { import { fetchStats } from "../src/fetchers/stats-fetcher.js"; import { isLocaleAvailable } from "../src/translations.js"; -dotenv.config(); - export default async (req, res) => { const { username, @@ -26,6 +23,7 @@ export default async (req, res) => { include_all_commits, line_height, title_color, + ring_color, icon_color, text_color, text_bold, @@ -37,7 +35,9 @@ export default async (req, res) => { locale, disable_animations, border_radius, + number_format, border_color, + rank_icon, } = req.query; res.setHeader("Content-Type", "image/svg+xml"); @@ -63,7 +63,12 @@ export default async (req, res) => { CONSTANTS.ONE_DAY, ); - res.setHeader("Cache-Control", `public, max-age=${cacheSeconds}`); + res.setHeader( + "Cache-Control", + `max-age=${ + cacheSeconds / 2 + }, s-maxage=${cacheSeconds}, stale-while-revalidate=${CONSTANTS.ONE_DAY}`, + ); return res.send( renderStatsCard(stats, { @@ -76,6 +81,7 @@ export default async (req, res) => { include_all_commits: parseBoolean(include_all_commits), line_height, title_color, + ring_color, icon_color, text_color, text_bold: parseBoolean(text_bold), @@ -84,11 +90,14 @@ export default async (req, res) => { custom_title, border_radius, border_color, + number_format, locale: locale ? locale.toLowerCase() : null, disable_animations: parseBoolean(disable_animations), + rank_icon, }), ); } catch (err) { + res.setHeader("Cache-Control", `no-cache, no-store, must-revalidate`); // Don't cache error responses. return res.send(renderError(err.message, err.secondaryMessage)); } }; diff --git a/api/pin.js b/api/pin.js index e83750a5f7ce4..4838b0f02fece 100644 --- a/api/pin.js +++ b/api/pin.js @@ -58,7 +58,12 @@ export default async (req, res) => { cacheSeconds = CONSTANTS.FOUR_HOURS; } - res.setHeader("Cache-Control", `public, max-age=${cacheSeconds}`); + res.setHeader( + "Cache-Control", + `max-age=${ + cacheSeconds / 2 + }, s-maxage=${cacheSeconds}, stale-while-revalidate=${CONSTANTS.ONE_DAY}`, + ); return res.send( renderRepoCard(repoData, { @@ -75,6 +80,7 @@ export default async (req, res) => { }), ); } catch (err) { + res.setHeader("Cache-Control", `no-cache, no-store, must-revalidate`); // Don't cache error responses. return res.send(renderError(err.message, err.secondaryMessage)); } }; diff --git a/api/status/pat-info.js b/api/status/pat-info.js new file mode 100644 index 0000000000000..69d869ea2553e --- /dev/null +++ b/api/status/pat-info.js @@ -0,0 +1,139 @@ +/** + * @file Contains a simple cloud function that can be used to check which PATs are no + * longer working. It returns a list of valid PATs, expired PATs and PATs with errors. + * + * @description This function is currently rate limited to 1 request per 5 minutes. + */ + +import { logger, request, dateDiff } from "../../src/common/utils.js"; +export const RATE_LIMIT_SECONDS = 60 * 5; // 1 request per 5 minutes + +/** + * Simple uptime check fetcher for the PATs. + * + * @param {import('axios').AxiosRequestHeaders} variables + * @param {string} token + */ +const uptimeFetcher = (variables, token) => { + return request( + { + query: ` + query { + rateLimit { + remaining + resetAt + }, + }`, + variables, + }, + { + Authorization: `bearer ${token}`, + }, + ); +}; + +const getAllPATs = () => { + return Object.keys(process.env).filter((key) => /PAT_\d*$/.exec(key)); +}; + +/** + * Check whether any of the PATs is expired. + */ +const getPATInfo = async (fetcher, variables) => { + const details = {}; + const PATs = getAllPATs(); + + for (const pat of PATs) { + try { + const response = await fetcher(variables, process.env[pat]); + const errors = response.data.errors; + const hasErrors = Boolean(errors); + const errorType = errors?.[0]?.type; + const isRateLimited = + (hasErrors && errorType === "RATE_LIMITED") || + response.data.data?.rateLimit?.remaining === 0; + + // Store PATs with errors. + if (hasErrors && errorType !== "RATE_LIMITED") { + details[pat] = { + status: "error", + error: { + type: errors[0].type, + message: errors[0].message, + }, + }; + continue; + } else if (isRateLimited) { + const date1 = new Date(); + const date2 = new Date(response.data?.data?.rateLimit?.resetAt); + details[pat] = { + status: "exhausted", + remaining: 0, + resetIn: dateDiff(date2, date1) + " minutes", + }; + } else { + details[pat] = { + status: "valid", + remaining: response.data.data.rateLimit.remaining, + }; + } + } catch (err) { + // Store the PAT if it is expired. + const errorMessage = err.response?.data?.message?.toLowerCase(); + if (errorMessage === "bad credentials") { + details[pat] = { + status: "expired", + }; + } else if (errorMessage === "sorry. your account was suspended.") { + details[pat] = { + status: "suspended", + }; + } else { + throw err; + } + } + } + + const filterPATsByStatus = (status) => { + return Object.keys(details).filter((pat) => details[pat].status === status); + }; + + const sortedDetails = Object.keys(details) + .sort() + .reduce((obj, key) => { + obj[key] = details[key]; + return obj; + }, {}); + + return { + validPATs: filterPATsByStatus("valid"), + expiredPATs: filterPATsByStatus("expired"), + exhaustedPATs: filterPATsByStatus("exhausted"), + suspendedPATs: filterPATsByStatus("suspended"), + errorPATs: filterPATsByStatus("error"), + details: sortedDetails, + }; +}; + +/** + * Cloud function that returns information about the used PATs. + */ +export default async (_, res) => { + res.setHeader("Content-Type", "application/json"); + try { + // Add header to prevent abuse. + const PATsInfo = await getPATInfo(uptimeFetcher, {}); + if (PATsInfo) { + res.setHeader( + "Cache-Control", + `max-age=0, s-maxage=${RATE_LIMIT_SECONDS}`, + ); + } + res.send(JSON.stringify(PATsInfo, null, 2)); + } catch (err) { + // Throw error if something went wrong. + logger.error(err); + res.setHeader("Cache-Control", "no-store"); + res.send("Something went wrong: " + err.message); + } +}; diff --git a/api/status/up.js b/api/status/up.js new file mode 100644 index 0000000000000..678a20b0b5c14 --- /dev/null +++ b/api/status/up.js @@ -0,0 +1,103 @@ +/** + * @file Contains a simple cloud function that can be used to check if the PATs are still + * functional. + * + * @description This function is currently rate limited to 1 request per 5 minutes. + */ + +import retryer from "../../src/common/retryer.js"; +import { logger, request } from "../../src/common/utils.js"; + +export const RATE_LIMIT_SECONDS = 60 * 5; // 1 request per 5 minutes + +/** + * Simple uptime check fetcher for the PATs. + * + * @param {import('axios').AxiosRequestHeaders} variables + * @param {string} token + */ +const uptimeFetcher = (variables, token) => { + return request( + { + query: ` + query { + rateLimit { + remaining + } + } + `, + variables, + }, + { + Authorization: `bearer ${token}`, + }, + ); +}; + +/** + * Creates Json response that can be used for shields.io dynamic card generation. + * + * @param {*} up Whether the PATs are up or not. + * @returns Dynamic shields.io JSON response object. + * + * @see https://shields.io/endpoint. + */ +const shieldsUptimeBadge = (up) => { + const schemaVersion = 1; + const isError = true; + const label = "Public Instance"; + const message = up ? "up" : "down"; + const color = up ? "brightgreen" : "red"; + return { + schemaVersion, + label, + message, + color, + isError, + }; +}; + +/** + * Cloud function that returns whether the PATs are still functional. + */ +export default async (req, res) => { + let { type } = req.query; + type = type ? type.toLowerCase() : "boolean"; + + res.setHeader("Content-Type", "application/json"); + + try { + let PATsValid = true; + try { + await retryer(uptimeFetcher, {}); + } catch (err) { + PATsValid = false; + } + + if (PATsValid) { + res.setHeader( + "Cache-Control", + `max-age=0, s-maxage=${RATE_LIMIT_SECONDS}`, + ); + } else { + res.setHeader("Cache-Control", "no-store"); + } + + switch (type) { + case "shields": + res.send(shieldsUptimeBadge(PATsValid)); + break; + case "json": + res.send({ up: PATsValid }); + break; + default: + res.send(PATsValid); + break; + } + } catch (err) { + // Return fail boolean if something went wrong. + logger.error(err); + res.setHeader("Cache-Control", "no-store"); + res.send("Something went wrong: " + err.message); + } +}; diff --git a/api/top-langs.js b/api/top-langs.js index aa29b23472dd2..cde0a9af08a93 100644 --- a/api/top-langs.js +++ b/api/top-langs.js @@ -1,4 +1,3 @@ -import * as dotenv from "dotenv"; import { renderTopLanguages } from "../src/cards/top-languages-card.js"; import { blacklist } from "../src/common/blacklist.js"; import { @@ -11,8 +10,6 @@ import { import { fetchTopLanguages } from "../src/fetchers/top-languages-fetcher.js"; import { isLocaleAvailable } from "../src/translations.js"; -dotenv.config(); - export default async (req, res) => { const { username, @@ -28,10 +25,14 @@ export default async (req, res) => { layout, langs_count, exclude_repo, + size_weight, + count_weight, custom_title, locale, border_radius, border_color, + disable_animations, + hide_progress, } = req.query; res.setHeader("Content-Type", "image/svg+xml"); @@ -47,6 +48,8 @@ export default async (req, res) => { const topLangs = await fetchTopLanguages( username, parseArray(exclude_repo), + size_weight, + count_weight, ); const cacheSeconds = clampValue( @@ -55,7 +58,12 @@ export default async (req, res) => { CONSTANTS.ONE_DAY, ); - res.setHeader("Cache-Control", `public, max-age=${cacheSeconds}`); + res.setHeader( + "Cache-Control", + `max-age=${ + cacheSeconds / 2 + }, s-maxage=${cacheSeconds}, stale-while-revalidate=${CONSTANTS.ONE_DAY}`, + ); return res.send( renderTopLanguages(topLangs, { @@ -73,9 +81,12 @@ export default async (req, res) => { border_radius, border_color, locale: locale ? locale.toLowerCase() : null, + disable_animations: parseBoolean(disable_animations), + hide_progress: parseBoolean(hide_progress), }), ); } catch (err) { + res.setHeader("Cache-Control", `no-cache, no-store, must-revalidate`); // Don't cache error responses. return res.send(renderError(err.message, err.secondaryMessage)); } }; diff --git a/api/wakatime.js b/api/wakatime.js index bbfb2f2ec5dde..d439c5b7ac8c6 100644 --- a/api/wakatime.js +++ b/api/wakatime.js @@ -1,4 +1,3 @@ -import * as dotenv from "dotenv"; import { renderWakatimeCard } from "../src/cards/wakatime-card.js"; import { clampValue, @@ -10,8 +9,6 @@ import { import { fetchWakatimeStats } from "../src/fetchers/wakatime-fetcher.js"; import { isLocaleAvailable } from "../src/translations.js"; -dotenv.config(); - export default async (req, res) => { const { username, @@ -55,7 +52,12 @@ export default async (req, res) => { cacheSeconds = CONSTANTS.FOUR_HOURS; } - res.setHeader("Cache-Control", `public, max-age=${cacheSeconds}`); + res.setHeader( + "Cache-Control", + `max-age=${ + cacheSeconds / 2 + }, s-maxage=${cacheSeconds}, stale-while-revalidate=${CONSTANTS.ONE_DAY}`, + ); return res.send( renderWakatimeCard(stats, { @@ -78,6 +80,7 @@ export default async (req, res) => { }), ); } catch (err) { + res.setHeader("Cache-Control", `no-cache, no-store, must-revalidate`); // Don't cache error responses. return res.send(renderError(err.message, err.secondaryMessage)); } }; diff --git a/docs/readme_cn.md b/docs/readme_cn.md index 17fd2b710f220..d6487b6618264 100644 --- a/docs/readme_cn.md +++ b/docs/readme_cn.md @@ -53,6 +53,8 @@ Nederlands . नेपाली + . + Türkçe

喜欢这个项目？请考虑捐赠来帮助它完善！ @@ -138,7 +140,7 @@ dark, radical, merko, gruvbox, tokyonight, onedark, cobalt, synthwave, highcontr - `bg_color` - 卡片背景颜色 _（十六进制色码）_ **或者** 以 _angle,start,end_ 的形式渐变 - `hide_border` - 隐藏卡的边框 _(布尔值)_ - `theme` - 主题名称，从[所有可用主题](../themes/README.md)中选择 -- `cache_seconds` - 手动设置缓存头 _（最小值: 1800，最大值: 86400）_ +- `cache_seconds` - 手动设置缓存头 _（最小值: 14400，最大值: 86400）_ - `locale` - 在卡片中设置语言 _(例如 cn, de, es, 等等)_ ##### bg_color 渐变 diff --git a/docs/readme_de.md b/docs/readme_de.md index 55523fe342ef0..8756670eaf4b9 100644 --- a/docs/readme_de.md +++ b/docs/readme_de.md @@ -54,6 +54,8 @@ Nederlands . नेपाली + . + Türkçe

Du magst das Projekt? Wie wäre es mit einer kleinen Spende um es weiterhin am Leben zu erhalten? @@ -128,7 +130,7 @@ Du kannst das Erscheinungsbild deiner `Stats Card` oder `Repo Card`, mithilfe vo - `bg_color` - Hintergrundfarbe _(hex color)_ **oder** ein Farbverlauf in der Form von _winkel,start,ende_ - `hide_border` - Blendet den Rand der Karte aus _(Boolean)_ - `theme` - Name des Erscheinungsbildes/Themes [alle verfügbaren Themes](../themes/README.md) -- `cache_seconds` - manuelles festlegen der Cachezeiten _(min: 1800, max: 86400)_ +- `cache_seconds` - manuelles festlegen der Cachezeiten _(min: 14400, max: 86400)_ - `locale` - Stellen Sie die Sprache auf der Karte ein _(z.B. cn, de, es, etc.)_ ##### Farbverlauf in bg_color diff --git a/docs/readme_es.md b/docs/readme_es.md index 5ddceec7b5e99..b477e5c729cab 100644 --- a/docs/readme_es.md +++ b/docs/readme_es.md @@ -142,7 +142,7 @@ Puedes personalizar el aspecto de tu `Tarjeta de Estadísticas` o `Tarjeta de Re - `bg_color` - Color de fondo _(hex color)_ - `hide_border` - Oculta el borde de la tarjeta _(booleano)_ - `theme` - Nombre del tema, elige uno de [todos los temas disponible ](../themes/README.md) -- `cache_seconds` - Cache _(min: 1800, max: 86400)_ +- `cache_seconds` - Cache _(min: 14400, max: 86400)_ - `locale` - configurar el idioma en la tarjeta _(p.ej. cn, de, es, etc.)_ ##### Gradiente en `bg_color` diff --git a/docs/readme_fr.md b/docs/readme_fr.md index 20996bd66dda8..ce0d3d495cc10 100644 --- a/docs/readme_fr.md +++ b/docs/readme_fr.md @@ -53,6 +53,8 @@ Nederlands . नेपाली + . + Türkçe

Vous aimez ce projet? Pensez à faire un don pour l'améliorer! @@ -138,7 +140,7 @@ Vous pouvez personnaliser l'apparence de votre `Carte des stats` ou `Carte de d - `bg_color` - Couleur du fond de la carte _(hex color)_ **ou** un gradiant de la forme _angle,start,end_ - `hide_border` - Cache la bordure de la carte _(booléen)_ - `theme` - Nom du thème, parmis [tous les thèmes disponibles](../themes/README.md) -- `cache_seconds` - Paramétrer le cache manuellement _(min: 1800, max: 86400)_ +- `cache_seconds` - Paramétrer le cache manuellement _(min: 14400, max: 86400)_ - `locale` - définir la langue de la carte _(par exemple. cn, de, es, etc.)_ ##### Gradient in bg_color diff --git a/docs/readme_it.md b/docs/readme_it.md index 1b2df96a5044d..e54af7dc488ad 100644 --- a/docs/readme_it.md +++ b/docs/readme_it.md @@ -53,6 +53,8 @@ Nederlands . नेपाली + . + Türkçe

Se ti piace questo progetto, considera la possibilità di donare per aiutare a renderlo migliore! @@ -138,7 +140,7 @@ Puoi personalizzare l'aspetto delle tue `Stats Card` o delle `Repo Card` in qual - `bg_color` - Colore dello sfondo _(in esadecimale)_ **oppure** un gradiente nella forma _angolo,inizio,fine_ - `hide_border` - Nasconde il bordo della carta _(booleano)_ - `theme` - Nome del tema, dai un'occhiata a [tutti i temi disponibili](../themes/README.md) -- `cache_seconds` - Specifica manualmente il valore di cache, in secondi _(min: 1800, max: 86400)_ +- `cache_seconds` - Specifica manualmente il valore di cache, in secondi _(min: 14400, max: 86400)_ - `locale` - Impostare la lingua nella scheda _(per esempio. cn, de, es, eccetera.)_ ##### Gradiente nello sfondo diff --git a/docs/readme_ja.md b/docs/readme_ja.md index b00c77a7712a1..2c2def7fca1a6 100644 --- a/docs/readme_ja.md +++ b/docs/readme_ja.md @@ -53,6 +53,8 @@ Nederlands . नेपाली + . + Türkçe

このプロジェクトを気に入っていただけましたか？
もしよろしければ、プロジェクトのさらなる改善のために寄付を検討して頂けると嬉しいです！

@@ -139,7 +141,7 @@ dark, radical, merko, gruvbox, tokyonight, onedark, cobalt, synthwave, highcontr - `bg_color` - 背景の色 _(16 進数カラーコード)_ **または** _angle,start,end_ の形式でグラデーションを指定することも可 - `hide_border` - カードの境界線を非表示にします _(ブール値)_ - `theme` - [使用可能なテーマ一覧](../themes/README.md) から選んだテーマ名 -- `cache_seconds` - キャッシュ時間の秒数 _(最小値: 1800, 最大値: 86400)_ +- `cache_seconds` - キャッシュ時間の秒数 _(最小値: 14400, 最大値: 86400)_ - `locale` - カードに言語を設定する _(例えば cn, de, es, 等)_ ##### bg_color の グラデーション指定 diff --git a/docs/readme_kr.md b/docs/readme_kr.md index f5dfc9f2edf19..4a1c57cc1e977 100644 --- a/docs/readme_kr.md +++ b/docs/readme_kr.md @@ -1,7 +1,7 @@

GitHub Readme Stats

GitHub Readme Stats

-

동적으로 생성되는 Github 사용량 통계를 여러분의 README 에 추가해보세요!

+

동적으로 생성되는 GitHub 사용량 통계를 여러분의 README 에 추가해보세요!

@@ -53,6 +53,8 @@ Nederlands . नेपाली + . + Türkçe

기능들이 마음에 드시나요? 괜찮으시다면, 서비스 개선을 위해 기부를 고려해주세요! @@ -72,7 +74,7 @@ 아래 코드를 복사해서 마크다운 파일에 붙여넣으면 끝이에요, 아주 간단해요! -`?username=` 속성의 값을 Github 계정의 사용자 명(닉네임)으로 바꿔주세요. +`?username=` 속성의 값을 GitHub 계정의 사용자 명(닉네임)으로 바꿔주세요. ```md [![Anurag's GitHub stats](https://github-readme-stats.vercel.app/api?username=anuraghazra)](https://github.com/anuraghazra/github-readme-stats) @@ -149,7 +151,7 @@ dark, radical, merko, gruvbox, tokyonight, onedark, cobalt, synthwave, highcontr - `bg_color` - 카드의 배경 색상 _(hex color)_ **혹은** 다음 양식으로 그라데이션 주기 _angle,start,end_ - `hide_border` - 카드의 테두리 표시 여부 _(boolean)_ - `theme` - 테마의 이름, [사용 가능한 모든 테마](../themes/README.md) 에서 선택 -- `cache_seconds` - 수동으로 캐시 헤더 설정 _(min: 1800, max: 86400)_ +- `cache_seconds` - 수동으로 캐시 헤더 설정 _(min: 14400, max: 86400)_ - `locale` - 카드에 표시할 언어 _(e.g. kr, cn, de, es, etc.)_ ##### 배경에 그라데이션 주기 @@ -235,7 +237,7 @@ GitHub 저장소 여분 핀을 이용하면, 6개 이상의 저장소 핀을 여 # 언어 사용량 통계 -언어 사용량 통계 카드는 Github 사용자가 가장 많이 사용한 언어가 표시됩니다. +언어 사용량 통계 카드는 GitHub 사용자가 가장 많이 사용한 언어가 표시됩니다. _참고: 언어 사용량 통계는 GitHub 에서 가장 많이 사용된 언어의 표기일 뿐입니다. diff --git a/docs/readme_nl.md b/docs/readme_nl.md index 597f0c86445e3..b279c4f71fff4 100644 --- a/docs/readme_nl.md +++ b/docs/readme_nl.md @@ -53,6 +53,8 @@ Nederlands . नेपाली + . + Türkçe

Bevalt het project? Doneer om het te verbeteren! @@ -142,7 +144,7 @@ Je kan het uiterlijk van je `Statistieken kaart` of `Repo kaart` aanpassen hoe j - `bg_color` - Achtergrond kleur van de kaart _(hex kleur)_ **of** een verloop van kleuren in het formaat van _graden,start,einde_ - `hide_border` - Verbergt de rand van de kaart _(boolean)_ - `theme` - Naam van het thema, kies uit [alle beschikbare thema\'s](../themes/README.md) -- `cache_seconds` - Stel de cache header handmatig in _(min: 1800, max: 86400)_ +- `cache_seconds` - Stel de cache header handmatig in _(min: 14400, max: 86400)_ - `locale` - Stel taal van de kaart in _(e.g. cn, de, es, etc.)_ ##### Kleurenverloop in bg_color (achtergrond kleur): diff --git a/docs/readme_np.md b/docs/readme_np.md index 15bb34ba601b8..e90ee57bfe6b3 100644 --- a/docs/readme_np.md +++ b/docs/readme_np.md @@ -49,8 +49,12 @@ Italiano · 한국어 + . + Nederlands · नेपाली + . + Türkçe

परियोजना मनपर्‍यो? तपाईं मद्दत गर्न सक्नुहुन्छ यो परियोजना बढ्न @@ -138,7 +142,7 @@ dark, radical, merko, gruvbox, tokyonight, onedark, cobalt, synthwave, highcontr - `bg_color` - Card's background color _(hex color)_ **or** a gradient in the form of _angle,start,end_ - `hide_border` - Hides the card's border _(boolean)_ - `theme` - name of the theme, choose from [all available themes](./themes/README.md) -- `cache_seconds` - set the cache header manually _(min: 1800, max: 86400)_ +- `cache_seconds` - set the cache header manually _(min: 14400, max: 86400)_ - `locale` - set the language in the card _(e.g. cn, de, es, etc.)_ ##### Gradient in bg_color @@ -219,7 +223,7 @@ Use [show_owner](#customization) variable to include the repo's owner username टोप भाषाकार्डले github परयोग गर्नेहरुको प्रोग्रम्मिंग भाषाहरु देखाऊने गर्दछ |. -_NOTE: टोप भाषाहरुले आफ्नो सिपलाए संकेत गरेको होईन | योचै Github Metricबाट धेरै कुन भाषा परयोग भाकोलाए संकेत गरेको हो | +_NOTE: टोप भाषाहरुले आफ्नो सिपलाए संकेत गरेको होईन | योचै GitHub Metricबाट धेरै कुन भाषा परयोग भाकोलाए संकेत गरेको हो | ### प्रयोग कोदलाए कपी- पेसेत readme मा गर्नु होला र लिंक परिवतन गर्नु होला | @@ -389,7 +393,7 @@ NOTE: Since [#58](https://github.com/anuraghazra/github-readme-stats/pull/58) we येदि तपाइले यो प्रोजेक्ट चलाउनु बाकोक्ष बने र मलाई अझै प्रसंसा गर्ने हो बने तपाइले थुप्रै तरिका ले गर्नु सक्नु हुने छ :- - यो प्रोजेक्टमा तपाइले प्रहयोग गर्दा मलाई क्रेडिट दिन सक्नु हुनेक्ष । -- तपाइले Github ReadMe Stats स्तार्रेड गर्न सक्नु हुनेक्ष :rocket: +- तपाइले GitHub ReadMe Stats स्तार्रेड गर्न सक्नु हुनेक्ष :rocket: - [![paypal.me/anuraghazra](https://ionicabizau.github.io/badges/paypal.svg)](https://www.paypal.me/anuraghazra) - तपाइले पेपाल बाट पनि सहयोग (डक्क्षिन) गर्न सक्नु हुनेक्ष | म ~~कोफी ~~ चिया . :tea: किन्न सक्क्षु । धन्याबाद! :heart: diff --git a/docs/readme_pt-BR.md b/docs/readme_pt-BR.md index 7f4814cec669b..1ac57716009be 100644 --- a/docs/readme_pt-BR.md +++ b/docs/readme_pt-BR.md @@ -53,6 +53,8 @@ Nederlands . नेपाली + . + Türkçe

Gostou do projeto? Por favor considere fazer uma doação para ajudar a melhorá-lo! @@ -139,10 +141,10 @@ Personalize a aparência do seu `Stats Card` ou `Repo Card` da maneira que desej - `bg_color` - Cor de fundo do cartão _(hex color)_ - `hide_border` - Esconde a borda do cartão _(boleano)_ - `theme` - Nome do tema, escolha em [todos os temas disponíveis](../themes/README.md) -- `cache_seconds` - Defina o cabeçalho do cache manualmente _(min: 1800, max: 86400)_ +- `cache_seconds` - Defina o cabeçalho do cache manualmente _(min: 14400, max: 86400)_ - `locale` - defina o idioma no cartão _(por exemplo. cn, de, es, etc.)_ -> Nota sobre o cache: Cartões de repositório tem um cache padrão de 30 minutos (1800 segundos), se o número a contagem de forks e contagem de estrelas é menor que 1 mil o padrão é 2 horas (7200). Note também que o cache é limitado a um mínimo de 30 minutos e um máximo de 24 horas. +> Nota sobre o cache: Cartões de repositório tem um cache padrão de 30 minutos (1800 segundos), se o número a contagem de forks e contagem de estrelas é menor que 1 mil o padrão é 2 horas (7200 segundos). Note também que o cache é limitado a um mínimo de 30 minutos e um máximo de 24 horas. #### Opções exclusivas do cartão de estatísticas: @@ -167,7 +169,7 @@ Personalize a aparência do seu `Stats Card` ou `Repo Card` da maneira que desej > :warning: **Importante:** > Nomes de linguagens devem ser uma sequência escapada de URI, como específicado em [Codificação por cento](https://pt.wikipedia.org/wiki/Codificação_por_cento) -> (Isso é: `c++` deve se tornar `c%2B%2B`, `jupyter notebook` deve se tornar `jupyter%20notebook`, etc.) +> (Ou seja: `c++` deve se tornar `c%2B%2B`, `jupyter notebook` deve se tornar `jupyter%20notebook`, etc.) --- diff --git a/docs/readme_tr.md b/docs/readme_tr.md index 35f32f2f20f99..d8ae9778fb50c 100644 --- a/docs/readme_tr.md +++ b/docs/readme_tr.md @@ -73,10 +73,10 @@ Alt kısımdaki kodu Kopyalayın ve yapıştırın. İşte bu kadar. Çok basit! -`?username=` değerini kendi Github kullanıcı adınız ile değiştirin. +`?username=` değerini kendi GitHub kullanıcı adınız ile değiştirin. ```md -[![Anurag'nın Github İstatistikleri](https://github-readme-stats.vercel.app/api?username=anuraghazra)](https://github.com/anuraghazra/github-readme-stats) +[![Anurag'nın GitHub İstatistikleri](https://github-readme-stats.vercel.app/api?username=anuraghazra)](https://github.com/anuraghazra/github-readme-stats) ``` _Not: Şu sıralamalar mevcut: S+ (en üst 1%), S (en üst 25%), A++ (en üst 45%), A+ (en üst 60%), and B+ (herkes). Buradaki değerler [cumulative distribution function](https://en.wikipedia.org/wiki/Cumulative_distribution_function) ile hesaplanırken; commitler, katkılar, hatalar, yıldızlar, çekme istekleri, takipçiler ve sahip olunan depolar (repository) göz önünde bulundurulamaktadır. @@ -143,7 +143,7 @@ dark, radical, merko, gruvbox, tokyonight, onedark, cobalt, synthwave, highcontr - `bg_color` - Kartın arkaplan rengi _(hex color / hex rengi)_ **ya da** gradient şeklinde _açı,başlangıç,bitiş_ - `hide_border` - Kartın çerçevelerini gizler _(boolean)_ - `theme` - Temanın rengi [tüm temalar](./themes/README.md) -- `cache_seconds` - Manuel olarak cache'i belirleyebilirsiniz _(en az: 1800, en fazla: 86400)_ +- `cache_seconds` - Manuel olarak cache'i belirleyebilirsiniz _(en az: 14400, en fazla: 86400)_ - `locale` - Karttaki dili seçebilirsiniz _(örneğin; tr, cn, de, es, vb.)_ ##### bg_color'da Gradient @@ -199,7 +199,7 @@ bg_color içerisinde birden fazla rengi gradient olarak göstermek için virgül # GitHub Ekstra Pinler -Github ekstra pinler profilinize 6'dan fazla repoyu / depoyu profilinizde pinleyebilirsiniz. +GitHub ekstra pinler profilinize 6'dan fazla repoyu / depoyu profilinizde pinleyebilirsiniz. Hey! Artık 6 pin ile kısıtlı kalmayacaksınız! @@ -225,7 +225,7 @@ Endpoint: `api/pin?username=mustafacagri&repo=github-readme-stats` En çok kullanılan diller kartı kullanıcının en çok kullandığı dilleri gösterir. -_NOTE: En çok kullanılan dillerde yer alan bilgiler sizin yeteneğinizi ve benzeri şeyleri göstermek. Bu, kodlarınızda en çok kullandığınız dilleri gösteren bir Github metriğidir. Ayrıca, github-readme-stats'ın yeni özelliğidir. +_NOTE: En çok kullanılan dillerde yer alan bilgiler sizin yeteneğinizi ve benzeri şeyleri göstermek. Bu, kodlarınızda en çok kullandığınız dilleri gösteren bir GitHub metriğidir. Ayrıca, github-readme-stats'ın yeni özelliğidir. ### Kullanım @@ -365,7 +365,7 @@ Genellikle resimleri yan yana düzenleyemezsiniz. Bunu yapmak için şu yaklaş #### [@codeSTACKr'ın Yayınladığı Video Eğitimine Göz Atın](https://youtu.be/n6d4KHSKqGk?t=107) -Github API saatte sadece 5.000 isteğe izin verdiği için `https://github-readme-stats.vercel.app/api` adresindeki API'm bu limite muhtemelen takılmış olabilir. Eğer projeyi kendi Vercel sunucunuzda yayınlarsanız, böyle bir sorun yaşamayabilirsiniz. Deploy butonuna tıkla ve deploy başlasın! +GitHub API saatte sadece 5.000 isteğe izin verdiği için `https://github-readme-stats.vercel.app/api` adresindeki API'm bu limite muhtemelen takılmış olabilir. Eğer projeyi kendi Vercel sunucunuzda yayınlarsanız, böyle bir sorun yaşamayabilirsiniz. Deploy butonuna tıkla ve deploy başlasın! NOT: [#58](https://github.com/anuraghazra/github-readme-stats/pull/58) geliştirmesi sonrasında anlamadığımız bir şekilde 5.000 istek limitine takılmıyoruz :) @@ -378,9 +378,9 @@ NOT: [#58](https://github.com/anuraghazra/github-readme-stats/pull/58) geliştir 1. [vercel.com](https://vercel.com/) adresine gidin 1. `Log in`'e tıklayın ![](https://files.catbox.moe/tct1wg.png) -1. `Continue with GitHub`'e basarak Github ile giriş yapın +1. `Continue with GitHub`'e basarak GitHub ile giriş yapın ![](https://files.catbox.moe/btd78j.jpeg) -1. Github'a giriş yapın ve eğer çıkarsa tüm repolara izin verin. +1. GitHub'a giriş yapın ve eğer çıkarsa tüm repolara izin verin. 1. Bu repoyu fork'layın 1. [Vercel dashboard](https://vercel.com/dashboard)'unuza geri dönün. 1. `Import Project`'i seçin. @@ -409,7 +409,7 @@ Teşekkürler! :heart: --- -[![https://vercel.com?utm_source=github_readme_stats_team&utm_campaign=oss](./powered-by-vercel.svg)](https://vercel.com?utm_source=github_readme_stats_team&utm_campaign=oss) +[![https://vercel.com?utm_source=github_readme_stats_team&utm_campaign=oss](../powered-by-vercel.svg)](https://vercel.com?utm_source=github_readme_stats_team&utm_campaign=oss) Katkılara açığız! <3 diff --git a/express.js b/express.js new file mode 100644 index 0000000000000..6ce92ff035181 --- /dev/null +++ b/express.js @@ -0,0 +1,15 @@ +import statsCard from "./api/index.js"; +import repoCard from "./api/pin.js"; +import langCard from "./api/top-langs.js"; +import wakatimeCard from "./api/wakatime.js"; +import express from "express"; +import dotenv from "dotenv"; + +dotenv.config(); +const app = express(); +app.listen(process.env.port || 9000); + +app.get("/", statsCard); +app.get("/pin", repoCard); +app.get("/top-langs", langCard); +app.get("/wakatime", wakatimeCard); diff --git a/jest.config.js b/jest.config.js index 312d88ad8e023..b4578cf5aaad5 100644 --- a/jest.config.js +++ b/jest.config.js @@ -3,4 +3,10 @@ export default { transform: {}, testEnvironment: "jsdom", coverageProvider: "v8", + testPathIgnorePatterns: ["/node_modules/", "/tests/e2e/"], + modulePathIgnorePatterns: ["/node_modules/", "/tests/e2e/"], + coveragePathIgnorePatterns: [ + "/node_modules/", + "/tests/E2E/", + ], }; diff --git a/jest.e2e.config.js b/jest.e2e.config.js new file mode 100644 index 0000000000000..656ab61f7c054 --- /dev/null +++ b/jest.e2e.config.js @@ -0,0 +1,7 @@ +export default { + clearMocks: true, + transform: {}, + testEnvironment: "node", + coverageProvider: "v8", + testMatch: ["/tests/e2e/**/*.test.js"], +}; diff --git a/package-lock.json b/package-lock.json index 2ffe6ec9008b2..ebc7570a41923 100644 --- a/package-lock.json +++ b/package-lock.json @@ -17,18 +17,19 @@ "word-wrap": "^1.2.3" }, "devDependencies": { - "@actions/core": "^1.2.4", + "@actions/core": "^1.9.1", "@actions/github": "^4.0.0", "@testing-library/dom": "^8.17.1", "@testing-library/jest-dom": "^5.16.5", "@uppercod/css-to-object": "^1.1.1", - "axios-mock-adapter": "^1.18.1", + "axios-mock-adapter": "^1.21.2", "color-contrast-checker": "^2.1.0", "hjson": "^3.2.2", - "husky": "^4.2.5", + "husky": "^8.0.0", "jest": "^29.0.3", "jest-environment-jsdom": "^29.0.3", "js-yaml": "^4.1.0", + "lint-staged": "^13.0.3", "lodash.snakecase": "^4.1.1", "parse-diff": "^0.7.0", "prettier": "^2.1.2" @@ -1427,12 +1428,6 @@ "integrity": "sha512-Sq1itGUKUX1ap7GgZlrzdBydjbsJL/NSQt/4wkAxUJ7/OS5c2WkoN6WSpWc2Yc5wtKMZOUA0VCs/j2XJadN3HA==", "dev": true }, - "node_modules/@types/parse-json": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/@types/parse-json/-/parse-json-4.0.0.tgz", - "integrity": "sha512-//oorEZjL6sbPcKUaCdIGlIUeH26mgzimjBB77G6XRgnDl/L5wOnpyBGRe/Mmf5CVW3PwEBE1NjiMZ/ssFh4wA==", - "dev": true - }, "node_modules/@types/prettier": { "version": "2.7.1", "resolved": "https://registry.npmjs.org/@types/prettier/-/prettier-2.7.1.tgz", @@ -1542,6 +1537,19 @@ "node": ">= 6.0.0" } }, + "node_modules/aggregate-error": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/aggregate-error/-/aggregate-error-3.1.0.tgz", + "integrity": "sha512-4I7Td01quW/RpocfNayFdFVk1qSuoh0E7JrbRJ16nH01HhKFQ88INq9Sd+nd72zqRySlr9BmDA8xlEJ6vJMrYA==", + "dev": true, + "dependencies": { + "clean-stack": "^2.0.0", + "indent-string": "^4.0.0" + }, + "engines": { + "node": ">=8" + } + }, "node_modules/ansi-escapes": { "version": "4.3.2", "resolved": "https://registry.npmjs.org/ansi-escapes/-/ansi-escapes-4.3.2.tgz", @@ -1609,6 +1617,15 @@ "node": ">=6.0" } }, + "node_modules/astral-regex": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/astral-regex/-/astral-regex-2.0.0.tgz", + "integrity": "sha512-Z7tMw1ytTXt5jqMcOP+OQteU1VuNK9Y02uuJtKQ1Sv69jXQKKg5cibLwGJow8yzZP+eAc18EmLGPal0bp36rvQ==", + "dev": true, + "engines": { + "node": ">=8" + } + }, "node_modules/asynckit": { "version": "0.4.0", "resolved": "https://registry.npmjs.org/asynckit/-/asynckit-0.4.0.tgz", @@ -1869,18 +1886,99 @@ "node": ">=10" } }, - "node_modules/ci-info": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/ci-info/-/ci-info-2.0.0.tgz", - "integrity": "sha512-5tK7EtrZ0N+OLFMthtqOj4fI2Jeb88C4CAZPu25LDVUgXJ0A3Js4PMGqrn0JU1W0Mh1/Z8wZzYPxqUrXeBboCQ==", - "dev": true - }, "node_modules/cjs-module-lexer": { "version": "1.2.2", "resolved": "https://registry.npmjs.org/cjs-module-lexer/-/cjs-module-lexer-1.2.2.tgz", "integrity": "sha512-cOU9usZw8/dXIXKtwa8pM0OTJQuJkxMN6w30csNRUerHfeQ5R6U3kkU/FtJeIf3M202OHfY2U8ccInBG7/xogA==", "dev": true }, + "node_modules/clean-stack": { + "version": "2.2.0", + "resolved": "https://registry.npmjs.org/clean-stack/-/clean-stack-2.2.0.tgz", + "integrity": "sha512-4diC9HaTE+KRAMWhDhrGOECgWZxoevMc5TlkObMqNSsVU62PYzXZ/SMTjzyGAFF1YusgxGcSWTEXBhp0CPwQ1A==", + "dev": true, + "engines": { + "node": ">=6" + } + }, + "node_modules/cli-cursor": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/cli-cursor/-/cli-cursor-3.1.0.tgz", + "integrity": "sha512-I/zHAwsKf9FqGoXM4WWRACob9+SNukZTd94DWF57E4toouRulbCxcUh6RKUEOQlYTHJnzkPMySvPNaaSLNfLZw==", + "dev": true, + "dependencies": { + "restore-cursor": "^3.1.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/cli-truncate": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/cli-truncate/-/cli-truncate-3.1.0.tgz", + "integrity": "sha512-wfOBkjXteqSnI59oPcJkcPl/ZmwvMMOj340qUIY1SKZCv0B9Cf4D4fAucRkIKQmsIuYK3x1rrgU7MeGRruiuiA==", + "dev": true, + "dependencies": { + "slice-ansi": "^5.0.0", + "string-width": "^5.0.0" + }, + "engines": { + "node": "^12.20.0 || ^14.13.1 || >=16.0.0" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/cli-truncate/node_modules/ansi-regex": { + "version": "6.0.1", + "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-6.0.1.tgz", + "integrity": "sha512-n5M855fKb2SsfMIiFFoVrABHJC8QtHwVx+mHWP3QcEqBHYienj5dHSgjbxtC0WEZXYt4wcD6zrQElDPhFuZgfA==", + "dev": true, + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/chalk/ansi-regex?sponsor=1" + } + }, + "node_modules/cli-truncate/node_modules/emoji-regex": { + "version": "9.2.2", + "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-9.2.2.tgz", + "integrity": "sha512-L18DaJsXSUk2+42pv8mLs5jJT2hqFkFE4j21wOmgbUqsZ2hL72NsUU785g9RXgo3s0ZNgVl42TiHp3ZtOv/Vyg==", + "dev": true + }, + "node_modules/cli-truncate/node_modules/string-width": { + "version": "5.1.2", + "resolved": "https://registry.npmjs.org/string-width/-/string-width-5.1.2.tgz", + "integrity": "sha512-HnLOCR3vjcY8beoNLtcjZ5/nxn2afmME6lhrDrebokqMap+XbeW8n9TXpPDOqdGK5qcI3oT0GKTW6wC7EMiVqA==", + "dev": true, + "dependencies": { + "eastasianwidth": "^0.2.0", + "emoji-regex": "^9.2.2", + "strip-ansi": "^7.0.1" + }, + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/cli-truncate/node_modules/strip-ansi": { + "version": "7.0.1", + "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-7.0.1.tgz", + "integrity": "sha512-cXNxvT8dFNRVfhVME3JAe98mkXDYN2O1l7jmcwMnOslDeESg1rF/OZMtK0nRAhiari1unG5cD4jG3rapUAkLbw==", + "dev": true, + "dependencies": { + "ansi-regex": "^6.0.1" + }, + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/chalk/strip-ansi?sponsor=1" + } + }, "node_modules/cliui": { "version": "7.0.4", "resolved": "https://registry.npmjs.org/cliui/-/cliui-7.0.4.tgz", @@ -1932,6 +2030,12 @@ "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==", "dev": true }, + "node_modules/colorette": { + "version": "2.0.19", + "resolved": "https://registry.npmjs.org/colorette/-/colorette-2.0.19.tgz", + "integrity": "sha512-3tlv/dIP7FWvj3BsbHrGLJ6l/oKh1O3TcgBqMn+yyCagOxc23fyzDS6HypQbgxWbkpDnf52p1LuR4eWDQ/K9WQ==", + "dev": true + }, "node_modules/combined-stream": { "version": "1.0.8", "resolved": "https://registry.npmjs.org/combined-stream/-/combined-stream-1.0.8.tgz", @@ -1944,11 +2048,14 @@ "node": ">= 0.8" } }, - "node_modules/compare-versions": { - "version": "3.6.0", - "resolved": "https://registry.npmjs.org/compare-versions/-/compare-versions-3.6.0.tgz", - "integrity": "sha512-W6Af2Iw1z4CB7q4uU4hv646dW9GQuBM+YpC0UvUCWSD8w90SJjp+ujJuXaEMtAXBtSqGfMPuFOVn4/+FlaqfBA==", - "dev": true + "node_modules/commander": { + "version": "9.4.1", + "resolved": "https://registry.npmjs.org/commander/-/commander-9.4.1.tgz", + "integrity": "sha512-5EEkTNyHNGFPD2H+c/dXXfQZYa/scCKasxWcXJaWnNJ99pnQN9Vnmqow+p+PlFPE63Q6mThaZws1T+HxfpgtPw==", + "dev": true, + "engines": { + "node": "^12.20.0 || >=14" + } }, "node_modules/concat-map": { "version": "0.0.1", @@ -1965,22 +2072,6 @@ "safe-buffer": "~5.1.1" } }, - "node_modules/cosmiconfig": { - "version": "7.0.1", - "resolved": "https://registry.npmjs.org/cosmiconfig/-/cosmiconfig-7.0.1.tgz", - "integrity": "sha512-a1YWNUV2HwGimB7dU2s1wUMurNKjpx60HxBB6xUM8Re+2s1g1IIfJvFR0/iCF+XHdE0GMTKTuLR32UQff4TEyQ==", - "dev": true, - "dependencies": { - "@types/parse-json": "^4.0.0", - "import-fresh": "^3.2.1", - "parse-json": "^5.0.0", - "path-type": "^4.0.0", - "yaml": "^1.10.0" - }, - "engines": { - "node": ">=10" - } - }, "node_modules/cross-spawn": { "version": "7.0.3", "resolved": "https://registry.npmjs.org/cross-spawn/-/cross-spawn-7.0.3.tgz", @@ -2142,6 +2233,12 @@ "node": ">=10" } }, + "node_modules/eastasianwidth": { + "version": "0.2.0", + "resolved": "https://registry.npmjs.org/eastasianwidth/-/eastasianwidth-0.2.0.tgz", + "integrity": "sha512-I88TYZWc9XiYHRQ4/3c5rjjfgkjhLyW2luGIheGERbNQ6OY7yTybanSpDXZa8y7VUP9YmDcYa+eyq4ca7iLqWA==", + "dev": true + }, "node_modules/electron-to-chromium": { "version": "1.4.260", "resolved": "https://registry.npmjs.org/electron-to-chromium/-/electron-to-chromium-1.4.260.tgz", @@ -2373,21 +2470,6 @@ "node": ">=8" } }, - "node_modules/find-versions": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/find-versions/-/find-versions-4.0.0.tgz", - "integrity": "sha512-wgpWy002tA+wgmO27buH/9KzyEOQnKsG/R0yrcjPT9BOFm0zRBVQbZ95nRGXWMywS8YR5knRbpohio0bcJABxQ==", - "dev": true, - "dependencies": { - "semver-regex": "^3.1.2" - }, - "engines": { - "node": ">=10" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, "node_modules/follow-redirects": { "version": "1.15.2", "resolved": "https://registry.npmjs.org/follow-redirects/-/follow-redirects-1.15.2.tgz", @@ -2611,33 +2693,18 @@ } }, "node_modules/husky": { - "version": "4.3.8", - "resolved": "https://registry.npmjs.org/husky/-/husky-4.3.8.tgz", - "integrity": "sha512-LCqqsB0PzJQ/AlCgfrfzRe3e3+NvmefAdKQhRYpxS4u6clblBoDdzzvHi8fmxKRzvMxPY/1WZWzomPZww0Anow==", + "version": "8.0.1", + "resolved": "https://registry.npmjs.org/husky/-/husky-8.0.1.tgz", + "integrity": "sha512-xs7/chUH/CKdOCs7Zy0Aev9e/dKOMZf3K1Az1nar3tzlv0jfqnYtu235bstsWTmXOR0EfINrPa97yy4Lz6RiKw==", "dev": true, - "hasInstallScript": true, - "dependencies": { - "chalk": "^4.0.0", - "ci-info": "^2.0.0", - "compare-versions": "^3.6.0", - "cosmiconfig": "^7.0.0", - "find-versions": "^4.0.0", - "opencollective-postinstall": "^2.0.2", - "pkg-dir": "^5.0.0", - "please-upgrade-node": "^3.2.0", - "slash": "^3.0.0", - "which-pm-runs": "^1.0.0" - }, "bin": { - "husky-run": "bin/run.js", - "husky-upgrade": "lib/upgrader/bin.js" + "husky": "lib/bin.js" }, "engines": { - "node": ">=10" + "node": ">=14" }, "funding": { - "type": "opencollective", - "url": "https://opencollective.com/husky" + "url": "https://github.com/sponsors/typicode" } }, "node_modules/iconv-lite": { @@ -2652,22 +2719,6 @@ "node": ">=0.10.0" } }, - "node_modules/import-fresh": { - "version": "3.3.0", - "resolved": "https://registry.npmjs.org/import-fresh/-/import-fresh-3.3.0.tgz", - "integrity": "sha512-veYYhQa+D1QBKznvhUHxb8faxlrwUnxseDAbAp457E0wLNio2bOSKnjYDhMj+YiAq61xrMGhQk9iXVk5FzgQMw==", - "dev": true, - "dependencies": { - "parent-module": "^1.0.0", - "resolve-from": "^4.0.0" - }, - "engines": { - "node": ">=6" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, "node_modules/import-local": { "version": "3.1.0", "resolved": "https://registry.npmjs.org/import-local/-/import-local-3.1.0.tgz", @@ -3920,12 +3971,218 @@ "node": ">= 0.8.0" } }, + "node_modules/lilconfig": { + "version": "2.0.5", + "resolved": "https://registry.npmjs.org/lilconfig/-/lilconfig-2.0.5.tgz", + "integrity": "sha512-xaYmXZtTHPAw5m+xLN8ab9C+3a8YmV3asNSPOATITbtwrfbwaLJj8h66H1WMIpALCkqsIzK3h7oQ+PdX+LQ9Eg==", + "dev": true, + "engines": { + "node": ">=10" + } + }, "node_modules/lines-and-columns": { "version": "1.2.4", "resolved": "https://registry.npmjs.org/lines-and-columns/-/lines-and-columns-1.2.4.tgz", "integrity": "sha512-7ylylesZQ/PV29jhEDl3Ufjo6ZX7gCqJr5F7PKrqc93v7fzSymt1BpwEU8nAUXs8qzzvqhbjhK5QZg6Mt/HkBg==", "dev": true }, + "node_modules/lint-staged": { + "version": "13.0.3", + "resolved": "https://registry.npmjs.org/lint-staged/-/lint-staged-13.0.3.tgz", + "integrity": "sha512-9hmrwSCFroTSYLjflGI8Uk+GWAwMB4OlpU4bMJEAT5d/llQwtYKoim4bLOyLCuWFAhWEupE0vkIFqtw/WIsPug==", + "dev": true, + "dependencies": { + "cli-truncate": "^3.1.0", + "colorette": "^2.0.17", + "commander": "^9.3.0", + "debug": "^4.3.4", + "execa": "^6.1.0", + "lilconfig": "2.0.5", + "listr2": "^4.0.5", + "micromatch": "^4.0.5", + "normalize-path": "^3.0.0", + "object-inspect": "^1.12.2", + "pidtree": "^0.6.0", + "string-argv": "^0.3.1", + "yaml": "^2.1.1" + }, + "bin": { + "lint-staged": "bin/lint-staged.js" + }, + "engines": { + "node": "^14.13.1 || >=16.0.0" + }, + "funding": { + "url": "https://opencollective.com/lint-staged" + } + }, + "node_modules/lint-staged/node_modules/execa": { + "version": "6.1.0", + "resolved": "https://registry.npmjs.org/execa/-/execa-6.1.0.tgz", + "integrity": "sha512-QVWlX2e50heYJcCPG0iWtf8r0xjEYfz/OYLGDYH+IyjWezzPNxz63qNFOu0l4YftGWuizFVZHHs8PrLU5p2IDA==", + "dev": true, + "dependencies": { + "cross-spawn": "^7.0.3", + "get-stream": "^6.0.1", + "human-signals": "^3.0.1", + "is-stream": "^3.0.0", + "merge-stream": "^2.0.0", + "npm-run-path": "^5.1.0", + "onetime": "^6.0.0", + "signal-exit": "^3.0.7", + "strip-final-newline": "^3.0.0" + }, + "engines": { + "node": "^12.20.0 || ^14.13.1 || >=16.0.0" + }, + "funding": { + "url": "https://github.com/sindresorhus/execa?sponsor=1" + } + }, + "node_modules/lint-staged/node_modules/human-signals": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/human-signals/-/human-signals-3.0.1.tgz", + "integrity": "sha512-rQLskxnM/5OCldHo+wNXbpVgDn5A17CUoKX+7Sokwaknlq7CdSnphy0W39GU8dw59XiCXmFXDg4fRuckQRKewQ==", + "dev": true, + "engines": { + "node": ">=12.20.0" + } + }, + "node_modules/lint-staged/node_modules/is-stream": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/is-stream/-/is-stream-3.0.0.tgz", + "integrity": "sha512-LnQR4bZ9IADDRSkvpqMGvt/tEJWclzklNgSw48V5EAaAeDd6qGvN8ei6k5p0tvxSR171VmGyHuTiAOfxAbr8kA==", + "dev": true, + "engines": { + "node": "^12.20.0 || ^14.13.1 || >=16.0.0" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/lint-staged/node_modules/mimic-fn": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/mimic-fn/-/mimic-fn-4.0.0.tgz", + "integrity": "sha512-vqiC06CuhBTUdZH+RYl8sFrL096vA45Ok5ISO6sE/Mr1jRbGH4Csnhi8f3wKVl7x8mO4Au7Ir9D3Oyv1VYMFJw==", + "dev": true, + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/lint-staged/node_modules/npm-run-path": { + "version": "5.1.0", + "resolved": "https://registry.npmjs.org/npm-run-path/-/npm-run-path-5.1.0.tgz", + "integrity": "sha512-sJOdmRGrY2sjNTRMbSvluQqg+8X7ZK61yvzBEIDhz4f8z1TZFYABsqjjCBd/0PUNE9M6QDgHJXQkGUEm7Q+l9Q==", + "dev": true, + "dependencies": { + "path-key": "^4.0.0" + }, + "engines": { + "node": "^12.20.0 || ^14.13.1 || >=16.0.0" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/lint-staged/node_modules/onetime": { + "version": "6.0.0", + "resolved": "https://registry.npmjs.org/onetime/-/onetime-6.0.0.tgz", + "integrity": "sha512-1FlR+gjXK7X+AsAHso35MnyN5KqGwJRi/31ft6x0M194ht7S+rWAvd7PHss9xSKMzE0asv1pyIHaJYq+BbacAQ==", + "dev": true, + "dependencies": { + "mimic-fn": "^4.0.0" + }, + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/lint-staged/node_modules/path-key": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/path-key/-/path-key-4.0.0.tgz", + "integrity": "sha512-haREypq7xkM7ErfgIyA0z+Bj4AGKlMSdlQE2jvJo6huWD1EdkKYV+G/T4nq0YEF2vgTT8kqMFKo1uHn950r4SQ==", + "dev": true, + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/lint-staged/node_modules/strip-final-newline": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/strip-final-newline/-/strip-final-newline-3.0.0.tgz", + "integrity": "sha512-dOESqjYr96iWYylGObzd39EuNTa5VJxyvVAEm5Jnh7KGo75V43Hk1odPQkNDyXNmUR6k+gEiDVXnjB8HJ3crXw==", + "dev": true, + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/listr2": { + "version": "4.0.5", + "resolved": "https://registry.npmjs.org/listr2/-/listr2-4.0.5.tgz", + "integrity": "sha512-juGHV1doQdpNT3GSTs9IUN43QJb7KHdF9uqg7Vufs/tG9VTzpFphqF4pm/ICdAABGQxsyNn9CiYA3StkI6jpwA==", + "dev": true, + "dependencies": { + "cli-truncate": "^2.1.0", + "colorette": "^2.0.16", + "log-update": "^4.0.0", + "p-map": "^4.0.0", + "rfdc": "^1.3.0", + "rxjs": "^7.5.5", + "through": "^2.3.8", + "wrap-ansi": "^7.0.0" + }, + "engines": { + "node": ">=12" + }, + "peerDependencies": { + "enquirer": ">= 2.3.0 < 3" + }, + "peerDependenciesMeta": { + "enquirer": { + "optional": true + } + } + }, + "node_modules/listr2/node_modules/cli-truncate": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/cli-truncate/-/cli-truncate-2.1.0.tgz", + "integrity": "sha512-n8fOixwDD6b/ObinzTrp1ZKFzbgvKZvuz/TvejnLn1aQfC6r52XEx85FmuC+3HI+JM7coBRXUvNqEU2PHVrHpg==", + "dev": true, + "dependencies": { + "slice-ansi": "^3.0.0", + "string-width": "^4.2.0" + }, + "engines": { + "node": ">=8" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/listr2/node_modules/slice-ansi": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/slice-ansi/-/slice-ansi-3.0.0.tgz", + "integrity": "sha512-pSyv7bSTC7ig9Dcgbw9AuRNUb5k5V6oDudjZoMBSr13qpLBG7tB+zgCkARjq7xIUgdz5P1Qe8u+rSGdouOOIyQ==", + "dev": true, + "dependencies": { + "ansi-styles": "^4.0.0", + "astral-regex": "^2.0.0", + "is-fullwidth-code-point": "^3.0.0" + }, + "engines": { + "node": ">=8" + } + }, "node_modules/locate-path": { "version": "5.0.0", "resolved": "https://registry.npmjs.org/locate-path/-/locate-path-5.0.0.tgz", @@ -3950,6 +4207,55 @@ "integrity": "sha512-QZ1d4xoBHYUeuouhEq3lk3Uq7ldgyFXGBhg04+oRLnIz8o9T65Eh+8YdroUwn846zchkA9yDsDl5CVVaV2nqYw==", "dev": true }, + "node_modules/log-update": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/log-update/-/log-update-4.0.0.tgz", + "integrity": "sha512-9fkkDevMefjg0mmzWFBW8YkFP91OrizzkW3diF7CpG+S2EYdy4+TVfGwz1zeF8x7hCx1ovSPTOE9Ngib74qqUg==", + "dev": true, + "dependencies": { + "ansi-escapes": "^4.3.0", + "cli-cursor": "^3.1.0", + "slice-ansi": "^4.0.0", + "wrap-ansi": "^6.2.0" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/log-update/node_modules/slice-ansi": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/slice-ansi/-/slice-ansi-4.0.0.tgz", + "integrity": "sha512-qMCMfhY040cVHT43K9BFygqYbUPFZKHOg7K73mtTWJRb8pyP3fzf4Ixd5SzdEJQ6MRUg/WBnOLxghZtKKurENQ==", + "dev": true, + "dependencies": { + "ansi-styles": "^4.0.0", + "astral-regex": "^2.0.0", + "is-fullwidth-code-point": "^3.0.0" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/chalk/slice-ansi?sponsor=1" + } + }, + "node_modules/log-update/node_modules/wrap-ansi": { + "version": "6.2.0", + "resolved": "https://registry.npmjs.org/wrap-ansi/-/wrap-ansi-6.2.0.tgz", + "integrity": "sha512-r6lPcBGxZXlIcymEu7InxDMhdW0KDxpLgoFLcguasxCaJ/SOIZwINatK9KY/tf+ZrlywOKU0UDj3ATXUBfxJXA==", + "dev": true, + "dependencies": { + "ansi-styles": "^4.0.0", + "string-width": "^4.1.0", + "strip-ansi": "^6.0.0" + }, + "engines": { + "node": ">=8" + } + }, "node_modules/lru-cache": { "version": "6.0.0", "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-6.0.0.tgz", @@ -4166,6 +4472,15 @@ "integrity": "sha512-90yv+6538zuvUMnN+zCr8LuV6bPFdq50304114vJYJ8RDyK8D5O9Phpbd6SZWgI7PwzmmfN1upeOJlvybDSgCw==", "dev": true }, + "node_modules/object-inspect": { + "version": "1.12.2", + "resolved": "https://registry.npmjs.org/object-inspect/-/object-inspect-1.12.2.tgz", + "integrity": "sha512-z+cPxW0QGUp0mcqcsgQyLVRDoXFQbXOwBaqyF7VIgI4TWNQsDHrBpUQslRmIfAoYWdYzs6UlKJtB2XJpTaNSpQ==", + "dev": true, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, "node_modules/once": { "version": "1.4.0", "resolved": "https://registry.npmjs.org/once/-/once-1.4.0.tgz", @@ -4190,15 +4505,6 @@ "url": "https://github.com/sponsors/sindresorhus" } }, - "node_modules/opencollective-postinstall": { - "version": "2.0.3", - "resolved": "https://registry.npmjs.org/opencollective-postinstall/-/opencollective-postinstall-2.0.3.tgz", - "integrity": "sha512-8AV/sCtuzUeTo8gQK5qDZzARrulB3egtLzFgteqB2tcT4Mw7B8Kt7JcDHmltjz6FOAHsvTevk70gZEbhM4ZS9Q==", - "dev": true, - "bin": { - "opencollective-postinstall": "index.js" - } - }, "node_modules/optionator": { "version": "0.8.3", "resolved": "https://registry.npmjs.org/optionator/-/optionator-0.8.3.tgz", @@ -4258,23 +4564,26 @@ "url": "https://github.com/sponsors/sindresorhus" } }, - "node_modules/p-try": { - "version": "2.2.0", - "resolved": "https://registry.npmjs.org/p-try/-/p-try-2.2.0.tgz", - "integrity": "sha512-R4nPAVTAU0B9D35/Gk3uJf/7XYbQcyohSKdvAxIRSNghFl4e71hVoGnBNQz9cWaXxO2I10KTC+3jMdvvoKw6dQ==", + "node_modules/p-map": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/p-map/-/p-map-4.0.0.tgz", + "integrity": "sha512-/bjOqmgETBYB5BoEeGVea8dmvHb2m9GLy1E9W43yeyfP6QQCZGFNa+XRceJEuDB6zqr+gKpIAmlLebMpykw/MQ==", "dev": true, + "dependencies": { + "aggregate-error": "^3.0.0" + }, "engines": { - "node": ">=6" + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" } }, - "node_modules/parent-module": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/parent-module/-/parent-module-1.0.1.tgz", - "integrity": "sha512-GQ2EWRpQV8/o+Aw8YqtfZZPfNRWZYkbidE9k5rpl/hC3vtHHBfGm2Ifi6qWV+coDGkrUKZAxE3Lot5kcsRlh+g==", + "node_modules/p-try": { + "version": "2.2.0", + "resolved": "https://registry.npmjs.org/p-try/-/p-try-2.2.0.tgz", + "integrity": "sha512-R4nPAVTAU0B9D35/Gk3uJf/7XYbQcyohSKdvAxIRSNghFl4e71hVoGnBNQz9cWaXxO2I10KTC+3jMdvvoKw6dQ==", "dev": true, - "dependencies": { - "callsites": "^3.0.0" - }, "engines": { "node": ">=6" } @@ -4348,15 +4657,6 @@ "integrity": "sha512-LDJzPVEEEPR+y48z93A0Ed0yXb8pAByGWo/k5YYdYgpY2/2EsOsksJrq7lOHxryrVOn1ejG6oAp8ahvOIQD8sw==", "dev": true }, - "node_modules/path-type": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/path-type/-/path-type-4.0.0.tgz", - "integrity": "sha512-gDKb8aZMDeD/tZWs9P6+q0J9Mwkdl6xMV8TjnGP3qJVJ06bdMgkbBlLU8IdfOsIsFz2BW1rNVT3XuNEl8zPAvw==", - "dev": true, - "engines": { - "node": ">=8" - } - }, "node_modules/picocolors": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/picocolors/-/picocolors-1.0.0.tgz", @@ -4375,80 +4675,25 @@ "url": "https://github.com/sponsors/jonschlinkert" } }, - "node_modules/pirates": { - "version": "4.0.5", - "resolved": "https://registry.npmjs.org/pirates/-/pirates-4.0.5.tgz", - "integrity": "sha512-8V9+HQPupnaXMA23c5hvl69zXvTwTzyAYasnkb0Tts4XvO4CliqONMOnvlq26rkhLC3nWDFBJf73LU1e1VZLaQ==", - "dev": true, - "engines": { - "node": ">= 6" - } - }, - "node_modules/pkg-dir": { - "version": "5.0.0", - "resolved": "https://registry.npmjs.org/pkg-dir/-/pkg-dir-5.0.0.tgz", - "integrity": "sha512-NPE8TDbzl/3YQYY7CSS228s3g2ollTFnc+Qi3tqmqJp9Vg2ovUpixcJEo2HJScN2Ez+kEaal6y70c0ehqJBJeA==", - "dev": true, - "dependencies": { - "find-up": "^5.0.0" - }, - "engines": { - "node": ">=10" - } - }, - "node_modules/pkg-dir/node_modules/find-up": { - "version": "5.0.0", - "resolved": "https://registry.npmjs.org/find-up/-/find-up-5.0.0.tgz", - "integrity": "sha512-78/PXT1wlLLDgTzDs7sjq9hzz0vXD+zn+7wypEe4fXQxCmdmqfGsEPQxmiCSQI3ajFV91bVSsvNtrJRiW6nGng==", - "dev": true, - "dependencies": { - "locate-path": "^6.0.0", - "path-exists": "^4.0.0" - }, - "engines": { - "node": ">=10" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/pkg-dir/node_modules/locate-path": { - "version": "6.0.0", - "resolved": "https://registry.npmjs.org/locate-path/-/locate-path-6.0.0.tgz", - "integrity": "sha512-iPZK6eYjbxRu3uB4/WZ3EsEIMJFMqAoopl3R+zuq0UjcAm/MO6KCweDgPfP3elTztoKP3KtnVHxTn2NHBSDVUw==", + "node_modules/pidtree": { + "version": "0.6.0", + "resolved": "https://registry.npmjs.org/pidtree/-/pidtree-0.6.0.tgz", + "integrity": "sha512-eG2dWTVw5bzqGRztnHExczNxt5VGsE6OwTeCG3fdUf9KBsZzO3R5OIIIzWR+iZA0NtZ+RDVdaoE2dK1cn6jH4g==", "dev": true, - "dependencies": { - "p-locate": "^5.0.0" + "bin": { + "pidtree": "bin/pidtree.js" }, "engines": { - "node": ">=10" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" + "node": ">=0.10" } }, - "node_modules/pkg-dir/node_modules/p-locate": { - "version": "5.0.0", - "resolved": "https://registry.npmjs.org/p-locate/-/p-locate-5.0.0.tgz", - "integrity": "sha512-LaNjtRWUBY++zB5nE/NwcaoMylSPk+S+ZHNB1TzdbMJMny6dynpAGt7X/tl/QYq3TIeE6nxHppbo2LGymrG5Pw==", + "node_modules/pirates": { + "version": "4.0.5", + "resolved": "https://registry.npmjs.org/pirates/-/pirates-4.0.5.tgz", + "integrity": "sha512-8V9+HQPupnaXMA23c5hvl69zXvTwTzyAYasnkb0Tts4XvO4CliqONMOnvlq26rkhLC3nWDFBJf73LU1e1VZLaQ==", "dev": true, - "dependencies": { - "p-limit": "^3.0.2" - }, "engines": { - "node": ">=10" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/please-upgrade-node": { - "version": "3.2.0", - "resolved": "https://registry.npmjs.org/please-upgrade-node/-/please-upgrade-node-3.2.0.tgz", - "integrity": "sha512-gQR3WpIgNIKwBMVLkpMUeR3e1/E1y42bqDQZfql+kDeXd8COYfM8PQA4X6y7a8u9Ua9FHmsrrmirW2vHs45hWg==", - "dev": true, - "dependencies": { - "semver-compare": "^1.0.0" + "node": ">= 6" } }, "node_modules/prelude-ls": { @@ -4613,15 +4858,6 @@ "node": ">=8" } }, - "node_modules/resolve-from": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/resolve-from/-/resolve-from-4.0.0.tgz", - "integrity": "sha512-pb/MYmXstAkysRFx8piNI1tGFNQIFA3vkE3Gq4EuA1dF6gHp/+vgZqsCGJapvy8N3Q+4o7FwvquPJcnZ7RYy4g==", - "dev": true, - "engines": { - "node": ">=4" - } - }, "node_modules/resolve.exports": { "version": "1.1.0", "resolved": "https://registry.npmjs.org/resolve.exports/-/resolve.exports-1.1.0.tgz", @@ -4631,6 +4867,34 @@ "node": ">=10" } }, + "node_modules/restore-cursor": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/restore-cursor/-/restore-cursor-3.1.0.tgz", + "integrity": "sha512-l+sSefzHpj5qimhFSE5a8nufZYAM3sBSVMAPtYkmC+4EH2anSGaEMXSD0izRQbu9nfyQ9y5JrVmp7E8oZrUjvA==", + "dev": true, + "dependencies": { + "onetime": "^5.1.0", + "signal-exit": "^3.0.2" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/rfdc": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/rfdc/-/rfdc-1.3.0.tgz", + "integrity": "sha512-V2hovdzFbOi77/WajaSMXk2OLm+xNIeQdMMuB7icj7bk6zi2F8GGAxigcnDFpJHbNyNcgyJDiP+8nOrY5cZGrA==", + "dev": true + }, + "node_modules/rxjs": { + "version": "7.5.7", + "resolved": "https://registry.npmjs.org/rxjs/-/rxjs-7.5.7.tgz", + "integrity": "sha512-z9MzKh/UcOqB3i20H6rtrlaE/CgjLOvheWK/9ILrbhROGTweAi1BaFsTT9FbwZi5Trr1qNRs+MXkhmR06awzQA==", + "dev": true, + "dependencies": { + "tslib": "^2.1.0" + } + }, "node_modules/safe-buffer": { "version": "5.1.2", "resolved": "https://registry.npmjs.org/safe-buffer/-/safe-buffer-5.1.2.tgz", @@ -4664,24 +4928,6 @@ "semver": "bin/semver.js" } }, - "node_modules/semver-compare": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/semver-compare/-/semver-compare-1.0.0.tgz", - "integrity": "sha512-YM3/ITh2MJ5MtzaM429anh+x2jiLVjqILF4m4oyQB18W7Ggea7BfqdH/wGMK7dDiMghv/6WG7znWMwUDzJiXow==", - "dev": true - }, - "node_modules/semver-regex": { - "version": "3.1.4", - "resolved": "https://registry.npmjs.org/semver-regex/-/semver-regex-3.1.4.tgz", - "integrity": "sha512-6IiqeZNgq01qGf0TId0t3NvKzSvUsjcpdEO3AQNeIjR6A2+ckTnQlDpl4qu1bjRv0RzN3FP9hzFmws3lKqRWkA==", - "dev": true, - "engines": { - "node": ">=8" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, "node_modules/shebang-command": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/shebang-command/-/shebang-command-2.0.0.tgz", @@ -4715,13 +4961,53 @@ "integrity": "sha512-bLGGlR1QxBcynn2d5YmDX4MGjlZvy2MRBDRNHLJ8VI6l6+9FUiyTFNJ0IveOSP0bcXgVDPRcfGqA0pjaqUpfVg==", "dev": true }, - "node_modules/slash": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/slash/-/slash-3.0.0.tgz", - "integrity": "sha512-g9Q1haeby36OSStwb4ntCGGGaKsaVSjQ68fBxoQcutl5fS1vuY18H3wSt3jFyFtrkx+Kz0V1G85A4MyAdDMi2Q==", + "node_modules/slash": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/slash/-/slash-3.0.0.tgz", + "integrity": "sha512-g9Q1haeby36OSStwb4ntCGGGaKsaVSjQ68fBxoQcutl5fS1vuY18H3wSt3jFyFtrkx+Kz0V1G85A4MyAdDMi2Q==", + "dev": true, + "engines": { + "node": ">=8" + } + }, + "node_modules/slice-ansi": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/slice-ansi/-/slice-ansi-5.0.0.tgz", + "integrity": "sha512-FC+lgizVPfie0kkhqUScwRu1O/lF6NOgJmlCgK+/LYxDCTk8sGelYaHDhFcDN+Sn3Cv+3VSa4Byeo+IMCzpMgQ==", + "dev": true, + "dependencies": { + "ansi-styles": "^6.0.0", + "is-fullwidth-code-point": "^4.0.0" + }, + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/chalk/slice-ansi?sponsor=1" + } + }, + "node_modules/slice-ansi/node_modules/ansi-styles": { + "version": "6.1.1", + "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-6.1.1.tgz", + "integrity": "sha512-qDOv24WjnYuL+wbwHdlsYZFy+cgPtrYw0Tn7GLORicQp9BkQLzrgI3Pm4VyR9ERZ41YTn7KlMPuL1n05WdZvmg==", + "dev": true, + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/chalk/ansi-styles?sponsor=1" + } + }, + "node_modules/slice-ansi/node_modules/is-fullwidth-code-point": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/is-fullwidth-code-point/-/is-fullwidth-code-point-4.0.0.tgz", + "integrity": "sha512-O4L094N2/dZ7xqVdrXhh9r1KODPJpFms8B5sGdJLPy664AgvXsreZUyCQQNItZRDlYug4xStLjNp/sz3HvBowQ==", "dev": true, "engines": { - "node": ">=8" + "node": ">=12" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" } }, "node_modules/source-map": { @@ -4761,6 +5047,15 @@ "node": ">=10" } }, + "node_modules/string-argv": { + "version": "0.3.1", + "resolved": "https://registry.npmjs.org/string-argv/-/string-argv-0.3.1.tgz", + "integrity": "sha512-a1uQGz7IyVy9YwhqjZIZu1c8JO8dNIe20xBmSS6qu9kv++k3JGzCVmprbNN5Kn+BgzD5E7YYwg1CcjuJMRNsvg==", + "dev": true, + "engines": { + "node": ">=0.6.19" + } + }, "node_modules/string-length": { "version": "4.0.2", "resolved": "https://registry.npmjs.org/string-length/-/string-length-4.0.2.tgz", @@ -4915,6 +5210,12 @@ "node": ">=8" } }, + "node_modules/through": { + "version": "2.3.8", + "resolved": "https://registry.npmjs.org/through/-/through-2.3.8.tgz", + "integrity": "sha512-w89qg7PI8wAdvX60bMDP+bFoD5Dvhm9oLheFp5O4a2QF0cSBGsBX4qZmadPMvVqlLJBBci+WqGGOAPvcDeNSVg==", + "dev": true + }, "node_modules/tmpl": { "version": "1.0.5", "resolved": "https://registry.npmjs.org/tmpl/-/tmpl-1.0.5.tgz", @@ -4969,6 +5270,12 @@ "node": ">=12" } }, + "node_modules/tslib": { + "version": "2.4.0", + "resolved": "https://registry.npmjs.org/tslib/-/tslib-2.4.0.tgz", + "integrity": "sha512-d6xOpEDfsi2CZVlPQzGeux8XMwLT9hssAsaPYExaQMuYskwb+x1x7J371tWlbBdWHroy99KnVB6qIkUbs5X3UQ==", + "dev": true + }, "node_modules/tunnel": { "version": "0.0.6", "resolved": "https://registry.npmjs.org/tunnel/-/tunnel-0.0.6.tgz", @@ -5178,15 +5485,6 @@ "node": ">= 8" } }, - "node_modules/which-pm-runs": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/which-pm-runs/-/which-pm-runs-1.1.0.tgz", - "integrity": "sha512-n1brCuqClxfFfq/Rb0ICg9giSZqCS+pLtccdag6C2HyufBrh3fBOiy9nb6ggRMvWOVH5GrdJskj5iGTZNxd7SA==", - "dev": true, - "engines": { - "node": ">=4" - } - }, "node_modules/word-wrap": { "version": "1.2.3", "resolved": "https://registry.npmjs.org/word-wrap/-/word-wrap-1.2.3.tgz", @@ -5283,12 +5581,12 @@ "dev": true }, "node_modules/yaml": { - "version": "1.10.2", - "resolved": "https://registry.npmjs.org/yaml/-/yaml-1.10.2.tgz", - "integrity": "sha512-r3vXyErRCYJ7wg28yvBY5VSoAF8ZvlcW9/BwUzEtUsjvX/DKs24dIkuwjtuprwJJHsbyUbLApepYTR1BN4uHrg==", + "version": "2.1.3", + "resolved": "https://registry.npmjs.org/yaml/-/yaml-2.1.3.tgz", + "integrity": "sha512-AacA8nRULjKMX2DvWvOAdBZMOfQlypSFkjcOcu9FalllIDJ1kvlREzcdIZmidQUqqeMv7jorHjq2HlLv/+c2lg==", "dev": true, "engines": { - "node": ">= 6" + "node": ">= 14" } }, "node_modules/yargs": { @@ -6471,12 +6769,6 @@ "integrity": "sha512-Sq1itGUKUX1ap7GgZlrzdBydjbsJL/NSQt/4wkAxUJ7/OS5c2WkoN6WSpWc2Yc5wtKMZOUA0VCs/j2XJadN3HA==", "dev": true }, - "@types/parse-json": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/@types/parse-json/-/parse-json-4.0.0.tgz", - "integrity": "sha512-//oorEZjL6sbPcKUaCdIGlIUeH26mgzimjBB77G6XRgnDl/L5wOnpyBGRe/Mmf5CVW3PwEBE1NjiMZ/ssFh4wA==", - "dev": true - }, "@types/prettier": { "version": "2.7.1", "resolved": "https://registry.npmjs.org/@types/prettier/-/prettier-2.7.1.tgz", @@ -6570,6 +6862,16 @@ "debug": "4" } }, + "aggregate-error": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/aggregate-error/-/aggregate-error-3.1.0.tgz", + "integrity": "sha512-4I7Td01quW/RpocfNayFdFVk1qSuoh0E7JrbRJ16nH01HhKFQ88INq9Sd+nd72zqRySlr9BmDA8xlEJ6vJMrYA==", + "dev": true, + "requires": { + "clean-stack": "^2.0.0", + "indent-string": "^4.0.0" + } + }, "ansi-escapes": { "version": "4.3.2", "resolved": "https://registry.npmjs.org/ansi-escapes/-/ansi-escapes-4.3.2.tgz", @@ -6616,6 +6918,12 @@ "integrity": "sha512-eigU3vhqSO+Z8BKDnVLN/ompjhf3pYzecKXz8+whRy+9gZu8n1TCGfwzQUUPnqdHl9ax1Hr9031orZ+UOEYr7Q==", "dev": true }, + "astral-regex": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/astral-regex/-/astral-regex-2.0.0.tgz", + "integrity": "sha512-Z7tMw1ytTXt5jqMcOP+OQteU1VuNK9Y02uuJtKQ1Sv69jXQKKg5cibLwGJow8yzZP+eAc18EmLGPal0bp36rvQ==", + "dev": true + }, "asynckit": { "version": "0.4.0", "resolved": "https://registry.npmjs.org/asynckit/-/asynckit-0.4.0.tgz", @@ -6808,18 +7116,71 @@ "integrity": "sha512-kWWXztvZ5SBQV+eRgKFeh8q5sLuZY2+8WUIzlxWVTg+oGwY14qylx1KbKzHd8P6ZYkAg0xyIDU9JMHhyJMZ1jw==", "dev": true }, - "ci-info": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/ci-info/-/ci-info-2.0.0.tgz", - "integrity": "sha512-5tK7EtrZ0N+OLFMthtqOj4fI2Jeb88C4CAZPu25LDVUgXJ0A3Js4PMGqrn0JU1W0Mh1/Z8wZzYPxqUrXeBboCQ==", - "dev": true - }, "cjs-module-lexer": { "version": "1.2.2", "resolved": "https://registry.npmjs.org/cjs-module-lexer/-/cjs-module-lexer-1.2.2.tgz", "integrity": "sha512-cOU9usZw8/dXIXKtwa8pM0OTJQuJkxMN6w30csNRUerHfeQ5R6U3kkU/FtJeIf3M202OHfY2U8ccInBG7/xogA==", "dev": true }, + "clean-stack": { + "version": "2.2.0", + "resolved": "https://registry.npmjs.org/clean-stack/-/clean-stack-2.2.0.tgz", + "integrity": "sha512-4diC9HaTE+KRAMWhDhrGOECgWZxoevMc5TlkObMqNSsVU62PYzXZ/SMTjzyGAFF1YusgxGcSWTEXBhp0CPwQ1A==", + "dev": true + }, + "cli-cursor": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/cli-cursor/-/cli-cursor-3.1.0.tgz", + "integrity": "sha512-I/zHAwsKf9FqGoXM4WWRACob9+SNukZTd94DWF57E4toouRulbCxcUh6RKUEOQlYTHJnzkPMySvPNaaSLNfLZw==", + "dev": true, + "requires": { + "restore-cursor": "^3.1.0" + } + }, + "cli-truncate": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/cli-truncate/-/cli-truncate-3.1.0.tgz", + "integrity": "sha512-wfOBkjXteqSnI59oPcJkcPl/ZmwvMMOj340qUIY1SKZCv0B9Cf4D4fAucRkIKQmsIuYK3x1rrgU7MeGRruiuiA==", + "dev": true, + "requires": { + "slice-ansi": "^5.0.0", + "string-width": "^5.0.0" + }, + "dependencies": { + "ansi-regex": { + "version": "6.0.1", + "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-6.0.1.tgz", + "integrity": "sha512-n5M855fKb2SsfMIiFFoVrABHJC8QtHwVx+mHWP3QcEqBHYienj5dHSgjbxtC0WEZXYt4wcD6zrQElDPhFuZgfA==", + "dev": true + }, + "emoji-regex": { + "version": "9.2.2", + "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-9.2.2.tgz", + "integrity": "sha512-L18DaJsXSUk2+42pv8mLs5jJT2hqFkFE4j21wOmgbUqsZ2hL72NsUU785g9RXgo3s0ZNgVl42TiHp3ZtOv/Vyg==", + "dev": true + }, + "string-width": { + "version": "5.1.2", + "resolved": "https://registry.npmjs.org/string-width/-/string-width-5.1.2.tgz", + "integrity": "sha512-HnLOCR3vjcY8beoNLtcjZ5/nxn2afmME6lhrDrebokqMap+XbeW8n9TXpPDOqdGK5qcI3oT0GKTW6wC7EMiVqA==", + "dev": true, + "requires": { + "eastasianwidth": "^0.2.0", + "emoji-regex": "^9.2.2", + "strip-ansi": "^7.0.1" + } + }, + "strip-ansi": { + "version": "7.0.1", + "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-7.0.1.tgz", + "integrity": "sha512-cXNxvT8dFNRVfhVME3JAe98mkXDYN2O1l7jmcwMnOslDeESg1rF/OZMtK0nRAhiari1unG5cD4jG3rapUAkLbw==", + "dev": true, + "requires": { + "ansi-regex": "^6.0.1" + } + } + } + }, "cliui": { "version": "7.0.4", "resolved": "https://registry.npmjs.org/cliui/-/cliui-7.0.4.tgz", @@ -6864,6 +7225,12 @@ "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==", "dev": true }, + "colorette": { + "version": "2.0.19", + "resolved": "https://registry.npmjs.org/colorette/-/colorette-2.0.19.tgz", + "integrity": "sha512-3tlv/dIP7FWvj3BsbHrGLJ6l/oKh1O3TcgBqMn+yyCagOxc23fyzDS6HypQbgxWbkpDnf52p1LuR4eWDQ/K9WQ==", + "dev": true + }, "combined-stream": { "version": "1.0.8", "resolved": "https://registry.npmjs.org/combined-stream/-/combined-stream-1.0.8.tgz", @@ -6873,10 +7240,10 @@ "delayed-stream": "~1.0.0" } }, - "compare-versions": { - "version": "3.6.0", - "resolved": "https://registry.npmjs.org/compare-versions/-/compare-versions-3.6.0.tgz", - "integrity": "sha512-W6Af2Iw1z4CB7q4uU4hv646dW9GQuBM+YpC0UvUCWSD8w90SJjp+ujJuXaEMtAXBtSqGfMPuFOVn4/+FlaqfBA==", + "commander": { + "version": "9.4.1", + "resolved": "https://registry.npmjs.org/commander/-/commander-9.4.1.tgz", + "integrity": "sha512-5EEkTNyHNGFPD2H+c/dXXfQZYa/scCKasxWcXJaWnNJ99pnQN9Vnmqow+p+PlFPE63Q6mThaZws1T+HxfpgtPw==", "dev": true }, "concat-map": { @@ -6894,19 +7261,6 @@ "safe-buffer": "~5.1.1" } }, - "cosmiconfig": { - "version": "7.0.1", - "resolved": "https://registry.npmjs.org/cosmiconfig/-/cosmiconfig-7.0.1.tgz", - "integrity": "sha512-a1YWNUV2HwGimB7dU2s1wUMurNKjpx60HxBB6xUM8Re+2s1g1IIfJvFR0/iCF+XHdE0GMTKTuLR32UQff4TEyQ==", - "dev": true, - "requires": { - "@types/parse-json": "^4.0.0", - "import-fresh": "^3.2.1", - "parse-json": "^5.0.0", - "path-type": "^4.0.0", - "yaml": "^1.10.0" - } - }, "cross-spawn": { "version": "7.0.3", "resolved": "https://registry.npmjs.org/cross-spawn/-/cross-spawn-7.0.3.tgz", @@ -7035,6 +7389,12 @@ "resolved": "https://registry.npmjs.org/dotenv/-/dotenv-8.6.0.tgz", "integrity": "sha512-IrPdXQsk2BbzvCBGBOTmmSH5SodmqZNt4ERAZDmW4CT+tL8VtvinqywuANaFu4bOMWki16nqf0e4oC0QIaDr/g==" }, + "eastasianwidth": { + "version": "0.2.0", + "resolved": "https://registry.npmjs.org/eastasianwidth/-/eastasianwidth-0.2.0.tgz", + "integrity": "sha512-I88TYZWc9XiYHRQ4/3c5rjjfgkjhLyW2luGIheGERbNQ6OY7yTybanSpDXZa8y7VUP9YmDcYa+eyq4ca7iLqWA==", + "dev": true + }, "electron-to-chromium": { "version": "1.4.260", "resolved": "https://registry.npmjs.org/electron-to-chromium/-/electron-to-chromium-1.4.260.tgz", @@ -7208,15 +7568,6 @@ "path-exists": "^4.0.0" } }, - "find-versions": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/find-versions/-/find-versions-4.0.0.tgz", - "integrity": "sha512-wgpWy002tA+wgmO27buH/9KzyEOQnKsG/R0yrcjPT9BOFm0zRBVQbZ95nRGXWMywS8YR5knRbpohio0bcJABxQ==", - "dev": true, - "requires": { - "semver-regex": "^3.1.2" - } - }, "follow-redirects": { "version": "1.15.2", "resolved": "https://registry.npmjs.org/follow-redirects/-/follow-redirects-1.15.2.tgz", @@ -7371,22 +7722,10 @@ "dev": true }, "husky": { - "version": "4.3.8", - "resolved": "https://registry.npmjs.org/husky/-/husky-4.3.8.tgz", - "integrity": "sha512-LCqqsB0PzJQ/AlCgfrfzRe3e3+NvmefAdKQhRYpxS4u6clblBoDdzzvHi8fmxKRzvMxPY/1WZWzomPZww0Anow==", - "dev": true, - "requires": { - "chalk": "^4.0.0", - "ci-info": "^2.0.0", - "compare-versions": "^3.6.0", - "cosmiconfig": "^7.0.0", - "find-versions": "^4.0.0", - "opencollective-postinstall": "^2.0.2", - "pkg-dir": "^5.0.0", - "please-upgrade-node": "^3.2.0", - "slash": "^3.0.0", - "which-pm-runs": "^1.0.0" - } + "version": "8.0.1", + "resolved": "https://registry.npmjs.org/husky/-/husky-8.0.1.tgz", + "integrity": "sha512-xs7/chUH/CKdOCs7Zy0Aev9e/dKOMZf3K1Az1nar3tzlv0jfqnYtu235bstsWTmXOR0EfINrPa97yy4Lz6RiKw==", + "dev": true }, "iconv-lite": { "version": "0.6.3", @@ -7397,16 +7736,6 @@ "safer-buffer": ">= 2.1.2 < 3.0.0" } }, - "import-fresh": { - "version": "3.3.0", - "resolved": "https://registry.npmjs.org/import-fresh/-/import-fresh-3.3.0.tgz", - "integrity": "sha512-veYYhQa+D1QBKznvhUHxb8faxlrwUnxseDAbAp457E0wLNio2bOSKnjYDhMj+YiAq61xrMGhQk9iXVk5FzgQMw==", - "dev": true, - "requires": { - "parent-module": "^1.0.0", - "resolve-from": "^4.0.0" - } - }, "import-local": { "version": "3.1.0", "resolved": "https://registry.npmjs.org/import-local/-/import-local-3.1.0.tgz", @@ -8354,12 +8683,145 @@ "type-check": "~0.3.2" } }, + "lilconfig": { + "version": "2.0.5", + "resolved": "https://registry.npmjs.org/lilconfig/-/lilconfig-2.0.5.tgz", + "integrity": "sha512-xaYmXZtTHPAw5m+xLN8ab9C+3a8YmV3asNSPOATITbtwrfbwaLJj8h66H1WMIpALCkqsIzK3h7oQ+PdX+LQ9Eg==", + "dev": true + }, "lines-and-columns": { "version": "1.2.4", "resolved": "https://registry.npmjs.org/lines-and-columns/-/lines-and-columns-1.2.4.tgz", "integrity": "sha512-7ylylesZQ/PV29jhEDl3Ufjo6ZX7gCqJr5F7PKrqc93v7fzSymt1BpwEU8nAUXs8qzzvqhbjhK5QZg6Mt/HkBg==", "dev": true }, + "lint-staged": { + "version": "13.0.3", + "resolved": "https://registry.npmjs.org/lint-staged/-/lint-staged-13.0.3.tgz", + "integrity": "sha512-9hmrwSCFroTSYLjflGI8Uk+GWAwMB4OlpU4bMJEAT5d/llQwtYKoim4bLOyLCuWFAhWEupE0vkIFqtw/WIsPug==", + "dev": true, + "requires": { + "cli-truncate": "^3.1.0", + "colorette": "^2.0.17", + "commander": "^9.3.0", + "debug": "^4.3.4", + "execa": "^6.1.0", + "lilconfig": "2.0.5", + "listr2": "^4.0.5", + "micromatch": "^4.0.5", + "normalize-path": "^3.0.0", + "object-inspect": "^1.12.2", + "pidtree": "^0.6.0", + "string-argv": "^0.3.1", + "yaml": "^2.1.1" + }, + "dependencies": { + "execa": { + "version": "6.1.0", + "resolved": "https://registry.npmjs.org/execa/-/execa-6.1.0.tgz", + "integrity": "sha512-QVWlX2e50heYJcCPG0iWtf8r0xjEYfz/OYLGDYH+IyjWezzPNxz63qNFOu0l4YftGWuizFVZHHs8PrLU5p2IDA==", + "dev": true, + "requires": { + "cross-spawn": "^7.0.3", + "get-stream": "^6.0.1", + "human-signals": "^3.0.1", + "is-stream": "^3.0.0", + "merge-stream": "^2.0.0", + "npm-run-path": "^5.1.0", + "onetime": "^6.0.0", + "signal-exit": "^3.0.7", + "strip-final-newline": "^3.0.0" + } + }, + "human-signals": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/human-signals/-/human-signals-3.0.1.tgz", + "integrity": "sha512-rQLskxnM/5OCldHo+wNXbpVgDn5A17CUoKX+7Sokwaknlq7CdSnphy0W39GU8dw59XiCXmFXDg4fRuckQRKewQ==", + "dev": true + }, + "is-stream": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/is-stream/-/is-stream-3.0.0.tgz", + "integrity": "sha512-LnQR4bZ9IADDRSkvpqMGvt/tEJWclzklNgSw48V5EAaAeDd6qGvN8ei6k5p0tvxSR171VmGyHuTiAOfxAbr8kA==", + "dev": true + }, + "mimic-fn": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/mimic-fn/-/mimic-fn-4.0.0.tgz", + "integrity": "sha512-vqiC06CuhBTUdZH+RYl8sFrL096vA45Ok5ISO6sE/Mr1jRbGH4Csnhi8f3wKVl7x8mO4Au7Ir9D3Oyv1VYMFJw==", + "dev": true + }, + "npm-run-path": { + "version": "5.1.0", + "resolved": "https://registry.npmjs.org/npm-run-path/-/npm-run-path-5.1.0.tgz", + "integrity": "sha512-sJOdmRGrY2sjNTRMbSvluQqg+8X7ZK61yvzBEIDhz4f8z1TZFYABsqjjCBd/0PUNE9M6QDgHJXQkGUEm7Q+l9Q==", + "dev": true, + "requires": { + "path-key": "^4.0.0" + } + }, + "onetime": { + "version": "6.0.0", + "resolved": "https://registry.npmjs.org/onetime/-/onetime-6.0.0.tgz", + "integrity": "sha512-1FlR+gjXK7X+AsAHso35MnyN5KqGwJRi/31ft6x0M194ht7S+rWAvd7PHss9xSKMzE0asv1pyIHaJYq+BbacAQ==", + "dev": true, + "requires": { + "mimic-fn": "^4.0.0" + } + }, + "path-key": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/path-key/-/path-key-4.0.0.tgz", + "integrity": "sha512-haREypq7xkM7ErfgIyA0z+Bj4AGKlMSdlQE2jvJo6huWD1EdkKYV+G/T4nq0YEF2vgTT8kqMFKo1uHn950r4SQ==", + "dev": true + }, + "strip-final-newline": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/strip-final-newline/-/strip-final-newline-3.0.0.tgz", + "integrity": "sha512-dOESqjYr96iWYylGObzd39EuNTa5VJxyvVAEm5Jnh7KGo75V43Hk1odPQkNDyXNmUR6k+gEiDVXnjB8HJ3crXw==", + "dev": true + } + } + }, + "listr2": { + "version": "4.0.5", + "resolved": "https://registry.npmjs.org/listr2/-/listr2-4.0.5.tgz", + "integrity": "sha512-juGHV1doQdpNT3GSTs9IUN43QJb7KHdF9uqg7Vufs/tG9VTzpFphqF4pm/ICdAABGQxsyNn9CiYA3StkI6jpwA==", + "dev": true, + "requires": { + "cli-truncate": "^2.1.0", + "colorette": "^2.0.16", + "log-update": "^4.0.0", + "p-map": "^4.0.0", + "rfdc": "^1.3.0", + "rxjs": "^7.5.5", + "through": "^2.3.8", + "wrap-ansi": "^7.0.0" + }, + "dependencies": { + "cli-truncate": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/cli-truncate/-/cli-truncate-2.1.0.tgz", + "integrity": "sha512-n8fOixwDD6b/ObinzTrp1ZKFzbgvKZvuz/TvejnLn1aQfC6r52XEx85FmuC+3HI+JM7coBRXUvNqEU2PHVrHpg==", + "dev": true, + "requires": { + "slice-ansi": "^3.0.0", + "string-width": "^4.2.0" + } + }, + "slice-ansi": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/slice-ansi/-/slice-ansi-3.0.0.tgz", + "integrity": "sha512-pSyv7bSTC7ig9Dcgbw9AuRNUb5k5V6oDudjZoMBSr13qpLBG7tB+zgCkARjq7xIUgdz5P1Qe8u+rSGdouOOIyQ==", + "dev": true, + "requires": { + "ansi-styles": "^4.0.0", + "astral-regex": "^2.0.0", + "is-fullwidth-code-point": "^3.0.0" + } + } + } + }, "locate-path": { "version": "5.0.0", "resolved": "https://registry.npmjs.org/locate-path/-/locate-path-5.0.0.tgz", @@ -8381,6 +8843,42 @@ "integrity": "sha512-QZ1d4xoBHYUeuouhEq3lk3Uq7ldgyFXGBhg04+oRLnIz8o9T65Eh+8YdroUwn846zchkA9yDsDl5CVVaV2nqYw==", "dev": true }, + "log-update": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/log-update/-/log-update-4.0.0.tgz", + "integrity": "sha512-9fkkDevMefjg0mmzWFBW8YkFP91OrizzkW3diF7CpG+S2EYdy4+TVfGwz1zeF8x7hCx1ovSPTOE9Ngib74qqUg==", + "dev": true, + "requires": { + "ansi-escapes": "^4.3.0", + "cli-cursor": "^3.1.0", + "slice-ansi": "^4.0.0", + "wrap-ansi": "^6.2.0" + }, + "dependencies": { + "slice-ansi": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/slice-ansi/-/slice-ansi-4.0.0.tgz", + "integrity": "sha512-qMCMfhY040cVHT43K9BFygqYbUPFZKHOg7K73mtTWJRb8pyP3fzf4Ixd5SzdEJQ6MRUg/WBnOLxghZtKKurENQ==", + "dev": true, + "requires": { + "ansi-styles": "^4.0.0", + "astral-regex": "^2.0.0", + "is-fullwidth-code-point": "^3.0.0" + } + }, + "wrap-ansi": { + "version": "6.2.0", + "resolved": "https://registry.npmjs.org/wrap-ansi/-/wrap-ansi-6.2.0.tgz", + "integrity": "sha512-r6lPcBGxZXlIcymEu7InxDMhdW0KDxpLgoFLcguasxCaJ/SOIZwINatK9KY/tf+ZrlywOKU0UDj3ATXUBfxJXA==", + "dev": true, + "requires": { + "ansi-styles": "^4.0.0", + "string-width": "^4.1.0", + "strip-ansi": "^6.0.0" + } + } + } + }, "lru-cache": { "version": "6.0.0", "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-6.0.0.tgz", @@ -8552,6 +9050,12 @@ "integrity": "sha512-90yv+6538zuvUMnN+zCr8LuV6bPFdq50304114vJYJ8RDyK8D5O9Phpbd6SZWgI7PwzmmfN1upeOJlvybDSgCw==", "dev": true }, + "object-inspect": { + "version": "1.12.2", + "resolved": "https://registry.npmjs.org/object-inspect/-/object-inspect-1.12.2.tgz", + "integrity": "sha512-z+cPxW0QGUp0mcqcsgQyLVRDoXFQbXOwBaqyF7VIgI4TWNQsDHrBpUQslRmIfAoYWdYzs6UlKJtB2XJpTaNSpQ==", + "dev": true + }, "once": { "version": "1.4.0", "resolved": "https://registry.npmjs.org/once/-/once-1.4.0.tgz", @@ -8570,12 +9074,6 @@ "mimic-fn": "^2.1.0" } }, - "opencollective-postinstall": { - "version": "2.0.3", - "resolved": "https://registry.npmjs.org/opencollective-postinstall/-/opencollective-postinstall-2.0.3.tgz", - "integrity": "sha512-8AV/sCtuzUeTo8gQK5qDZzARrulB3egtLzFgteqB2tcT4Mw7B8Kt7JcDHmltjz6FOAHsvTevk70gZEbhM4ZS9Q==", - "dev": true - }, "optionator": { "version": "0.8.3", "resolved": "https://registry.npmjs.org/optionator/-/optionator-0.8.3.tgz", @@ -8619,21 +9117,21 @@ } } }, + "p-map": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/p-map/-/p-map-4.0.0.tgz", + "integrity": "sha512-/bjOqmgETBYB5BoEeGVea8dmvHb2m9GLy1E9W43yeyfP6QQCZGFNa+XRceJEuDB6zqr+gKpIAmlLebMpykw/MQ==", + "dev": true, + "requires": { + "aggregate-error": "^3.0.0" + } + }, "p-try": { "version": "2.2.0", "resolved": "https://registry.npmjs.org/p-try/-/p-try-2.2.0.tgz", "integrity": "sha512-R4nPAVTAU0B9D35/Gk3uJf/7XYbQcyohSKdvAxIRSNghFl4e71hVoGnBNQz9cWaXxO2I10KTC+3jMdvvoKw6dQ==", "dev": true }, - "parent-module": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/parent-module/-/parent-module-1.0.1.tgz", - "integrity": "sha512-GQ2EWRpQV8/o+Aw8YqtfZZPfNRWZYkbidE9k5rpl/hC3vtHHBfGm2Ifi6qWV+coDGkrUKZAxE3Lot5kcsRlh+g==", - "dev": true, - "requires": { - "callsites": "^3.0.0" - } - }, "parse-diff": { "version": "0.7.1", "resolved": "https://registry.npmjs.org/parse-diff/-/parse-diff-0.7.1.tgz", @@ -8685,12 +9183,6 @@ "integrity": "sha512-LDJzPVEEEPR+y48z93A0Ed0yXb8pAByGWo/k5YYdYgpY2/2EsOsksJrq7lOHxryrVOn1ejG6oAp8ahvOIQD8sw==", "dev": true }, - "path-type": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/path-type/-/path-type-4.0.0.tgz", - "integrity": "sha512-gDKb8aZMDeD/tZWs9P6+q0J9Mwkdl6xMV8TjnGP3qJVJ06bdMgkbBlLU8IdfOsIsFz2BW1rNVT3XuNEl8zPAvw==", - "dev": true - }, "picocolors": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/picocolors/-/picocolors-1.0.0.tgz", @@ -8703,60 +9195,18 @@ "integrity": "sha512-JU3teHTNjmE2VCGFzuY8EXzCDVwEqB2a8fsIvwaStHhAWJEeVd1o1QD80CU6+ZdEXXSLbSsuLwJjkCBWqRQUVA==", "dev": true }, + "pidtree": { + "version": "0.6.0", + "resolved": "https://registry.npmjs.org/pidtree/-/pidtree-0.6.0.tgz", + "integrity": "sha512-eG2dWTVw5bzqGRztnHExczNxt5VGsE6OwTeCG3fdUf9KBsZzO3R5OIIIzWR+iZA0NtZ+RDVdaoE2dK1cn6jH4g==", + "dev": true + }, "pirates": { "version": "4.0.5", "resolved": "https://registry.npmjs.org/pirates/-/pirates-4.0.5.tgz", "integrity": "sha512-8V9+HQPupnaXMA23c5hvl69zXvTwTzyAYasnkb0Tts4XvO4CliqONMOnvlq26rkhLC3nWDFBJf73LU1e1VZLaQ==", "dev": true }, - "pkg-dir": { - "version": "5.0.0", - "resolved": "https://registry.npmjs.org/pkg-dir/-/pkg-dir-5.0.0.tgz", - "integrity": "sha512-NPE8TDbzl/3YQYY7CSS228s3g2ollTFnc+Qi3tqmqJp9Vg2ovUpixcJEo2HJScN2Ez+kEaal6y70c0ehqJBJeA==", - "dev": true, - "requires": { - "find-up": "^5.0.0" - }, - "dependencies": { - "find-up": { - "version": "5.0.0", - "resolved": "https://registry.npmjs.org/find-up/-/find-up-5.0.0.tgz", - "integrity": "sha512-78/PXT1wlLLDgTzDs7sjq9hzz0vXD+zn+7wypEe4fXQxCmdmqfGsEPQxmiCSQI3ajFV91bVSsvNtrJRiW6nGng==", - "dev": true, - "requires": { - "locate-path": "^6.0.0", - "path-exists": "^4.0.0" - } - }, - "locate-path": { - "version": "6.0.0", - "resolved": "https://registry.npmjs.org/locate-path/-/locate-path-6.0.0.tgz", - "integrity": "sha512-iPZK6eYjbxRu3uB4/WZ3EsEIMJFMqAoopl3R+zuq0UjcAm/MO6KCweDgPfP3elTztoKP3KtnVHxTn2NHBSDVUw==", - "dev": true, - "requires": { - "p-locate": "^5.0.0" - } - }, - "p-locate": { - "version": "5.0.0", - "resolved": "https://registry.npmjs.org/p-locate/-/p-locate-5.0.0.tgz", - "integrity": "sha512-LaNjtRWUBY++zB5nE/NwcaoMylSPk+S+ZHNB1TzdbMJMny6dynpAGt7X/tl/QYq3TIeE6nxHppbo2LGymrG5Pw==", - "dev": true, - "requires": { - "p-limit": "^3.0.2" - } - } - } - }, - "please-upgrade-node": { - "version": "3.2.0", - "resolved": "https://registry.npmjs.org/please-upgrade-node/-/please-upgrade-node-3.2.0.tgz", - "integrity": "sha512-gQR3WpIgNIKwBMVLkpMUeR3e1/E1y42bqDQZfql+kDeXd8COYfM8PQA4X6y7a8u9Ua9FHmsrrmirW2vHs45hWg==", - "dev": true, - "requires": { - "semver-compare": "^1.0.0" - } - }, "prelude-ls": { "version": "1.1.2", "resolved": "https://registry.npmjs.org/prelude-ls/-/prelude-ls-1.1.2.tgz", @@ -8878,18 +9328,37 @@ } } }, - "resolve-from": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/resolve-from/-/resolve-from-4.0.0.tgz", - "integrity": "sha512-pb/MYmXstAkysRFx8piNI1tGFNQIFA3vkE3Gq4EuA1dF6gHp/+vgZqsCGJapvy8N3Q+4o7FwvquPJcnZ7RYy4g==", - "dev": true - }, "resolve.exports": { "version": "1.1.0", "resolved": "https://registry.npmjs.org/resolve.exports/-/resolve.exports-1.1.0.tgz", "integrity": "sha512-J1l+Zxxp4XK3LUDZ9m60LRJF/mAe4z6a4xyabPHk7pvK5t35dACV32iIjJDFeWZFfZlO29w6SZ67knR0tHzJtQ==", "dev": true }, + "restore-cursor": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/restore-cursor/-/restore-cursor-3.1.0.tgz", + "integrity": "sha512-l+sSefzHpj5qimhFSE5a8nufZYAM3sBSVMAPtYkmC+4EH2anSGaEMXSD0izRQbu9nfyQ9y5JrVmp7E8oZrUjvA==", + "dev": true, + "requires": { + "onetime": "^5.1.0", + "signal-exit": "^3.0.2" + } + }, + "rfdc": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/rfdc/-/rfdc-1.3.0.tgz", + "integrity": "sha512-V2hovdzFbOi77/WajaSMXk2OLm+xNIeQdMMuB7icj7bk6zi2F8GGAxigcnDFpJHbNyNcgyJDiP+8nOrY5cZGrA==", + "dev": true + }, + "rxjs": { + "version": "7.5.7", + "resolved": "https://registry.npmjs.org/rxjs/-/rxjs-7.5.7.tgz", + "integrity": "sha512-z9MzKh/UcOqB3i20H6rtrlaE/CgjLOvheWK/9ILrbhROGTweAi1BaFsTT9FbwZi5Trr1qNRs+MXkhmR06awzQA==", + "dev": true, + "requires": { + "tslib": "^2.1.0" + } + }, "safe-buffer": { "version": "5.1.2", "resolved": "https://registry.npmjs.org/safe-buffer/-/safe-buffer-5.1.2.tgz", @@ -8917,18 +9386,6 @@ "integrity": "sha512-b39TBaTSfV6yBrapU89p5fKekE2m/NwnDocOVruQFS1/veMgdzuPcnOM34M6CwxW8jH/lxEa5rBoDeUwu5HHTw==", "dev": true }, - "semver-compare": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/semver-compare/-/semver-compare-1.0.0.tgz", - "integrity": "sha512-YM3/ITh2MJ5MtzaM429anh+x2jiLVjqILF4m4oyQB18W7Ggea7BfqdH/wGMK7dDiMghv/6WG7znWMwUDzJiXow==", - "dev": true - }, - "semver-regex": { - "version": "3.1.4", - "resolved": "https://registry.npmjs.org/semver-regex/-/semver-regex-3.1.4.tgz", - "integrity": "sha512-6IiqeZNgq01qGf0TId0t3NvKzSvUsjcpdEO3AQNeIjR6A2+ckTnQlDpl4qu1bjRv0RzN3FP9hzFmws3lKqRWkA==", - "dev": true - }, "shebang-command": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/shebang-command/-/shebang-command-2.0.0.tgz", @@ -8962,6 +9419,30 @@ "integrity": "sha512-g9Q1haeby36OSStwb4ntCGGGaKsaVSjQ68fBxoQcutl5fS1vuY18H3wSt3jFyFtrkx+Kz0V1G85A4MyAdDMi2Q==", "dev": true }, + "slice-ansi": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/slice-ansi/-/slice-ansi-5.0.0.tgz", + "integrity": "sha512-FC+lgizVPfie0kkhqUScwRu1O/lF6NOgJmlCgK+/LYxDCTk8sGelYaHDhFcDN+Sn3Cv+3VSa4Byeo+IMCzpMgQ==", + "dev": true, + "requires": { + "ansi-styles": "^6.0.0", + "is-fullwidth-code-point": "^4.0.0" + }, + "dependencies": { + "ansi-styles": { + "version": "6.1.1", + "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-6.1.1.tgz", + "integrity": "sha512-qDOv24WjnYuL+wbwHdlsYZFy+cgPtrYw0Tn7GLORicQp9BkQLzrgI3Pm4VyR9ERZ41YTn7KlMPuL1n05WdZvmg==", + "dev": true + }, + "is-fullwidth-code-point": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/is-fullwidth-code-point/-/is-fullwidth-code-point-4.0.0.tgz", + "integrity": "sha512-O4L094N2/dZ7xqVdrXhh9r1KODPJpFms8B5sGdJLPy664AgvXsreZUyCQQNItZRDlYug4xStLjNp/sz3HvBowQ==", + "dev": true + } + } + }, "source-map": { "version": "0.6.1", "resolved": "https://registry.npmjs.org/source-map/-/source-map-0.6.1.tgz", @@ -8993,6 +9474,12 @@ "escape-string-regexp": "^2.0.0" } }, + "string-argv": { + "version": "0.3.1", + "resolved": "https://registry.npmjs.org/string-argv/-/string-argv-0.3.1.tgz", + "integrity": "sha512-a1uQGz7IyVy9YwhqjZIZu1c8JO8dNIe20xBmSS6qu9kv++k3JGzCVmprbNN5Kn+BgzD5E7YYwg1CcjuJMRNsvg==", + "dev": true + }, "string-length": { "version": "4.0.2", "resolved": "https://registry.npmjs.org/string-length/-/string-length-4.0.2.tgz", @@ -9102,6 +9589,12 @@ "minimatch": "^3.0.4" } }, + "through": { + "version": "2.3.8", + "resolved": "https://registry.npmjs.org/through/-/through-2.3.8.tgz", + "integrity": "sha512-w89qg7PI8wAdvX60bMDP+bFoD5Dvhm9oLheFp5O4a2QF0cSBGsBX4qZmadPMvVqlLJBBci+WqGGOAPvcDeNSVg==", + "dev": true + }, "tmpl": { "version": "1.0.5", "resolved": "https://registry.npmjs.org/tmpl/-/tmpl-1.0.5.tgz", @@ -9144,6 +9637,12 @@ "punycode": "^2.1.1" } }, + "tslib": { + "version": "2.4.0", + "resolved": "https://registry.npmjs.org/tslib/-/tslib-2.4.0.tgz", + "integrity": "sha512-d6xOpEDfsi2CZVlPQzGeux8XMwLT9hssAsaPYExaQMuYskwb+x1x7J371tWlbBdWHroy99KnVB6qIkUbs5X3UQ==", + "dev": true + }, "tunnel": { "version": "0.0.6", "resolved": "https://registry.npmjs.org/tunnel/-/tunnel-0.0.6.tgz", @@ -9292,12 +9791,6 @@ "isexe": "^2.0.0" } }, - "which-pm-runs": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/which-pm-runs/-/which-pm-runs-1.1.0.tgz", - "integrity": "sha512-n1brCuqClxfFfq/Rb0ICg9giSZqCS+pLtccdag6C2HyufBrh3fBOiy9nb6ggRMvWOVH5GrdJskj5iGTZNxd7SA==", - "dev": true - }, "word-wrap": { "version": "1.2.3", "resolved": "https://registry.npmjs.org/word-wrap/-/word-wrap-1.2.3.tgz", @@ -9362,9 +9855,9 @@ "dev": true }, "yaml": { - "version": "1.10.2", - "resolved": "https://registry.npmjs.org/yaml/-/yaml-1.10.2.tgz", - "integrity": "sha512-r3vXyErRCYJ7wg28yvBY5VSoAF8ZvlcW9/BwUzEtUsjvX/DKs24dIkuwjtuprwJJHsbyUbLApepYTR1BN4uHrg==", + "version": "2.1.3", + "resolved": "https://registry.npmjs.org/yaml/-/yaml-2.1.3.tgz", + "integrity": "sha512-AacA8nRULjKMX2DvWvOAdBZMOfQlypSFkjcOcu9FalllIDJ1kvlREzcdIZmidQUqqeMv7jorHjq2HlLv/+c2lg==", "dev": true }, "yargs": { diff --git a/package.json b/package.json index c256229340145..606d4f5440a24 100644 --- a/package.json +++ b/package.json @@ -1,34 +1,52 @@ { "name": "github-readme-stats", "version": "1.0.0", - "description": "Dynamically generate stats for your github readmes", - "main": "index.js", + "description": "Dynamically generate stats for your GitHub readme", + "keywords": [ + "github-readme-stats", + "readme-stats", + "cards", + "card-generator" + ], + "main": "src/index.js", "type": "module", + "homepage": "https://github.com/anuraghazra/github-readme-stats", + "bugs": { + "url": "https://github.com/anuraghazra/github-readme-stats/issues" + }, + "repository": { + "type": "git", + "url": "https://github.com/anuraghazra/github-readme-stats.git" + }, "scripts": { "test": "node --experimental-vm-modules node_modules/jest/bin/jest.js --coverage", "test:watch": "node --experimental-vm-modules node_modules/jest/bin/jest.js --watch", "test:update:snapshot": "node --experimental-vm-modules node_modules/jest/bin/jest.js -u", + "test:e2e": "node --experimental-vm-modules node_modules/jest/bin/jest.js --config jest.e2e.config.js", "theme-readme-gen": "node scripts/generate-theme-doc", "preview-theme": "node scripts/preview-theme", + "close-stale-theme-prs": "node scripts/close-stale-theme-prs", "generate-langs-json": "node scripts/generate-langs-json", - "format": "./node_modules/.bin/prettier --write .", - "format:check": "./node_modules/.bin/prettier --check ." + "format": "prettier --write .", + "format:check": "prettier --check .", + "prepare": "husky install" }, "author": "Anurag Hazra", "license": "MIT", "devDependencies": { - "@actions/core": "^1.2.4", + "@actions/core": "^1.9.1", "@actions/github": "^4.0.0", "@testing-library/dom": "^8.17.1", "@testing-library/jest-dom": "^5.16.5", "@uppercod/css-to-object": "^1.1.1", - "axios-mock-adapter": "^1.18.1", + "axios-mock-adapter": "^1.21.2", "color-contrast-checker": "^2.1.0", "hjson": "^3.2.2", - "husky": "^4.2.5", + "husky": "^8.0.0", "jest": "^29.0.3", "jest-environment-jsdom": "^29.0.3", "js-yaml": "^4.1.0", + "lint-staged": "^13.0.3", "lodash.snakecase": "^4.1.1", "parse-diff": "^0.7.0", "prettier": "^2.1.2" @@ -41,9 +59,7 @@ "upgrade": "^1.1.0", "word-wrap": "^1.2.3" }, - "husky": { - "hooks": { - "pre-commit": "npm test" - } + "lint-staged": { + "*.{js,css,md}": "prettier --write" } } diff --git a/readme.md b/readme.md index 3ef407248312e..ae18c9e6002c6 100644 --- a/readme.md +++ b/readme.md @@ -7,6 +7,9 @@ Tests Passing + + GitHub Contributors + @@ -59,42 +62,44 @@ Türkçe

-

Love the project? Please consider donating to help it improve! +

Love the project? Please consider donating to help it improve!

-

-Give india logo + Give india logo -Are you considering supporting the project by donating? Please DON'T!! +Are you considering supporting the project by donating? Please DO NOT!! -Instead, Help India fight the 2nd deadly wave of COVID-19. +Instead, Help India fight the second deadly wave of COVID-19. Thousands of people are dying in India because of a lack of Oxygen & also COVID-related infrastructure. -Visit [https://indiafightscorona.giveindia.org](https://indiafightscorona.giveindia.org) and make a small donation to help us fight COVID and overcome this crisis. -A small donation goes a long way. :heart: -

+Visit and make a small donation to help us fight COVID and overcome this crisis. A small donation goes a long way. :heart: +

# Features -- [GitHub Stats Card](#github-stats-card) -- [GitHub Extra Pins](#github-extra-pins) -- [Top Languages Card](#top-languages-card) -- [Wakatime Week Stats](#wakatime-week-stats) -- [Themes](#themes) -- [Customization](#customization) - - [Common Options](#common-options) - - [Stats Card Exclusive Options](#stats-card-exclusive-options) - - [Repo Card Exclusive Options](#repo-card-exclusive-options) - - [Language Card Exclusive Options](#language-card-exclusive-options) - - [Wakatime Card Exclusive Option](#wakatime-card-exclusive-options) -- [Deploy Yourself](#deploy-on-your-own-vercel-instance) +- [GitHub Stats Card](#github-stats-card) +- [GitHub Extra Pins](#github-extra-pins) +- [Top Languages Card](#top-languages-card) +- [Wakatime Week Stats](#wakatime-week-stats) +- [Themes](#themes) + - [Responsive Card Theme](#responsive-card-theme) +- [Customization](#customization) + - [Common Options](#common-options) + - [Stats Card Exclusive Options](#stats-card-exclusive-options) + - [Repo Card Exclusive Options](#repo-card-exclusive-options) + - [Language Card Exclusive Options](#language-card-exclusive-options) + - [Wakatime Card Exclusive Option](#wakatime-card-exclusive-options) +- [Deploy Yourself](#deploy-on-your-own) + - [On Vercel](#on-vercel) + - [On other platforms](#on-other-platforms) + - [Keep your fork up to date](#keep-your-fork-up-to-date) # GitHub Stats Card -Copy-paste this into your markdown content, and that's it. Simple! +Copy-paste this into your markdown content, and that is it. Simple! Change the `?username=` value to your GitHub username. @@ -102,13 +107,12 @@ Change the `?username=` value to your GitHub username. [![Anurag's GitHub stats](https://github-readme-stats.vercel.app/api?username=anuraghazra)](https://github.com/anuraghazra/github-readme-stats) ``` -_Note: Available ranks are S+ (top 1%), S (top 25%), A++ (top 45%), A+ (top 60%), and B+ (everyone). -The values are calculated by using the [cumulative distribution function](https://en.wikipedia.org/wiki/Cumulative_distribution_function) using commits, contributions, issues, stars, pull requests, followers, and owned repositories. -The implementation can be investigated at [src/calculateRank.js](./src/calculateRank.js)._ +> **Note** +> Available ranks are S+ (top 1%), S (top 25%), A++ (top 45%), A+ (top 60%), and B+ (everyone). The values are calculated by using the [cumulative distribution function](https://en.wikipedia.org/wiki/Cumulative_distribution_function) using commits, contributions, issues, stars, pull requests, followers, and owned repositories. The implementation can be investigated at [src/calculateRank.js](./src/calculateRank.js). ### Hiding individual stats -To hide any specific stats, you can pass a query parameter `&hide=` with comma-separated values. +You can pass a query parameter `&hide=` to hide any specific stats with comma-separated values. > Options: `&hide=stars,commits,prs,issues,contribs` @@ -120,7 +124,8 @@ To hide any specific stats, you can pass a query parameter `&hide=` with comma-s You can add the count of all your private contributions to the total commits count by using the query parameter `&count_private=true`. -_Note: If you are deploying this project yourself, the private contributions will be counted by default. Otherwise, you need to choose to share your private contribution counts._ +> **Note** +> If you are deploying this project yourself, the private contributions will be counted by default. If you are using the public Vercel instance, you need to choose to [share your private contributions](https://docs.github.com/en/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/showing-your-private-contributions-and-achievements-on-your-profile). > Options: `&count_private=true` @@ -130,7 +135,7 @@ _Note: If you are deploying this project yourself, the private contributions wil ### Showing icons -To enable icons, you can pass `show_icons=true` in the query param, like so: +To enable icons, you can pass `&show_icons=true` in the query param, like so: ```md ![Anurag's GitHub stats](https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true) @@ -140,100 +145,196 @@ To enable icons, you can pass `show_icons=true` in the query param, like so: With inbuilt themes, you can customize the look of the card without doing any [manual customization](#customization). -Use `&theme=THEME_NAME` parameter like so :- +Use `&theme=THEME_NAME` parameter like so : ```md ![Anurag's GitHub stats](https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true&theme=radical) ``` -#### All inbuilt themes:- +#### All inbuilt themes -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`). GitHub Readme Stats Themes You can look at a preview for [all available themes](./themes/README.md) or checkout the [theme config file](./themes/index.js) & **you can also contribute new themes** if you like :D -### Customization +#### Responsive Card Theme -You can customize the appearance of your `Stats Card` or `Repo Card` however you wish with URL params. +[![Anurag's GitHub stats-Dark](https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true&theme=dark#gh-dark-mode-only)](https://github.com/anuraghazra/github-readme-stats#gh-dark-mode-only) +[![Anurag's GitHub stats-Light](https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true&theme=default#gh-light-mode-only)](https://github.com/anuraghazra/github-readme-stats#gh-light-mode-only) -#### Common Options: +Since GitHub will re-upload the cards and serve them from their [CDN](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/about-anonymized-urls), we can not infer the browser/GitHub theme on the server side. There are, however, four methods you can use to create dynamics themes on the client side. -- `title_color` - Card's title color _(hex color)_ -- `text_color` - Body text color _(hex color)_ -- `icon_color` - Icons color if available _(hex color)_ -- `border_color` - Card's border color _(hex color)_. (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_ -- `hide_border` - Hides the card's border _(boolean)_ -- `theme` - name of the theme, choose from [all available themes](./themes/README.md) -- `cache_seconds` - set the cache header manually _(min: 7200, max: 86400)_ -- `locale` - set the language in the card _(e.g. cn, de, es, etc.)_ -- `border_radius` - Corner rounding on the card +##### Use the transparent theme -> Note: The minimum of cache_seconds is currently 4 hours as a temporary fix for PATs exhaustion. +We have included a `transparent` theme that has a transparent background. This theme is optimized to look good on GitHub's dark and light default themes. You can enable this theme using the `&theme=transparent` parameter like so: -##### Gradient in bg_color +```md +![Anurag's GitHub stats](https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true&theme=transparent) +``` + +
+:eyes: Show example -You can provide multiple comma-separated values in the bg_color option to render a gradient, with the following format: +![Anurag's GitHub stats](https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true&theme=transparent) +
+ +##### Add transparent alpha channel to a themes bg_color + +You can use the `bg_color` parameter to make any of [the available themes](./themes/README.md) transparent. This is done by setting the `bg_color` to a color with a transparent alpha channel (i.e. `bg_color=00000000`): + +```md +![Anurag's GitHub stats](https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true&bg_color=00000000) ``` -&bg_color=DEG,COLOR1,COLOR2,COLOR3...COLOR10 + +
+:eyes: Show example + +![Anurag's GitHub stats](https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true&bg_color=00000000) + +
+ +##### Use GitHub's theme context tag + +You can use [GitHub's theme context](https://github.blog/changelog/2021-11-24-specify-theme-context-for-images-in-markdown/) tags to switch the theme based on the user GitHub theme automatically. This is done by appending `#gh-dark-mode-only` or `#gh-light-mode-only` to the end of an image URL. This tag will define whether the image specified in the markdown is only shown to viewers using a light or a dark GitHub theme: + +```md +[![Anurag's GitHub stats-Dark](https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true&theme=dark#gh-dark-mode-only)](https://github.com/anuraghazra/github-readme-stats#gh-dark-mode-only) +[![Anurag's GitHub stats-Light](https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true&theme=default#gh-light-mode-only)](https://github.com/anuraghazra/github-readme-stats#gh-light-mode-only) ``` -> Note on cache: Repo cards have a default cache of 4 hours (14400 seconds) if the fork count & star count is less than 1k, otherwise, it's 2 hours (7200 seconds). Also, note that the cache is clamped to a minimum of 2 hours and a maximum of 24 hours. +
+:eyes: Show example + +[![Anurag's GitHub stats-Dark](https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true&theme=dark#gh-dark-mode-only)](https://github.com/anuraghazra/github-readme-stats#gh-dark-mode-only) +[![Anurag's GitHub stats-Light](https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true&theme=default#gh-light-mode-only)](https://github.com/anuraghazra/github-readme-stats#gh-light-mode-only) -#### Stats Card Exclusive Options: +
-- `hide` - Hides the [specified items](#hiding-individual-stats) from stats _(Comma-separated values)_ -- `hide_title` - _(boolean)_ -- `card_width` - Set the card's width manually _(number)_ -- `hide_rank` - _(boolean)_ hides the rank and automatically resizes the card width -- `show_icons` - _(boolean)_ -- `include_all_commits` - Count total commits instead of just the current year commits _(boolean)_ -- `count_private` - Count private commits _(boolean)_ -- `line_height` - Sets the line-height between text _(number)_ -- `exclude_repo` - Exclude stars from specified repositories _(Comma-separated values)_ -- `custom_title` - Sets a custom title for the card -- `text_bold` - Use bold text _(boolean)_ -- `disable_animations` - Disables all animations in the card _(boolean)_ +##### Use GitHub's new media feature -#### Repo Card Exclusive Options: +You can use [GitHub's new media feature](https://github.blog/changelog/2022-05-19-specify-theme-context-for-images-in-markdown-beta/) in HTML to specify whether to display images for light or dark themes. This is done using the HTML `` element in combination with the `prefers-color-scheme` media feature. -- `show_owner` - Show the repo's owner name _(boolean)_ +```html + + + + + +``` + +
+:eyes: Show example + + + + + + + +
+ +### Customization -#### Language Card Exclusive Options: +You can customize the appearance of your `Stats Card` or `Repo Card` however you wish with URL parameters. -- `hide` - Hide the languages specified from the card _(Comma-separated values)_ -- `hide_title` - _(boolean)_ -- `layout` - Switch between two available layouts `default` & `compact` -- `card_width` - Set the card's width manually _(number)_ -- `langs_count` - Show more languages on the card, between 1-10, defaults to 5 _(number)_ -- `exclude_repo` - Exclude specified repositories _(Comma-separated values)_ -- `custom_title` - Sets a custom title for the card +#### Common Options -> :warning: **Important:** -> Language names should be uri-escaped, as specified in [Percent Encoding](https://en.wikipedia.org/wiki/Percent-encoding) +- `title_color` - Card's title color _(hex color)_. Default: `2f80ed`. +- `text_color` - Body text color _(hex color)_. Default: `434d58`. +- `icon_color` - Icons color if available _(hex color)_. Default: `4c71f2`. +- `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`. +- `border_radius` - Corner rounding on the card. Default: `4.5`. + +> **Warning** +> We use caching to decrease the load on our servers (see ). Our cards have a default cache of 4 hours (14400 seconds). Also, note that the cache is clamped to a minimum of 4 hours and a maximum of 24 hours. + +##### Gradient in bg_color + +You can provide multiple comma-separated values in the bg_color option to render a gradient with the following format: + + &bg_color=DEG,COLOR1,COLOR2,COLOR3...COLOR10 + +#### Stats Card Exclusive Options + +- `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.)`. +- `hide_rank` - _(boolean)_ hides the rank and automatically resizes the card width. Default: `false`. +- `rank_icon` - Shows alternative rank icon (i.e. `github` 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`. +- `count_private` - Count private 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)`. +- `custom_title` - Sets a custom title for the card. Default: ` GitHub Stats`. +- `text_bold` - Use 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`. + +> **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`. + +#### Language Card Exclusive Options + +- `hide` - Hide the languages specified from the card _(Comma-separated values)_. Default: `[] (blank array)`. +- `hide_title` - _(boolean)_. Default: `false`. +- `layout` - Switch between two available layouts `default` & `compact`. Default: `default`. +- `card_width` - Set the card's width manually _(number)_. Default `300`. +- `langs_count` - Show more languages on the card, between 1-10 _(number)_. Default `5`. +- `exclude_repo` - Exclude 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`. +- `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. + +> **Warning** +> Language names should be URI-escaped, as specified in [Percent Encoding](https://en.wikipedia.org/wiki/Percent-encoding) > (i.e: `c++` should become `c%2B%2B`, `jupyter notebook` should become `jupyter%20notebook`, etc.) You can use > [urlencoder.org](https://www.urlencoder.org/) to help you do this automatically. -#### Wakatime Card Exclusive Options: +#### Wakatime Card Exclusive Options -- `hide` - Hide the languages specified from the card _(Comma-separated values)_ -- `hide_title` - _(boolean)_ -- `line_height` - Sets the line-height between text _(number)_ -- `hide_progress` - Hides the progress bar and percentage _(boolean)_ -- `custom_title` - Sets a custom title for the card -- `layout` - Switch between two available layouts `default` & `compact` -- `langs_count` - Limit the number of languages on the card, defaults to all reported languages -- `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) -- `range` – Request a range different from your WakaTime default, e.g. `last_7_days`. See [WakaTime API docs](https://wakatime.com/developers#stats) for a list of available options. +- `hide` - Hide 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`. +- `range` – Request a range different from your WakaTime default, e.g. `last_7_days`. See [WakaTime API docs](https://wakatime.com/developers#stats) for a list of available options. _(YYYY-MM, last_7_days, last_30_days, last_6_months, last_year, or all_time)_. Default `all_time`. ---- +* * * # GitHub Extra Pins -GitHub extra pins allow you to pin more than 6 repositories in your profile using a GitHub readme profile. +GitHub extra pins allow you to pin more than six repositories in your profile using a GitHub readme profile. Yay! You are no longer limited to 6 pinned repositories. @@ -259,7 +360,8 @@ Use [show_owner](#customization) variable to include the repo's owner username The top languages card shows a GitHub user's most frequently used top language. -_NOTE: Top Languages does not indicate my skill level or anything like that; it's a GitHub metric to determine which languages have the most code on GitHub. It's a new feature of github-readme-stats._ +> **Note** +> Top Languages does not indicate the user's skill level or anything like that; it's a GitHub metric to determine which languages have the most code on GitHub. It is a new feature of github-readme-stats. ### Usage @@ -271,9 +373,27 @@ Endpoint: `api/top-langs?username=anuraghazra` [![Top Langs](https://github-readme-stats.vercel.app/api/top-langs/?username=anuraghazra)](https://github.com/anuraghazra/github-readme-stats) ``` +### Language stats algorithm + +We use the following algorithm to calculate the languages percentages on the language card: + +```js +ranking_index = (byte_count ^ size_weight) * (repo_count ^ count_weight) +``` + +By default, only the byte count is used for determining the languages percentages shown on the language card (i.e. `size_weight=1` and `count_weight=0`). You can, however, use the `&size_weight=` and `&count_weight=` options to weight the language usage calculation. The values must be positive real numbers. [More details about the algorithm can be found here](https://github.com/anuraghazra/github-readme-stats/issues/1600#issuecomment-1046056305). + +- `&size_weight=1&count_weight=0` - _(default)_ Orders by byte count. +- `&size_weight=0.5&count_weight=0.5` - _(recommended)_ Uses both byte and repo count for ranking +- `&size_weight=0&count_weight=1` - Orders by repo count + +```md +[![Top Langs](https://github-readme-stats.vercel.app/api/top-langs/?username=anuraghazra&size_weight=0.5&count_weight=0.5)](https://github.com/anuraghazra/github-readme-stats) +``` + ### Exclude individual repositories -You can use `&exclude_repo=repo1,repo2` parameter to exclude individual repositories. +You can use the `&exclude_repo=repo1,repo2` parameter to exclude individual repositories. ```md [![Top Langs](https://github-readme-stats.vercel.app/api/top-langs/?username=anuraghazra&exclude_repo=github-readme-stats,anuraghazra.github.io)](https://github.com/anuraghazra/github-readme-stats) @@ -303,14 +423,26 @@ You can use the `&layout=compact` option to change the card design. [![Top Langs](https://github-readme-stats.vercel.app/api/top-langs/?username=anuraghazra&layout=compact)](https://github.com/anuraghazra/github-readme-stats) ``` +### Hide Progress Bars + +You can use the `&hide_progress=true` option to hide the percentages and the progress bars (layout will be automatically set to `compact`). + +```md +[![Top Langs](https://github-readme-stats.vercel.app/api/top-langs/?username=anuraghazra&hide_progress=true)](https://github.com/anuraghazra/github-readme-stats) +``` + ### Demo [![Top Langs](https://github-readme-stats.vercel.app/api/top-langs/?username=anuraghazra)](https://github.com/anuraghazra/github-readme-stats) -- Compact layout +- Compact layout [![Top Langs](https://github-readme-stats.vercel.app/api/top-langs/?username=anuraghazra&layout=compact)](https://github.com/anuraghazra/github-readme-stats) +- Hidden progress bars + +[![Top Langs](https://github-readme-stats.vercel.app/api/top-langs/?username=anuraghazra&hide_progress=true)](https://github.com/anuraghazra/github-readme-stats) + # Wakatime Week Stats Change the `?username=` value to your [Wakatime](https://wakatime.com) username. @@ -319,7 +451,8 @@ Change the `?username=` value to your [Wakatime](https://wakatime.com) username. [![willianrod's wakatime stats](https://github-readme-stats.vercel.app/api/wakatime?username=willianrod)](https://github.com/anuraghazra/github-readme-stats) ``` -> Note: Please be aware that we currently only show data from Wakatime profiles that are public. +> **Note**: +> Please be aware that we currently only show data from Wakatime profiles that are public. ### Demo @@ -327,69 +460,73 @@ Change the `?username=` value to your [Wakatime](https://wakatime.com) username. [![willianrod's wakatime stats](https://github-readme-stats.vercel.app/api/wakatime?username=willianrod&hide_progress=true)](https://github.com/anuraghazra/github-readme-stats) -- Compact layout +- Compact layout [![willianrod's wakatime stats](https://github-readme-stats.vercel.app/api/wakatime?username=willianrod&layout=compact)](https://github.com/anuraghazra/github-readme-stats) ---- +* * * ### All Demos -- Default +- Default ![Anurag's GitHub stats](https://github-readme-stats.vercel.app/api?username=anuraghazra) -- Hiding specific stats +- Hiding specific stats ![Anurag's GitHub stats](https://github-readme-stats.vercel.app/api?username=anuraghazra&hide=contribs,issues) -- Showing icons +- Showing icons ![Anurag's GitHub stats](https://github-readme-stats.vercel.app/api?username=anuraghazra&hide=issues&show_icons=true) -- Customize Border Color +- Shows Github logo instead rank level + +![Anurag's GitHub stats](https://github-readme-stats.vercel.app/api?username=anuraghazra&rank_icon=github) + +- Customize Border Color ![Anurag's GitHub stats](https://github-readme-stats.vercel.app/api?username=anuraghazra&border_color=2e4058) -- Include All Commits +- Include All Commits ![Anurag's GitHub stats](https://github-readme-stats.vercel.app/api?username=anuraghazra&include_all_commits=true) -- Themes +- Themes Choose from any of the [default themes](#themes) ![Anurag's GitHub stats](https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true&theme=radical) -- Gradient +- Gradient ![Anurag's GitHub stats](https://github-readme-stats.vercel.app/api?username=anuraghazra&bg_color=30,e96443,904e95&title_color=fff&text_color=fff) -- Customizing stats card +- Customizing stats card ![Anurag's GitHub stats](https://github-readme-stats.vercel.app/api/?username=anuraghazra&show_icons=true&title_color=fff&icon_color=79ff97&text_color=9f9f9f&bg_color=151515) -- Setting card locale +- Setting card locale ![Anurag's GitHub stats](https://github-readme-stats.vercel.app/api/?username=anuraghazra&locale=es) -- Customizing repo card +- Customizing repo card ![Customized Card](https://github-readme-stats.vercel.app/api/pin?username=anuraghazra&repo=github-readme-stats&title_color=fff&icon_color=f9f9f9&text_color=9f9f9f&bg_color=151515) -- Top languages +- Top languages [![Top Langs](https://github-readme-stats.vercel.app/api/top-langs/?username=anuraghazra)](https://github.com/anuraghazra/github-readme-stats) -- Wakatime card +- WakaTime card [![willianrod's wakatime stats](https://github-readme-stats.vercel.app/api/wakatime?username=willianrod)](https://github.com/anuraghazra/github-readme-stats) ---- +* * * ### Quick Tip (Align The Repo Cards) -You usually won't be able to layout the images side by side. To do that you can use this approach: +By default, GitHub does not lay out the cards side by side. To do that, you can use this approach: ```html @@ -400,58 +537,83 @@ You usually won't be able to layout the images side by side. To do that you can ``` -## Deploy on your own Vercel instance +## Deploy on your own + +### On Vercel -#### [Check Out Step By Step Video Tutorial By @codeSTACKr](https://youtu.be/n6d4KHSKqGk?t=107) +#### :film_projector: [Check Out Step By Step Video Tutorial By @codeSTACKr](https://youtu.be/n6d4KHSKqGk?t=107) -Since the GitHub API only allows 5k requests per hour, my `https://github-readme-stats.vercel.app/api` could possibly hit the rate limiter. If you host it on your own Vercel server, then you don't have to worry about anything. Click on the deploy button to get started! +> **Warning** +> If you are on the [hobby (i.e. free)](https://vercel.com/pricing) Vercel plan, please make sure you change the `maxDuration` parameter in the [vercel.json](https://github.com/anuraghazra/github-readme-stats/blob/master/vercel.json) file from `30` to `10` (see [#1416](https://github.com/anuraghazra/github-readme-stats/issues/1416#issuecomment-950275476) for more information). -NOTE: Since [#58](https://github.com/anuraghazra/github-readme-stats/pull/58) we should be able to handle more than 5k requests and have no issues with downtime :D +Since the GitHub API only allows 5k requests per hour, my `https://github-readme-stats.vercel.app/api` could possibly hit the rate limiter. If you host it on your own Vercel server, then you do not have to worry about anything. Click on the deploy button to get started! + +> **Note** +> Since [#58](https://github.com/anuraghazra/github-readme-stats/pull/58), we should be able to handle more than 5k requests and have fewer issues with downtime :grin:. [![Deploy to Vercel](https://vercel.com/button)](https://vercel.com/import/project?template=https://github.com/anuraghazra/github-readme-stats)
- Guide on setting up Vercel 🔨 - -1. Go to [vercel.com](https://vercel.com/) -1. Click on `Log in` - ![](https://files.catbox.moe/tct1wg.png) -1. Sign in with GitHub by pressing `Continue with GitHub` - ![](https://files.catbox.moe/btd78j.jpeg) -1. Sign in to GitHub and allow access to all repositories, if prompted -1. Fork this repo -1. After forking the repo, open the [`vercel.json`](https://github.com/anuraghazra/github-readme-stats/blob/master/vercel.json#L5) file and change the `maxDuration` field to `10` -1. Go back to your [Vercel dashboard](https://vercel.com/dashboard) -1. Select `Import Project` - ![](https://files.catbox.moe/qckos0.png) -1. Select `Import Git Repository`. Select root and keep everything as is. - ![](https://files.catbox.moe/pqub9q.png) -1. Create a personal access token (PAT) [here](https://github.com/settings/tokens/new) and enable the `repo` permissions (this allows access to see private repo stats) -1. Add the PAT as an environment variable named `PAT_1` (as shown). - ![](https://files.catbox.moe/0ez4g7.png) -1. Click deploy, and you're good to go. See your domains to use the API! + :hammer_and_wrench: Step-by-step guide on setting up your own Vercel instance + +1. Go to [vercel.com](https://vercel.com/). +2. Click on `Log in`. + ![](https://files.catbox.moe/pcxk33.png) +3. Sign in with GitHub by pressing `Continue with GitHub`. + ![](https://files.catbox.moe/b9oxey.png) +4. Sign in to GitHub and allow access to all repositories if prompted. +5. Fork this repo. +6. After forking the repo, open the [`vercel.json`](https://github.com/anuraghazra/github-readme-stats/blob/master/vercel.json#L5) file and change the `maxDuration` field to `10`. +7. Go back to your [Vercel dashboard](https://vercel.com/dashboard). +8. To import a project, click the `Add New...` button and select the `Project` option. + ![](https://files.catbox.moe/3n76fh.png) +9. Click the `Continue with GitHub` button, search for the required Git Repository and import it by clicking the `Import` button. Alternatively, you can import a Third-Party Git Repository using the `Import Third-Party Git Repository ->` link at the bottom of the page. + ![](https://files.catbox.moe/mg5p04.png) +10. Create a personal access token (PAT) [here](https://github.com/settings/tokens/new) and enable the `repo` permissions (this allows access to see private repo stats). +11. Add the PAT as an environment variable named `PAT_1` (as shown). + ![](https://files.catbox.moe/0yclio.png) +12. Click deploy, and you're good to go. See your domains to use the API!
+### On other platforms + +> **Warning** +> This way of using GRS is not officially supported and was added to cater to some particular use cases where Vercel could not be used (e.g. #2341). The support for this method, therefore, is limited. + +
+:hammer_and_wrench: Step-by-step guide for deploying on other platforms + +1. Fork or clone this repo as per your needs +2. Add `express` to the dependencies section of `package.json` + +3. Run `npm i` if needed (initial setup) +4. Run `node express.js` to start the server, or set the entry point to `express.js` in `package.json` if you're deploying on a managed service + +5. You're done 🎉 +
+ +### Keep your fork up to date + +You can keep your fork, and thus your private Vercel instance up to date with the upstream using GitHubs' [Sync Fork button](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/syncing-a-fork). You can also use the [pull](https://github.com/wei/pull) package created by [@wei](https://github.com/wei) to automate this process. + ## :sparkling_heart: Support the project -I open-source almost everything I can, and I try to reply to everyone needing help using these projects. Obviously, +I open-source almost everything I can and try to reply to everyone needing help using these projects. Obviously, this takes time. You can use this service for free. -However, if you are using this project and are happy with it or just want to encourage me to continue creating stuff, there are a few ways you can do it:- +However, if you are using this project and are happy with it or just want to encourage me to continue creating stuff, there are a few ways you can do it: -- Giving proper credit when you use github-readme-stats on your readme, linking back to it :D -- Starring and sharing the project :rocket: -- [![paypal.me/anuraghazra](https://ionicabizau.github.io/badges/paypal.svg)](https://www.paypal.me/anuraghazra) - You can make one-time donations via PayPal. I'll probably buy a ~~coffee~~ tea. :tea: +- Giving proper credit when you use github-readme-stats on your readme, linking back to it :D +- Starring and sharing the project :rocket: +- [![paypal.me/anuraghazra](https://ionicabizau.github.io/badges/paypal.svg)](https://www.paypal.me/anuraghazra) - You can make one-time donations via PayPal. I'll probably buy a ~~coffee~~ tea. :tea: Thanks! :heart: ---- +* * * [![https://vercel.com?utm_source=github_readme_stats_team&utm_campaign=oss](./powered-by-vercel.svg)](https://vercel.com?utm_source=github_readme_stats_team&utm_campaign=oss) - -Contributions are welcome! <3 +Contributions are welcome! <3 Made with :heart: and JavaScript. - diff --git a/scripts/close-stale-theme-prs.js b/scripts/close-stale-theme-prs.js new file mode 100644 index 0000000000000..7db66f9775adb --- /dev/null +++ b/scripts/close-stale-theme-prs.js @@ -0,0 +1,173 @@ +/** + * @file Script that can be used to close stale theme PRs that have a `invalid` label. + */ +import * as dotenv from "dotenv"; +dotenv.config(); + +import { debug, setFailed } from "@actions/core"; +import github from "@actions/github"; +import { RequestError } from "@octokit/request-error"; +import { getGithubToken, getRepoInfo } from "./helpers.js"; + +const CLOSING_COMMENT = ` + \rThis theme PR has been automatically closed due to inactivity. Please reopen it if you want to continue working on it.\ + \rThank you for your contributions. +`; +const REVIEWER = "github-actions[bot]"; + +/** + * Retrieve the review user. + * @returns {string} review user. + */ +const getReviewer = () => { + return process.env.REVIEWER ? process.env.REVIEWER : REVIEWER; +}; + +/** + * 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. + */ +export const fetchOpenPRs = async (octokit, user, repo, reviewer) => { + const openPRs = []; + let hasNextPage = true; + let endCursor; + while (hasNextPage) { + try { + const { repository } = await octokit.graphql( + ` + { + repository(owner: "${user}", name: "${repo}") { + open_prs: pullRequests(${ + endCursor ? `after: "${endCursor}", ` : "" + } + first: 100, states: OPEN, orderBy: {field: CREATED_AT, direction: DESC}) { + nodes { + number + commits(last:1){ + nodes{ + commit{ + pushedDate + } + } + } + labels(first: 100, orderBy:{field: CREATED_AT, direction: DESC}) { + nodes { + name + } + } + reviews(first: 100, states: CHANGES_REQUESTED, author: "${reviewer}") { + nodes { + submittedAt + } + } + } + pageInfo { + endCursor + hasNextPage + } + } + } + } + `, + ); + openPRs.push(...repository.open_prs.nodes); + hasNextPage = repository.open_prs.pageInfo.hasNextPage; + endCursor = repository.open_prs.pageInfo.endCursor; + } catch (error) { + if (error instanceof RequestError) { + setFailed(`Could not retrieve top PRs using GraphQl: ${error.message}`); + } + throw error; + } + } + return openPRs; +}; + +/** + * Retrieve pull requests that have a given label. + * @param pull The pull requests to check. + * @param label The label to check for. + */ +export const pullsWithLabel = (pulls, label) => { + return pulls.filter((pr) => { + return pr.labels.nodes.some((lab) => lab.name === 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. + */ +const isStale = (pullRequest, staleDays) => { + const lastCommitDate = new Date( + pullRequest.commits.nodes[0].commit.pushedDate, + ); + if (pullRequest.reviews.nodes[0]) { + const lastReviewDate = new Date( + pullRequest.reviews.nodes.sort((a, b) => (a < b ? 1 : -1))[0].submittedAt, + ); + const lastUpdateDate = + lastCommitDate >= lastReviewDate ? lastCommitDate : lastReviewDate; + const now = new Date(); + return (now - lastUpdateDate) / (1000 * 60 * 60 * 24) >= staleDays; + } else { + return false; + } +}; + +/** + * Main function. + */ +const run = async () => { + try { + // Create octokit client. + const dryRun = process.env.DRY_RUN === "true" || false; + const staleDays = process.env.STALE_DAYS || 20; + debug("Creating octokit client..."); + const octokit = github.getOctokit(getGithubToken()); + const { owner, repo } = getRepoInfo(github.context); + const reviewer = getReviewer(); + + // Retrieve all theme pull requests. + debug("Retrieving all theme pull requests..."); + const prs = await fetchOpenPRs(octokit, owner, repo, reviewer); + const themePRs = pullsWithLabel(prs, "themes"); + const invalidThemePRs = pullsWithLabel(themePRs, "invalid"); + debug("Retrieving stale theme PRs..."); + const staleThemePRs = invalidThemePRs.filter((pr) => + isStale(pr, staleDays), + ); + const staleThemePRsNumbers = staleThemePRs.map((pr) => pr.number); + debug(`Found ${staleThemePRs.length} stale theme PRs`); + + // Loop through all stale invalid theme pull requests and close them. + for (const prNumber of staleThemePRsNumbers) { + debug(`Closing #${prNumber} because it is stale...`); + if (!dryRun) { + await octokit.issues.createComment({ + owner, + repo, + issue_number: prNumber, + body: CLOSING_COMMENT, + }); + await octokit.pulls.update({ + owner, + repo, + pull_number: prNumber, + state: "closed", + }); + } else { + debug("Dry run enabled, skipping..."); + } + } + } catch (error) { + setFailed(error.message); + } +}; + +run(); diff --git a/scripts/helpers.js b/scripts/helpers.js new file mode 100644 index 0000000000000..6746adc92693c --- /dev/null +++ b/scripts/helpers.js @@ -0,0 +1,41 @@ +/** + * @file Contains helper functions used in the scripts. + */ + +import { getInput } from "@actions/core"; + +const OWNER = "anuraghazra"; +const REPO = "github-readme-stats"; + +/** + * Retrieve information about the repository that ran the action. + * + * @param {Object} context Action context. + * @returns {Object} Repository information. + */ +export const getRepoInfo = (ctx) => { + try { + return { + owner: ctx.repo.owner, + repo: ctx.repo.repo, + }; + } catch (error) { + return { + owner: OWNER, + repo: REPO, + }; + } +}; + +/** + * Retrieve github token and throw error if it is not found. + * + * @returns {string} GitHub token. + */ +export const getGithubToken = () => { + const token = getInput("github_token") || process.env.GITHUB_TOKEN; + if (!token) { + throw Error("Could not find github token"); + } + return token; +}; diff --git a/scripts/preview-theme.js b/scripts/preview-theme.js index 33ee96bc2f01a..57b792a369c95 100644 --- a/scripts/preview-theme.js +++ b/scripts/preview-theme.js @@ -1,27 +1,97 @@ -import core from "@actions/core"; +/** + * @file This script is used to preview the theme on theme PRs. + */ +import * as dotenv from "dotenv"; +dotenv.config(); + +import { debug, setFailed } from "@actions/core"; import github from "@actions/github"; import ColorContrastChecker from "color-contrast-checker"; -import * as dotenv from "dotenv"; +import { info } from "console"; import Hjson from "hjson"; import snakeCase from "lodash.snakecase"; import parse from "parse-diff"; +import { inspect } from "util"; +import { isValidHexColor } from "../src/common/utils.js"; +import { themes } from "../themes/index.js"; +import { getGithubToken, getRepoInfo } from "./helpers.js"; -dotenv.config(); +const COMMENTER = "github-actions[bot]"; -const OWNER = "anuraghazra"; -const REPO = "github-readme-stats"; const COMMENT_TITLE = "Automated Theme Preview"; +const THEME_PR_FAIL_TEXT = ":x: Theme PR does not adhere to our guidelines."; +const THEME_PR_SUCCESS_TEXT = + ":heavy_check_mark: Theme PR does adhere to our guidelines."; +const FAIL_TEXT = ` + \rUnfortunately, your theme PR contains an error or does not adhere to our [theme guidelines](https://github.com/anuraghazra/github-readme-stats/blob/master/CONTRIBUTING.md#themes-contribution). Please fix the issues below, and we will review your\ + \r PR again. This pull request will **automatically close in 20 days** if no changes are made. After this time, you must re-open the PR for it to be reviewed. +`; +const THEME_CONTRIB_GUIDELINES = ` + \rHi, thanks for the theme contribution. Please read our theme [contribution guidelines](https://github.com/anuraghazra/github-readme-stats/blob/master/CONTRIBUTING.md#themes-contribution). + \rWe are currently only accepting color combinations from any VSCode theme or themes with good color combinations to minimize bloating the themes collection. + + \r> Also, note that if this theme is exclusively for your personal use, then instead of adding it to our theme collection, you can use card [customization options](https://github.com/anuraghazra/github-readme-stats#customization). +`; +const COLOR_PROPS = { + title_color: 6, + icon_color: 6, + text_color: 6, + bg_color: 8, + border_color: 6, +}; +const ACCEPTED_COLOR_PROPS = Object.keys(COLOR_PROPS); +const REQUIRED_COLOR_PROPS = ACCEPTED_COLOR_PROPS.slice(0, 4); +const INVALID_REVIEW_COMMENT = (commentUrl) => + `Some themes are invalid. See the [Automated Theme Preview](${commentUrl}) comment above for more information.`; +var OCTOKIT; +var OWNER; +var REPO; +var PULL_REQUEST_ID; + +/** + * Incorrect JSON format error. + * @extends Error + * @param {string} message Error message. + * @returns {Error} IncorrectJsonFormatError. + */ +class IncorrectJsonFormatError extends Error { + constructor(message) { + super(message); + this.name = "IncorrectJsonFormatError"; + } +} + +/** + * Retrieve PR number from the event payload. + * + * @returns {number} PR number. + */ +const getPrNumber = () => { + if (process.env.MOCK_PR_NUMBER) return process.env.MOCK_PR_NUMBER; // For testing purposes. -function getPrNumber() { const pullRequest = github.context.payload.pull_request; if (!pullRequest) { - return undefined; + throw Error("Could not get pull request number from context"); } - return pullRequest.number; -} - -function findCommentPredicate(inputs, comment) { +}; + +/** + * Retrieve the commenting user. + * @returns {string} Commenting user. + */ +const getCommenter = () => { + return process.env.COMMENTER ? process.env.COMMENTER : COMMENTER; +}; + +/** + * Returns whether the comment is a preview comment. + * + * @param {Object} inputs Action inputs. + * @param {Object} comment Comment object. + * @returns {boolean} Whether the comment is a preview comment. + */ +const isPreviewComment = (inputs, comment) => { return ( (inputs.commentAuthor && comment.user ? comment.user.login === inputs.commentAuthor @@ -30,160 +100,555 @@ function findCommentPredicate(inputs, comment) { ? comment.body.includes(inputs.bodyIncludes) : true) ); -} - -async function findComment(octokit, issueNumber) { +}; + +/** + * Find the preview theme comment. + * + * @param {Object} octokit Octokit instance. + * @param {number} issueNumber Issue number. + * @param {string} repo Repository name. + * @param {string} owner Owner of the repository. + * @returns {Object} The GitHub comment object. + */ +const findComment = async (octokit, issueNumber, owner, repo, commenter) => { const parameters = { - owner: OWNER, - repo: REPO, + owner, + repo, issue_number: issueNumber, }; const inputs = { - commentAuthor: OWNER, + commentAuthor: commenter, bodyIncludes: COMMENT_TITLE, }; + // Search each page for the comment for await (const { data: comments } of octokit.paginate.iterator( octokit.rest.issues.listComments, parameters, )) { - // Search each page for the comment const comment = comments.find((comment) => - findCommentPredicate(inputs, comment), + isPreviewComment(inputs, comment), ); - if (comment) return comment; + if (comment) { + debug(`Found theme preview comment: ${inspect(comment)}`); + return comment; + } else { + debug(`No theme preview comment found.`); + } } -} - -async function upsertComment(octokit, props) { - if (props.comment_id !== undefined) { - await octokit.issues.updateComment(props); +}; + +/** + * Create or update the preview comment. + * + * @param {Object} octokit Octokit instance. + * @param {number} issueNumber Issue number. + * @param {Object} repo Repository name. + * @param {Object} owner Owner of the repository. + * @param {number} commentId Comment ID. + * @param {string} body Comment body. + * @return {string} The comment URL. + */ +const upsertComment = async ( + octokit, + issueNumber, + repo, + owner, + commentId, + body, +) => { + let resp; + if (commentId !== undefined) { + resp = await octokit.issues.updateComment({ + owner, + repo, + comment_id: commentId, + body, + }); } else { - await octokit.issues.createComment(props); + resp = await octokit.issues.createComment({ + owner, + repo, + issue_number: issueNumber, + body, + }); } -} - -function getWebAimLink(color1, color2) { + return resp.data.html_url; +}; + +/** + * Adds a review to the pull request. + * + * @param {Object} octokit Octokit instance. + * @param {number} prNumber Pull request number. + * @param {string} owner Owner of the repository. + * @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. + */ +const addReview = async ( + octokit, + prNumber, + owner, + repo, + reviewState, + reason, +) => { + await octokit.pulls.createReview({ + owner, + repo, + pull_number: prNumber, + event: reviewState, + body: reason, + }); +}; + +/** + * Add label to pull request. + * + * @param {Object} octokit Octokit instance. + * @param {number} prNumber Pull request number. + * @param {string} owner Repository owner. + * @param {string} repo Repository name. + * @param {string[]} labels Labels to add. + */ +const addLabel = async (octokit, prNumber, owner, repo, labels) => { + await octokit.issues.addLabels({ + owner, + repo, + issue_number: prNumber, + labels, + }); +}; + +/** + * Remove label from the pull request. + * + * @param {Object} octokit Octokit instance. + * @param {number} prNumber Pull request number. + * @param {string} owner Repository owner. + * @param {string} repo Repository name. + * @param {string} label Label to add or remove. + */ +const removeLabel = async (octokit, prNumber, owner, repo, label) => { + await octokit.issues.removeLabel({ + owner, + repo, + issue_number: prNumber, + name: label, + }); +}; + +/** + * Adds or removes a label from the pull request. + * + * @param {Object} octokit Octokit instance. + * @param {number} prNumber Pull request number. + * @param {string} owner Repository owner. + * @param {string} repo Repository name. + * @param {string} label Label to add or remove. + * @param {boolean} add Whether to add or remove the label. + */ +const addRemoveLabel = async (octokit, prNumber, owner, repo, label, add) => { + const res = await octokit.pulls.get({ + owner, + repo, + pull_number: prNumber, + }); + if (add) { + if (!res.data.labels.find((l) => l.name === label)) { + await addLabel(octokit, prNumber, owner, repo, [label]); + } + } else { + if (res.data.labels.find((l) => l.name === label)) { + await removeLabel(octokit, prNumber, owner, repo, label); + } + } +}; + +/** + * Retrieve webAim contrast color check link. + * + * @param {string} color1 First color. + * @param {string} color2 Second color. + * @returns {string} WebAim contrast color check link. + */ +const getWebAimLink = (color1, color2) => { return `https://webaim.org/resources/contrastchecker/?fcolor=${color1}&bcolor=${color2}`; -} - -function getGrsLink(colors) { +}; + +/** + * Retrieves the theme GRS url. + * + * @param {Object} colors The theme colors. + * @returns {string} GRS theme url. + */ +const getGRSLink = (colors) => { const url = `https://github-readme-stats.vercel.app/api?username=anuraghazra`; const colorString = Object.keys(colors) .map((colorKey) => `${colorKey}=${colors[colorKey]}`) .join("&"); return `${url}&${colorString}&show_icons=true`; -} - -const themeContribGuidelines = ` - \rHi, thanks for the theme contribution, please read our theme [contribution guidelines](https://github.com/anuraghazra/github-readme-stats/blob/master/CONTRIBUTING.md#themes-contribution). - \rWe are currently only accepting color combinations from any VSCode theme or themes which have good color combination to minimize bloating the themes collection. - - \r> Also note that if this theme is exclusively for your personal use, then instead of adding it to our theme collection you can use card [customization options](https://github.com/anuraghazra/github-readme-stats#customization) -`; - -async function run() { +}; + +/** + * Retrieve javascript object from json string. + * + * @description Wraps the Hjson parse function to fix several known json syntax errors. + * + * @param {string} json The json to parse. + * @returns {Object} Object parsed from the json. + */ +const parseJSON = (json) => { try { - const ccc = new ColorContrastChecker(); - const warnings = []; - const token = core.getInput("token"); - const octokit = github.getOctokit(token || process.env.PERSONAL_TOKEN); - const pullRequestId = getPrNumber(); - - if (!pullRequestId) { - console.log("PR not found"); - return; + const parsedJson = Hjson.parse(json); + if (typeof parsedJson === "object") { + return parsedJson; + } else { + throw new IncorrectJsonFormatError( + "PR diff is not a valid theme JSON object.", + ); + } + } catch (error) { + // Remove trailing commas (if any). + let parsedJson = json.replace(/(,\s*})/g, "}"); + + // Remove JS comments (if any). + parsedJson = parsedJson.replace(/\/\/[A-z\s]*\s/g, ""); + + // Fix incorrect open bracket (if any). + const splitJson = parsedJson + .split(/([\s\r\s]*}[\s\r\s]*,[\s\r\s]*)(?=[\w"-]+:)/) + .filter((x) => typeof x !== "string" || !!x.trim()); // Split json into array of strings and objects. + if (splitJson[0].replace(/\s+/g, "") === "},") { + splitJson[0] = "},"; + if (!/\s*}\s*,?\s*$/.test(splitJson[1])) { + splitJson.push(splitJson.shift()); + } else { + splitJson.shift(); + } + parsedJson = splitJson.join(""); } - const res = await octokit.pulls.get({ + // Try to parse the fixed json. + try { + return Hjson.parse(parsedJson); + } catch (error) { + throw new IncorrectJsonFormatError( + `Theme JSON file could not be parsed: ${error.message}`, + ); + } + } +}; + +/** + * Check whether the theme name is still available. + * @param {string} name Theme name. + * @returns {boolean} Whether the theme name is available. + */ +const themeNameAlreadyExists = (name) => { + return themes[name] !== undefined; +}; + +const DRY_RUN = process.env.DRY_RUN === "true" || false; + +/** + * Main function. + */ +export const run = async () => { + try { + debug("Retrieve action information from context..."); + debug(`Context: ${inspect(github.context)}`); + let commentBody = ` + \r# ${COMMENT_TITLE} + \r${THEME_CONTRIB_GUIDELINES} + `; + const ccc = new ColorContrastChecker(); + OCTOKIT = github.getOctokit(getGithubToken()); + PULL_REQUEST_ID = getPrNumber(); + const { owner, repo } = getRepoInfo(github.context); + OWNER = owner; + REPO = repo; + const commenter = getCommenter(); + PULL_REQUEST_ID = getPrNumber(); + debug(`Owner: ${OWNER}`); + debug(`Repo: ${REPO}`); + debug(`Commenter: ${commenter}`); + + // Retrieve the PR diff and preview-theme comment. + debug("Retrieve PR diff..."); + const res = await OCTOKIT.pulls.get({ owner: OWNER, repo: REPO, - pull_number: pullRequestId, + pull_number: PULL_REQUEST_ID, mediaType: { format: "diff", }, }); - const comment = await findComment(octokit, pullRequestId); + debug("Retrieve preview-theme comment..."); + const comment = await findComment( + OCTOKIT, + PULL_REQUEST_ID, + OWNER, + REPO, + commenter, + ); + // Retrieve theme changes from the PR diff. + debug("Retrieve themes..."); const diff = parse(res.data); + + // Retrieve all theme changes from the PR diff and convert to JSON. + debug("Retrieve theme changes..."); const content = diff .find((file) => file.to === "themes/index.js") - .chunks[0].changes.filter((c) => c.type === "add") - .map((c) => c.content.replace("+", "")) + .chunks.map((chunk) => + chunk.changes + .filter((c) => c.type === "add") + .map((c) => c.content.replace("+", "")) + .join(""), + ) .join(""); - - const themeObject = Hjson.parse(content); - const themeName = Object.keys(themeObject)[0]; - const colors = themeObject[themeName]; - - if (themeName !== snakeCase(themeName)) { - warnings.push("Theme name isn't in snake_case"); + const themeObject = parseJSON(content); + if ( + Object.keys(themeObject).every( + (key) => typeof themeObject[key] !== "object", + ) + ) { + throw new Error("PR diff is not a valid theme JSON object."); } - if (!colors) { - await upsertComment({ - comment_id: comment?.id, - owner: OWNER, - repo: REPO, - issue_number: pullRequestId, - body: ` - \r**${COMMENT_TITLE}** - - \rCannot create theme preview - - ${themeContribGuidelines} - `, - }); - return; - } + // Loop through themes and create theme preview body. + debug("Create theme preview body..."); + const themeValid = Object.fromEntries( + Object.keys(themeObject).map((name) => [name, true]), + ); + let previewBody = ""; + for (const theme in themeObject) { + debug(`Create theme preview for ${theme}...`); + const themeName = theme; + const colors = themeObject[theme]; + const warnings = []; + const errors = []; + + // Check if the theme name is valid. + debug("Theme preview body: Check if the theme name is valid..."); + if (themeNameAlreadyExists(themeName)) { + warnings.push("Theme name already taken"); + themeValid[theme] = false; + } + if (themeName !== snakeCase(themeName)) { + warnings.push("Theme name isn't in snake_case"); + themeValid[theme] = false; + } - const titleColor = colors.title_color; - const iconColor = colors.icon_color; - const textColor = colors.text_color; - const bgColor = colors.bg_color; - const url = getGrsLink(colors); - - const colorPairs = { - title_color: [titleColor, bgColor], - icon_color: [iconColor, bgColor], - text_color: [textColor, bgColor], - }; - - // check color contrast - Object.keys(colorPairs).forEach((key) => { - const color1 = colorPairs[key][0]; - const color2 = colorPairs[key][1]; - if (!ccc.isLevelAA(`#${color1}`, `#${color2}`)) { - const permalink = getWebAimLink(color1, color2); - warnings.push( - `\`${key}\` does not pass [AA contrast ratio](${permalink})`, + // Check if the theme colors are valid. + debug("Theme preview body: Check if the theme colors are valid..."); + let invalidColors = false; + if (!colors) { + warning.push("Theme colors are missing"); + invalidColors = true; + } else { + const missingKeys = REQUIRED_COLOR_PROPS.filter( + (x) => !Object.keys(colors).includes(x), + ); + const extraKeys = Object.keys(colors).filter( + (x) => !ACCEPTED_COLOR_PROPS.includes(x), ); + if (missingKeys.length > 0 || extraKeys.length > 0) { + for (const missingKey of missingKeys) { + errors.push(`Theme color properties \`${missingKey}\` are missing`); + } + + for (const extraKey of extraKeys) { + warnings.push( + `Theme color properties \`${extraKey}\` is not supported`, + ); + } + invalidColors = true; + } else { + for (const [colorKey, colorValue] of Object.entries(colors)) { + if (colorValue[0] === "#") { + errors.push( + `Theme color property \`${colorKey}\` should not start with '#'`, + ); + invalidColors = true; + } else if (colorValue.length > COLOR_PROPS[colorKey]) { + errors.push( + `Theme color property \`${colorKey}\` can not be longer than \`${COLOR_PROPS[colorKey]}\` characters`, + ); + invalidColors = true; + } else if (!isValidHexColor(colorValue)) { + errors.push( + `Theme color property \`${colorKey}\` is not a valid hex color: #${colorValue}`, + ); + invalidColors = true; + } + } + } + } + if (invalidColors) { + themeValid[theme] = false; + previewBody += ` + \r### ${ + themeName.charAt(0).toUpperCase() + themeName.slice(1) + } theme preview + + \r${warnings.map((warning) => `- :warning: ${warning}.\n`).join("")} + \r${errors.map((error) => `- :x: ${error}.\n`).join("")} + + \r>:x: Cannot create theme preview. + `; + continue; } - }); - await upsertComment(octokit, { - comment_id: comment?.id, - issue_number: pullRequestId, - owner: OWNER, - repo: REPO, - body: ` - \r**${COMMENT_TITLE}** + // Check color contrast. + debug("Theme preview body: Check color contrast..."); + const titleColor = colors.title_color; + const iconColor = colors.icon_color; + const textColor = colors.text_color; + const bgColor = colors.bg_color; + const borderColor = colors.border_color; + const url = getGRSLink(colors); + const colorPairs = { + title_color: [titleColor, bgColor], + icon_color: [iconColor, bgColor], + text_color: [textColor, bgColor], + }; + Object.keys(colorPairs).forEach((item) => { + let color1 = colorPairs[item][0]; + let color2 = colorPairs[item][1]; + color1 = color1.length === 4 ? color1.slice(0, 3) : color1.slice(0, 6); + color2 = color2.length === 4 ? color2.slice(0, 3) : color2.slice(0, 6); + if (!ccc.isLevelAA(`#${color1}`, `#${color2}`)) { + const permalink = getWebAimLink(color1, color2); + warnings.push( + `\`${item}\` does not pass [AA contrast ratio](${permalink})`, + ); + themeValid[theme] = false; + } + }); - \r${warnings.map((warning) => `- :warning: ${warning}\n`).join("")} + // Create theme preview body. + debug("Theme preview body: Create theme preview body..."); + previewBody += ` + \r### ${ + themeName.charAt(0).toUpperCase() + themeName.slice(1) + } theme preview + + \r${warnings.map((warning) => `- :warning: ${warning}.\n`).join("")} + + \ntitle_color: #${titleColor} | icon_color: #${iconColor} | text_color: #${textColor} | bg_color: #${bgColor}${ + borderColor ? ` | border_color: #${borderColor}` : "" + } - \ntitle_color: #${titleColor} | icon_color: #${iconColor} | text_color: #${textColor} | bg_color: #${bgColor} + \r[Preview Link](${url}) - \r[Preview Link](${url}) + \r[![](${url})](${url}) + `; + } - \r[![](${url})](${url}) + // Create comment body. + debug("Create comment body..."); + commentBody += ` + \r${ + Object.values(themeValid).every((value) => value) + ? THEME_PR_SUCCESS_TEXT + : THEME_PR_FAIL_TEXT + } + \r## Test results + \r${Object.entries(themeValid) + .map( + ([key, value]) => `- ${value ? ":heavy_check_mark:" : ":x:"} ${key}`, + ) + .join("\r")} + + \r${ + Object.values(themeValid).every((value) => value) + ? "**Result:** :heavy_check_mark: All themes are valid." + : "**Result:** :x: Some themes are invalid.\n\n" + FAIL_TEXT + } + + \r## Details + \r${previewBody} + `; + + // Create or update theme-preview comment. + debug("Create or update theme-preview comment..."); + let comment_url; + if (!DRY_RUN) { + comment_url = await upsertComment( + OCTOKIT, + PULL_REQUEST_ID, + REPO, + OWNER, + comment?.id, + commentBody, + ); + } else { + info(`DRY_RUN: Comment body: ${commentBody}`); + comment_url = ""; + } - ${themeContribGuidelines} - `, - }); + // Change review state and add/remove `invalid` label based on theme PR validity. + debug( + "Change review state and add/remove `invalid` label based on whether all themes passed...", + ); + const themesValid = Object.values(themeValid).every((value) => value); + const reviewState = themesValid ? "APPROVE" : "REQUEST_CHANGES"; + const reviewReason = themesValid + ? undefined + : INVALID_REVIEW_COMMENT(comment_url); + if (!DRY_RUN) { + await addReview( + OCTOKIT, + PULL_REQUEST_ID, + OWNER, + REPO, + reviewState, + reviewReason, + ); + await addRemoveLabel( + OCTOKIT, + PULL_REQUEST_ID, + OWNER, + REPO, + "invalid", + !themesValid, + ); + } else { + info(`DRY_RUN: Review state: ${reviewState}`); + info(`DRY_RUN: Review reason: ${reviewReason}`); + } } catch (error) { - console.log(error); + debug("Set review state to `REQUEST_CHANGES` and add `invalid` label..."); + if (!DRY_RUN) { + await addReview( + OCTOKIT, + PULL_REQUEST_ID, + OWNER, + REPO, + "REQUEST_CHANGES", + "**Something went wrong in the theme preview action:** `" + + error.message + + "`", + ); + await addRemoveLabel( + OCTOKIT, + PULL_REQUEST_ID, + OWNER, + REPO, + "invalid", + true, + ); + } else { + info(`DRY_RUN: Review state: REQUEST_CHANGES`); + info(`DRY_RUN: Review reason: ${error.message}`); + } + setFailed(error.message); } -} +}; run(); diff --git a/scripts/push-theme-readme.sh b/scripts/push-theme-readme.sh index 946096bd4d592..132a4b508e8e4 100755 --- a/scripts/push-theme-readme.sh +++ b/scripts/push-theme-readme.sh @@ -5,10 +5,11 @@ set -e export BRANCH_NAME=updated-theme-readme git --version git config --global user.email "no-reply@githubreadmestats.com" -git config --global user.name "Github Readme Stats Bot" +git config --global user.name "GitHub Readme Stats Bot" +git config --global --add safe.directory ${GITHUB_WORKSPACE} git branch -d $BRANCH_NAME || true git checkout -b $BRANCH_NAME git add --all -git commit --message "docs(theme): Auto update theme readme" || exit 0 +git commit --no-verify --message "docs(theme): Auto update theme readme" git remote add origin-$BRANCH_NAME https://${PERSONAL_TOKEN}@github.com/${GH_REPO}.git git push --force --quiet --set-upstream origin-$BRANCH_NAME $BRANCH_NAME diff --git a/src/calculateRank.js b/src/calculateRank.js index bbfece157c2c8..215c24d848c34 100644 --- a/src/calculateRank.js +++ b/src/calculateRank.js @@ -1,5 +1,15 @@ -// https://stackoverflow.com/a/5263759/10629172 -function normalcdf(mean, sigma, to) { +/** + * Calculates the probability of x taking on x or a value less than x in a normal distribution + * with mean and standard deviation. + * + * @see https://stackoverflow.com/a/5263759/10629172 + * + * @param {string} mean The mean of the normal distribution. + * @param {number} sigma The standard deviation of the normal distribution. + * @param {number} to The value to calculate the probability for. + * @returns {number} Probability. + */ +const normalcdf = (mean, sigma, to) => { var z = (to - mean) / Math.sqrt(2 * sigma * sigma); var t = 1 / (1 + 0.3275911 * Math.abs(z)); var a1 = 0.254829592; @@ -14,9 +24,22 @@ function normalcdf(mean, sigma, to) { sign = -1; } return (1 / 2) * (1 + sign * erf); -} +}; -function calculateRank({ +/** + * Calculates the users rank. + * + * @param {object} params Parameters on which the user's rank depends. + * @param {number} params.totalRepos Total number of repos. + * @param {number} params.totalCommits Total number of commits. + * @param {number} params.contributions The number of contributions. + * @param {number} params.followers The number of followers. + * @param {number} params.prs The number of pull requests. + * @param {number} params.issues The number of issues. + * @param {number} params.stargazers The number of stars. + * @returns {{level: string, score: number}}} The users rank. + */ +const calculateRank = ({ totalRepos, totalCommits, contributions, @@ -24,7 +47,7 @@ function calculateRank({ prs, issues, stargazers, -}) { +}) => { const COMMITS_OFFSET = 1.65; const CONTRIBS_OFFSET = 1.65; const ISSUES_OFFSET = 1; @@ -48,7 +71,11 @@ function calculateRank({ const RANK_B_VALUE = 100; const TOTAL_VALUES = - RANK_S_VALUE + RANK_A2_VALUE + RANK_A3_VALUE + RANK_B_VALUE; + RANK_S_VALUE + + RANK_DOUBLE_A_VALUE + + RANK_A2_VALUE + + RANK_A3_VALUE + + RANK_B_VALUE; // prettier-ignore const score = ( @@ -72,7 +99,7 @@ function calculateRank({ })(); return { level, score: normalizedScore }; -} +}; export { calculateRank }; export default calculateRank; diff --git a/src/cards/index.js b/src/cards/index.js new file mode 100644 index 0000000000000..f2c5fb0e3a143 --- /dev/null +++ b/src/cards/index.js @@ -0,0 +1,4 @@ +export { renderRepoCard } from "./repo-card.js"; +export { renderStatsCard } from "./stats-card.js"; +export { renderTopLanguages } from "./top-languages-card.js"; +export { renderWakatimeCard } from "./wakatime-card.js"; diff --git a/src/cards/repo-card.js b/src/cards/repo-card.js index 7c9c4b5771b50..a306c1d56a561 100644 --- a/src/cards/repo-card.js +++ b/src/cards/repo-card.js @@ -14,9 +14,11 @@ import { import { repoCardLocales } from "../translations.js"; /** - * @param {string} label - * @param {string} textColor - * @returns {string} + * Retrieves the repository description and wraps it to fit the card width. + * + * @param {string} label The repository description. + * @param {string} textColor The color of the text. + * @returns {string} Wrapped repo description SVG object. */ const getBadgeSVG = (label, textColor) => ` @@ -34,9 +36,11 @@ const getBadgeSVG = (label, textColor) => ` `; /** - * @param {string} langName - * @param {string} langColor - * @returns {string} + * Creates a node to display the primary programming language of the repository. + * + * @param {string} langName Language name. + * @param {string} langColor Language color. + * @returns {string} Language display SVG object. */ const createLanguageNode = (langName, langColor) => { return ` @@ -48,6 +52,15 @@ const createLanguageNode = (langName, langColor) => { }; const ICON_SIZE = 16; + +/** + * Creates an icon with label to display repository stats like forks, stars, etc. + * + * @param {string} icon The icon to display. + * @param {number|string} label The label to display. + * @param {string} testid The testid to assign to the label. + * @returns {string} Icon with label SVG object. + */ const iconWithLabel = (icon, label, testid) => { if (label <= 0) return ""; const iconSvg = ` @@ -67,9 +80,11 @@ const iconWithLabel = (icon, label, testid) => { }; /** - * @param {import('../fetchers/types').RepositoryData} repo - * @param {Partial} options - * @returns {string} + * Renders repository card details. + * + * @param {import('../fetchers/types').RepositoryData} repo Repository data. + * @param {Partial} options Card options. + * @returns {string} Repository card SVG object. */ const renderRepoCard = (repo, options = {}) => { const { @@ -88,7 +103,7 @@ const renderRepoCard = (repo, options = {}) => { icon_color, text_color, bg_color, - show_owner, + show_owner = false, theme = "default_repocard", border_radius, border_color, diff --git a/src/cards/stats-card.js b/src/cards/stats-card.js index 4b0cd33a49a21..92701d8103c95 100644 --- a/src/cards/stats-card.js +++ b/src/cards/stats-card.js @@ -1,7 +1,7 @@ // @ts-check import { Card } from "../common/Card.js"; import { I18n } from "../common/I18n.js"; -import { icons } from "../common/icons.js"; +import { icons, rankIcon } from "../common/icons.js"; import { clampValue, flexLayout, @@ -12,6 +12,24 @@ import { import { getStyles } from "../getStyles.js"; import { statCardLocales } from "../translations.js"; +const CARD_MIN_WIDTH = 287; +const CARD_DEFAULT_WIDTH = 287; +const RANK_CARD_MIN_WIDTH = 420; +const RANK_CARD_DEFAULT_WIDTH = 450; + +/** + * Create a stats card text item. + * + * @param {object[]} createTextNodeParams Object that contains the createTextNode parameters. + * @param {string} createTextNodeParams.label The label to display. + * @param {string} createTextNodeParams.value The value to display. + * @param {string} createTextNodeParams.id The id of the stat. + * @param {number} createTextNodeParams.index The index of the stat. + * @param {boolean} createTextNodeParams.showIcons Whether to show icons. + * @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. + * @returns + */ const createTextNode = ({ icon, label, @@ -21,8 +39,10 @@ const createTextNode = ({ showIcons, shiftValuePos, bold, + number_format, }) => { - const kValue = kFormatter(value); + const kValue = + number_format.toLowerCase() === "long" ? value : kFormatter(value); const staggerDelay = (index + 3) * 150; const labelOffset = showIcons ? `x="25"` : ""; @@ -50,9 +70,11 @@ const createTextNode = ({ }; /** - * @param {Partial} stats - * @param {Partial} options - * @returns {string} + * Renders the stats card. + * + * @param {Partial} stats The stats data. + * @param {Partial} options The card options. + * @returns {string} The stats card SVG object. */ const renderStatsCard = (stats = {}, options = { hide: [] }) => { const { @@ -74,6 +96,7 @@ const renderStatsCard = (stats = {}, options = { hide: [] }) => { include_all_commits = false, line_height = 25, title_color, + ring_color, icon_color, text_color, text_bold = true, @@ -82,20 +105,23 @@ const renderStatsCard = (stats = {}, options = { hide: [] }) => { custom_title, border_radius, border_color, + number_format = "short", locale, disable_animations = false, + rank_icon = "default", } = options; const lheight = parseInt(String(line_height), 10); // returns theme based colors with proper overrides and defaults - const { titleColor, textColor, iconColor, bgColor, borderColor } = + const { titleColor, iconColor, textColor, bgColor, borderColor, ringColor } = getCardColors({ title_color, - icon_color, text_color, + icon_color, bg_color, border_color, + ring_color, theme, }); @@ -137,7 +163,7 @@ const renderStatsCard = (stats = {}, options = { hide: [] }) => { }, contribs: { icon: icons.contribs, - label: i18n.t("statcard.contribs"), + label: i18n.t("statcard.contribs") + " (last year)", value: contributedTo, id: "contribs", }, @@ -155,8 +181,9 @@ const renderStatsCard = (stats = {}, options = { hide: [] }) => { "pl", "de", "nl", + "zh-tw", ]; - const isLongLocale = longLocales.includes(locale) === true; + const isLongLocale = longLocales.includes(locale); // filter out hidden stats defined by user & create the text nodes const statItems = Object.keys(STATS) @@ -167,9 +194,9 @@ const renderStatsCard = (stats = {}, options = { hide: [] }) => { ...STATS[key], index, showIcons: show_icons, - shiftValuePos: - (!include_all_commits ? 50 : 35) + (isLongLocale ? 50 : 0), + shiftValuePos: 79.01 + (isLongLocale ? 50 : 0), bold: text_bold, + number_format, }), ); @@ -185,6 +212,7 @@ const renderStatsCard = (stats = {}, options = { hide: [] }) => { const progress = 100 - rank.score; const cssStyles = getStyles({ titleColor, + ringColor, textColor, iconColor, show_icons, @@ -200,11 +228,17 @@ const renderStatsCard = (stats = {}, options = { hide: [] }) => { When hide_rank=false, the minimum card_width is 340 px + the icon width (if show_icons=true). Numbers are picked by looking at existing dimensions on production. */ - const iconWidth = show_icons ? 16 : 0; - const minCardWidth = hide_rank - ? clampValue(50 /* padding */ + calculateTextWidth() * 2, 270, Infinity) - : 340 + iconWidth; - const defaultCardWidth = hide_rank ? 270 : 495; + const iconWidth = show_icons ? 16 + /* padding */ 1 : 0; + const minCardWidth = + (hide_rank + ? clampValue( + 50 /* padding */ + calculateTextWidth() * 2, + CARD_MIN_WIDTH, + Infinity, + ) + : RANK_CARD_MIN_WIDTH) + iconWidth; + const defaultCardWidth = + (hide_rank ? CARD_DEFAULT_WIDTH : RANK_CARD_DEFAULT_WIDTH) + iconWidth; let width = isNaN(card_width) ? defaultCardWidth : card_width; if (width < minCardWidth) { width = minCardWidth; @@ -233,18 +267,21 @@ const renderStatsCard = (stats = {}, options = { hide: [] }) => { /** * Calculates the right rank circle translation values such that the rank circle - * keeps respecting the padding. + * keeps respecting the following padding: * - * width > 450: The default left padding of 50 px will be used. - * width < 450: The left and right padding will shrink equally. + * width > RANK_CARD_DEFAULT_WIDTH: The default right padding of 70 px will be used. + * width < RANK_CARD_DEFAULT_WIDTH: The left and right padding will be enlarged + * equally from a certain minimum at RANK_CARD_MIN_WIDTH. * * @returns {number} - Rank circle translation value. */ const calculateRankXTranslation = () => { - if (width < 450) { - return width - 95 + (45 * (450 - 340)) / 110; + const minXTranslation = RANK_CARD_MIN_WIDTH + iconWidth - 70; + if (width > RANK_CARD_DEFAULT_WIDTH) { + const xMaxExpansion = minXTranslation + (450 - minCardWidth) / 2; + return xMaxExpansion + width - RANK_CARD_DEFAULT_WIDTH; } else { - return width - 95; + return minXTranslation + (width - minCardWidth) / 2; } }; @@ -258,15 +295,7 @@ const renderStatsCard = (stats = {}, options = { hide: [] }) => { - - ${rank.level} - + ${rankIcon(rank_icon, rank?.level)} `; diff --git a/src/cards/top-languages-card.js b/src/cards/top-languages-card.js index b181fc12adf61..ce8e12a839c77 100644 --- a/src/cards/top-languages-card.js +++ b/src/cards/top-languages-card.js @@ -13,7 +13,7 @@ import { import { langCardLocales } from "../translations.js"; const DEFAULT_CARD_WIDTH = 300; -const MIN_CARD_WIDTH = 230; +const MIN_CARD_WIDTH = 280; const DEFAULT_LANGS_COUNT = 5; const DEFAULT_LANG_COLOR = "#858585"; const CARD_PADDING = 25; @@ -23,7 +23,10 @@ const CARD_PADDING = 25; */ /** - * @param {Lang[]} arr + * Retrieves the programming language whose name is the longest. + * + * @param {Lang[]} arr Array of programming languages. + * @returns {Object} Longest programming language object. */ const getLongestLang = (arr) => arr.reduce( @@ -33,53 +36,75 @@ const getLongestLang = (arr) => ); /** - * @param {{ - * width: number, - * color: string, - * name: string, - * progress: string - * }} props + * Creates a node to display usage of a programming language in percentage + * using text and a horizontal progress bar. + * + * @param {object} props Function properties. + * @param {number} props.width The card width + * @param {string} props.name Name of the programming language. + * @param {string} props.color Color of the programming language. + * @param {string} props.progress Usage of the programming language in percentage. + * @param {number} props.index Index of the programming language. + * @returns {string} Programming language SVG node. */ -const createProgressTextNode = ({ width, color, name, progress }) => { +const createProgressTextNode = ({ width, color, name, progress, index }) => { + const staggerDelay = (index + 3) * 150; const paddingRight = 95; const progressTextX = width - paddingRight + 10; const progressWidth = width - paddingRight; return ` - ${name} - ${progress}% - ${createProgressNode({ - x: 0, - y: 25, - color, - width: progressWidth, - progress, - progressBarBackgroundColor: "#ddd", - })} + + ${name} + ${progress}% + ${createProgressNode({ + x: 0, + y: 25, + color, + width: progressWidth, + progress, + progressBarBackgroundColor: "#ddd", + delay: staggerDelay + 300, + })} + `; }; /** - * @param {{ lang: Lang, totalSize: number }} props + * Creates a text only node to display usage of a programming language in percentage. + * + * @param {object} props Function properties. + * @param {Lang} props.lang Programming language object. + * @param {number} props.totalSize Total size of all languages. + * @param {boolean} props.hideProgress Whether to hide percentage. + * @param {number} props.index Index of the programming language. + * @returns {string} Compact layout programming language SVG node. */ -const createCompactLangNode = ({ lang, totalSize }) => { +const createCompactLangNode = ({ lang, totalSize, hideProgress, index }) => { const percentage = ((lang.size / totalSize) * 100).toFixed(2); + const staggerDelay = (index + 3) * 150; const color = lang.color || "#858585"; return ` - + - ${lang.name} ${percentage}% + ${lang.name} ${hideProgress ? "" : percentage + "%"} `; }; /** - * @param {{ langs: Lang[], totalSize: number }} props + * Creates compact layout of text only language nodes. + * + * @param {object[]} props Function properties. + * @param {Lang[]} props.langs Array of programming languages. + * @param {number} props.totalSize Total size of all languages. + * @param {boolean} props.hideProgress Whether to hide percentage. + * @returns {string} Programming languages SVG node. */ -const createLanguageTextNode = ({ langs, totalSize }) => { +const createLanguageTextNode = ({ langs, totalSize, hideProgress }) => { const longestLang = getLongestLang(langs); const chunked = chunkArray(langs, langs.length / 2); const layouts = chunked.map((array) => { @@ -88,7 +113,7 @@ const createLanguageTextNode = ({ langs, totalSize }) => { createCompactLangNode({ lang, totalSize, - // @ts-ignore + hideProgress, index, }), ); @@ -109,19 +134,22 @@ const createLanguageTextNode = ({ langs, totalSize }) => { }; /** - * @param {Lang[]} langs - * @param {number} width - * @param {number} totalLanguageSize - * @returns {string} + * Renders layout to display user's most frequently used programming languages. + * + * @param {Lang[]} langs Array of programming languages. + * @param {number} width Card width. + * @param {number} totalLanguageSize Total size of all languages. + * @returns {string} Normal layout card SVG object. */ const renderNormalLayout = (langs, width, totalLanguageSize) => { return flexLayout({ - items: langs.map((lang) => { + items: langs.map((lang, index) => { return createProgressTextNode({ - width: width, + width, name: lang.name, color: lang.color || DEFAULT_LANG_COLOR, progress: ((lang.size / totalLanguageSize) * 100).toFixed(2), + index, }); }), gap: 40, @@ -130,12 +158,15 @@ const renderNormalLayout = (langs, width, totalLanguageSize) => { }; /** - * @param {Lang[]} langs - * @param {number} width - * @param {number} totalLanguageSize - * @returns {string} + * Renders compact layout to display user's most frequently used programming languages. + * + * @param {Lang[]} langs Array of programming languages. + * @param {number} width Card width. + * @param {number} totalLanguageSize Total size of all languages. + * @param {boolean} hideProgress Whether to hide progress bar. + * @returns {string} Compact layout card SVG object. */ -const renderCompactLayout = (langs, width, totalLanguageSize) => { +const renderCompactLayout = (langs, width, totalLanguageSize, hideProgress) => { const paddingRight = 50; const offsetWidth = width - paddingRight; // progressOffset holds the previous language's width and used to offset the next language @@ -166,41 +197,52 @@ const renderCompactLayout = (langs, width, totalLanguageSize) => { .join(""); return ` - - + ${ + !hideProgress + ? ` + + ${compactProgressBar} - - + ` + : "" + } + ${createLanguageTextNode({ langs, totalSize: totalLanguageSize, + hideProgress: hideProgress, })} `; }; /** - * @param {number} totalLangs - * @returns {number} + * Calculates height for the compact layout. + * + * @param {number} totalLangs Total number of languages. + * @returns {number} Card height. */ const calculateCompactLayoutHeight = (totalLangs) => { return 90 + Math.round(totalLangs / 2) * 25; }; /** - * @param {number} totalLangs - * @returns {number} + * Calculates height for the normal layout. + * + * @param {number} totalLangs Total number of languages. + * @returns {number} Card height. */ const calculateNormalLayoutHeight = (totalLangs) => { return 45 + (totalLangs + 1) * 40; }; /** + * Hides languages and trims the list to show only the top N languages. * - * @param {Record} topLangs - * @param {string[]} hide - * @param {string} langs_count + * @param {Record} topLangs Top languages. + * @param {string[]} hide Languages to hide. + * @param {string} langs_count Number of languages to show. */ const useLanguages = (topLangs, hide, langs_count) => { let langs = Object.values(topLangs); @@ -229,19 +271,22 @@ const useLanguages = (topLangs, hide, langs_count) => { }; /** - * @param {import('../fetchers/types').TopLangData} topLangs - * @param {Partial} options - * @returns {string} + * Renders card to display user's most frequently used programming languages. + * + * @param {import('../fetchers/types').TopLangData} topLangs User's most frequently used programming languages. + * @param {Partial} options Card options. + * @returns {string} Language card SVG object. */ const renderTopLanguages = (topLangs, options = {}) => { const { - hide_title, + hide_title = false, hide_border, card_width, title_color, text_color, bg_color, hide, + hide_progress, theme, layout, custom_title, @@ -249,6 +294,7 @@ const renderTopLanguages = (topLangs, options = {}) => { langs_count = DEFAULT_LANGS_COUNT, border_radius, border_color, + disable_animations, } = options; const i18n = new I18n({ @@ -270,11 +316,16 @@ const renderTopLanguages = (topLangs, options = {}) => { let height = calculateNormalLayoutHeight(langs.length); let finalLayout = ""; - if (layout === "compact") { - width = width + 50; // padding - height = calculateCompactLayoutHeight(langs.length); - - finalLayout = renderCompactLayout(langs, width, totalLanguageSize); + if (layout === "compact" || hide_progress == true) { + height = + calculateCompactLayoutHeight(langs.length) + (hide_progress ? -25 : 0); + + finalLayout = renderCompactLayout( + langs, + width, + totalLanguageSize, + hide_progress, + ); } else { finalLayout = renderNormalLayout(langs, width, totalLanguageSize); } @@ -297,11 +348,43 @@ const renderTopLanguages = (topLangs, options = {}) => { colors, }); - card.disableAnimations(); + if (disable_animations) card.disableAnimations(); + card.setHideBorder(hide_border); card.setHideTitle(hide_title); card.setCSS( - `.lang-name { font: 400 11px 'Segoe UI', Ubuntu, Sans-Serif; fill: ${colors.textColor} }`, + ` + @keyframes slideInAnimation { + from { + width: 0; + } + to { + width: calc(100%-100px); + } + } + @keyframes growWidthAnimation { + from { + width: 0; + } + to { + width: 100%; + } + } + .lang-name { + font: 400 11px "Segoe UI", Ubuntu, Sans-Serif; + fill: ${colors.textColor}; + } + .stagger { + opacity: 0; + animation: fadeInAnimation 0.3s ease-in-out forwards; + } + #rect-mask rect{ + animation: slideInAnimation 1s ease-in-out forwards; + } + .lang-progress{ + animation: growWidthAnimation 0.6s ease-in-out forwards; + } + `, ); return card.render(` diff --git a/src/cards/types.d.ts b/src/cards/types.d.ts index 502314c41fa92..02a41b5769387 100644 --- a/src/cards/types.d.ts +++ b/src/cards/types.d.ts @@ -1,4 +1,5 @@ type ThemeNames = keyof typeof import("../../themes/index.js"); +type RankIcon = "default" | "github"; export type CommonOptions = { title_color: string; @@ -22,6 +23,10 @@ export type StatCardOptions = CommonOptions & { line_height: number | string; custom_title: string; disable_animations: boolean; + number_format: string; + ring_color: string; + text_bold: boolean; + rank_icon: RankIcon; }; export type RepoCardOptions = CommonOptions & { @@ -37,6 +42,8 @@ export type TopLangOptions = CommonOptions & { layout: "compact" | "normal"; custom_title: string; langs_count: number; + disable_animations: boolean; + hide_progress: boolean; }; type WakaTimeOptions = CommonOptions & { diff --git a/src/cards/wakatime-card.js b/src/cards/wakatime-card.js index 24571e7fffe82..2c329558b8a35 100644 --- a/src/cards/wakatime-card.js +++ b/src/cards/wakatime-card.js @@ -23,7 +23,9 @@ const require = createRequire(import.meta.url); const languageColors = require("../common/languageColors.json"); // now works /** - * @param {{color: string, text: string}} param0 + * Creates the no coding activity SVG node. + * + * @param {{color: string, text: string}} The function prop */ const noCodingActivityNode = ({ color, text }) => { return ` @@ -32,13 +34,13 @@ const noCodingActivityNode = ({ color, text }) => { }; /** + * Create compact WakaTime layout. * - * @param {{ - * lang: import("../fetchers/types").WakaTimeLang, - * totalSize: number, - * x: number, - * y: number - * }} props + * @param {Object[]} args The function arguments. + * @param {import("../fetchers/types").WakaTimeLang[]} languages The languages array. + * @param {number} totalSize The total size of the languages. + * @param {number} x The x position of the language node. + * @param {number} y The y position of the language node. */ const createCompactLangNode = ({ lang, totalSize, x, y }) => { const color = languageColors[lang.name] || "#858585"; @@ -54,12 +56,13 @@ const createCompactLangNode = ({ lang, totalSize, x, y }) => { }; /** - * @param {{ - * langs: import("../fetchers/types").WakaTimeLang[], - * totalSize: number, - * x: number, - * y: number - * }} props + * Create WakaTime language text node item. + * + * @param {Object[]} args The function arguments. + * @param {import("../fetchers/types").WakaTimeLang} lang The language object. + * @param {number} totalSize The total size of the languages. + * @param {number} x The x position of the language node. + * @param {number} y The y position of the language node. */ const createLanguageTextNode = ({ langs, totalSize, x, y }) => { return langs.map((lang, index) => { @@ -81,17 +84,16 @@ const createLanguageTextNode = ({ langs, totalSize, x, y }) => { }; /** + * Create WakaTime text item. * - * @param {{ - * id: string; - * label: string; - * value: string; - * index: number; - * percent: number; - * hideProgress: boolean; - * progressBarColor: string; - * progressBarBackgroundColor: string - * }} props + * @param {Object[]} args The function arguments. + * @param {string} id The id of the text node item. + * @param {string} label The label of the text node item. + * @param {string} value The value of the text node item. + * @param {number} index The index of the text node item. + * @param {percent} percent Percentage of the text node item. + * @param {boolean} hideProgress Whether to hide the progress bar. + * @param {string} progressBarBackgroundColor The color of the progress bar background. */ const createTextNode = ({ id, @@ -116,6 +118,7 @@ const createTextNode = ({ // @ts-ignore name: label, progressBarBackgroundColor, + delay: staggerDelay + 300, }); return ` @@ -132,11 +135,13 @@ const createTextNode = ({ }; /** - * @param {import("../fetchers/types").WakaTimeLang[]} languages + * Recalculating percentages so that, compact layout's progress bar does not break when + * hiding languages. + * + * @param {import("../fetchers/types").WakaTimeLang[]} languages The languages array. + * @return {import("../fetchers/types").WakaTimeLang[]} The recalculated languages array. */ const recalculatePercentages = (languages) => { - // recalculating percentages so that, - // compact layout's progress bar does not break when hiding languages const totalSum = languages.reduce( (totalSum, language) => totalSum + language.percent, 0, @@ -148,12 +153,14 @@ const recalculatePercentages = (languages) => { }; /** - * @param {Partial} stats - * @param {Partial} options - * @returns {string} + * Renders WakaTime card. + * + * @param {Partial} stats WakaTime stats. + * @param {Partial} options Card options. + * @returns {string} WakaTime card SVG. */ const renderWakatimeCard = (stats = {}, options = { hide: [] }) => { - let { languages } = stats; + let { languages = [] } = stats; const { hide_title = false, hide_border = false, @@ -168,20 +175,24 @@ const renderWakatimeCard = (stats = {}, options = { hide: [] }) => { custom_title, locale, layout, - langs_count = languages ? languages.length : 0, + langs_count = languages.length, border_radius, border_color, } = options; const shouldHideLangs = Array.isArray(hide) && hide.length > 0; - if (shouldHideLangs && languages !== undefined) { + if (shouldHideLangs) { const languagesToHide = new Set(hide.map((lang) => lowercaseTrim(lang))); languages = languages.filter( (lang) => !languagesToHide.has(lowercaseTrim(lang.name)), ); - recalculatePercentages(languages); } + // Since the percentages are sorted in descending order, we can just + // slice from the beginning without sorting. + languages = languages.slice(0, langs_count); + recalculatePercentages(languages); + const i18n = new I18n({ locale, translations: wakatimeCardLocales, @@ -203,10 +214,8 @@ const renderWakatimeCard = (stats = {}, options = { hide: [] }) => { }); const filteredLanguages = languages - ? languages - .filter((language) => language.hours || language.minutes) - .slice(0, langsCount) - : []; + .filter((language) => language.hours || language.minutes) + .slice(0, langsCount); // Calculate the card height depending on how many items there are // but if rank circle is visible clamp the minimum height to `150` @@ -268,11 +277,12 @@ const renderWakatimeCard = (stats = {}, options = { hide: [] }) => { } else { finalLayout = flexLayout({ items: filteredLanguages.length - ? filteredLanguages.map((language) => { + ? filteredLanguages.map((language, index) => { return createTextNode({ id: language.name, label: language.name, value: language.text, + index: index, percent: language.percent, // @ts-ignore progressBarColor: titleColor, @@ -313,7 +323,29 @@ const renderWakatimeCard = (stats = {}, options = { hide: [] }) => { card.setCSS( ` ${cssStyles} + @keyframes slideInAnimation { + from { + width: 0; + } + to { + width: calc(100%-100px); + } + } + @keyframes growWidthAnimation { + from { + width: 0; + } + to { + width: 100%; + } + } .lang-name { font: 400 11px 'Segoe UI', Ubuntu, Sans-Serif; fill: ${textColor} } + #rect-mask rect{ + animation: slideInAnimation 1s ease-in-out forwards; + } + .lang-progress{ + animation: growWidthAnimation 0.6s ease-in-out forwards; + } `, ); diff --git a/src/common/Card.js b/src/common/Card.js index 5fd4b9f372c7c..2f1d9c29f274d 100644 --- a/src/common/Card.js +++ b/src/common/Card.js @@ -3,14 +3,16 @@ import { encodeHTML, flexLayout } from "./utils.js"; class Card { /** - * @param {object} args - * @param {number?=} args.width - * @param {number?=} args.height - * @param {number?=} args.border_radius - * @param {string?=} args.customTitle - * @param {string?=} args.defaultTitle - * @param {string?=} args.titlePrefixIcon - * @param {ReturnType?=} args.colors + * Creates a new card instance. + * + * @param {object} args Card arguments. + * @param {number?=} args.width Card width. + * @param {number?=} args.height Card height. + * @param {number?=} args.border_radius Card border radius. + * @param {string?=} args.customTitle Card custom title. + * @param {string?=} args.defaultTitle Card default title. + * @param {string?=} args.titlePrefixIcon Card title prefix icon. + * @returns {Card} Card instance. */ constructor({ width = 100, diff --git a/src/common/I18n.js b/src/common/I18n.js index 7f607cd962f0d..48242af264c95 100644 --- a/src/common/I18n.js +++ b/src/common/I18n.js @@ -1,3 +1,6 @@ +/** + * I18n translation class. + */ class I18n { constructor({ locale, translations }) { this.locale = locale; diff --git a/src/common/createProgressNode.js b/src/common/createProgressNode.js index 4cc3747686411..2825583c7406a 100644 --- a/src/common/createProgressNode.js +++ b/src/common/createProgressNode.js @@ -1,5 +1,18 @@ import { clampValue } from "./utils.js"; +/** + * Create a node to indicate progress in percentage along a horizontal line. + * + * @param {Object} createProgressNodeParams Object that contains the createProgressNode parameters. + * @param {number} createProgressNodeParams.x X-axis position. + * @param {number} createProgressNodeParams.y Y-axis position. + * @param {number} createProgressNodeParams.width Width of progress bar. + * @param {string} createProgressNodeParams.color Progress color. + * @param {string} createProgressNodeParams.progress Progress value. + * @param {string} createProgressNodeParams.progressBarBackgroundColor Progress bar bg color. + * @param {number} createProgressNodeParams.delay Delay before animation starts. + * @returns {string} Progress node. + */ const createProgressNode = ({ x, y, @@ -7,20 +20,22 @@ const createProgressNode = ({ color, progress, progressBarBackgroundColor, + delay, }) => { const progressPercentage = clampValue(progress, 2, 100); return ` - - + + + `; }; diff --git a/src/common/icons.js b/src/common/icons.js index 5282a93ec8725..948ca0bc427d1 100644 --- a/src/common/icons.js +++ b/src/common/icons.js @@ -8,5 +8,28 @@ const icons = { fork: ``, }; -export { icons }; +/** + * Get rank icon + * + * @returns {string} - The SVG code of the rank icon + */ +const rankIcon = (rankIcon, rankLevel) => { + switch (rankIcon) { + case "github": + return ` + + `; + case "default": + default: + return ` + + ${rankLevel} + + `; + } +}; + +export { icons, rankIcon }; export default icons; diff --git a/src/common/index.js b/src/common/index.js new file mode 100644 index 0000000000000..2e7e9cb20fe0b --- /dev/null +++ b/src/common/index.js @@ -0,0 +1,30 @@ +export { blacklist } from "./blacklist.js"; +export { Card } from "./Card.js"; +export { createProgressNode } from "./createProgressNode.js"; +export { I18n } from "./I18n.js"; +export { icons } from "./icons.js"; +export { retryer } from "./retryer.js"; +export { + ERROR_CARD_LENGTH, + renderError, + encodeHTML, + kFormatter, + isValidHexColor, + parseBoolean, + parseArray, + clampValue, + isValidGradient, + fallbackColor, + request, + flexLayout, + getCardColors, + wrapTextMultiline, + logger, + CONSTANTS, + CustomError, + MissingParamError, + measureText, + lowercaseTrim, + chunkArray, + parseEmojis, +} from "./utils.js"; diff --git a/src/common/languageColors.json b/src/common/languageColors.json index 7e8cd551264b8..3937eec5a2bf5 100644 --- a/src/common/languageColors.json +++ b/src/common/languageColors.json @@ -79,6 +79,7 @@ "Ceylon": "#dfa535", "Chapel": "#8dc63f", "ChucK": "#3f8000", + "Circom": "#707575", "Cirru": "#ccccff", "Clarion": "#db901e", "Clarity": "#5546ff", @@ -102,6 +103,7 @@ "Csound Score": "#1a1a1a", "Cuda": "#3A4E3A", "Curry": "#531242", + "Cypher": "#34c0eb", "Cython": "#fedf5b", "D": "#ba595e", "DM": "#447265", @@ -115,6 +117,7 @@ "DirectX 3D File": "#aace60", "Dockerfile": "#384d54", "Dogescript": "#cca760", + "Dotenv": "#e5d559", "Dylan": "#6c616e", "E": "#ccce35", "ECL": "#8a1267", @@ -124,11 +127,13 @@ "Earthly": "#2af0ff", "Easybuild": "#069406", "Ecere Projects": "#913960", + "Ecmarkup": "#eb8131", "EditorConfig": "#fff1f2", "Eiffel": "#4d6977", "Elixir": "#6e4a7e", "Elm": "#60B5CC", "Elvish": "#55BB55", + "Elvish Transcript": "#55BB55", "Emacs Lisp": "#c065db", "EmberScript": "#FFF4F3", "Erlang": "#B83998", @@ -147,7 +152,7 @@ "Forth": "#341708", "Fortran": "#4d41b1", "Fortran Free Form": "#4d41b1", - "FreeBasic": "#867db1", + "FreeBasic": "#141AC9", "FreeMarker": "#0050b2", "Frege": "#00cafe", "Futhark": "#5f021f", @@ -180,6 +185,7 @@ "Go": "#00ADD8", "Go Checksums": "#00ADD8", "Go Module": "#00ADD8", + "Godot Resource": "#355570", "Golo": "#88562A", "Gosu": "#82937f", "Grace": "#615f8b", @@ -190,6 +196,7 @@ "Groovy": "#4298b8", "Groovy Server Pages": "#4298b8", "HAProxy": "#106da9", + "HCL": "#844FBA", "HLSL": "#aace60", "HOCON": "#9ff8ee", "HTML": "#e34c26", @@ -215,6 +222,7 @@ "Idris": "#b30000", "Ignore List": "#000000", "ImageJ Macro": "#99AAFF", + "Imba": "#16cec6", "Inno Setup": "#264b99", "Io": "#a9188d", "Ioke": "#078193", @@ -222,6 +230,7 @@ "Isabelle ROOT": "#FEFE00", "J": "#9EEDFF", "JAR Manifest": "#b07219", + "JCL": "#d90e09", "JFlex": "#DBCA00", "JSON": "#292929", "JSON with Comments": "#292929", @@ -244,9 +253,11 @@ "Jsonnet": "#0064bd", "Julia": "#a270ba", "Jupyter Notebook": "#DA5B0B", + "Just": "#384d54", "KRL": "#28430A", "Kaitai Struct": "#773b37", "KakouneScript": "#6f8042", + "KerboScript": "#41adf0", "KiCad Layout": "#2f4aab", "KiCad Legacy Layout": "#2f4aab", "KiCad Schematic": "#2f4aab", @@ -286,6 +297,7 @@ "Mathematica": "#dd1100", "Max": "#c4a79c", "Mercury": "#ff2b2b", + "Mermaid": "#ff3670", "Meson": "#007800", "Metal": "#8f14e9", "MiniYAML": "#ff1111", @@ -318,6 +330,10 @@ "Nu": "#c9df40", "NumPy": "#9C8AF9", "Nunjucks": "#3d8137", + "OASv2-json": "#85ea2d", + "OASv2-yaml": "#85ea2d", + "OASv3-json": "#85ea2d", + "OASv3-yaml": "#85ea2d", "OCaml": "#3be133", "ObjectScript": "#424893", "Objective-C": "#438eff", @@ -327,14 +343,18 @@ "Omgrofl": "#cabbff", "Opal": "#f7ede0", "Open Policy Agent": "#7d9199", + "OpenAPI Specification v2": "#85ea2d", + "OpenAPI Specification v3": "#85ea2d", "OpenCL": "#ed2e2d", "OpenEdge ABL": "#5ce600", "OpenQASM": "#AA70FF", "OpenSCAD": "#e5cd45", + "Option List": "#476732", "Org": "#77aa99", "Oxygene": "#cdd0e3", "Oz": "#fab738", "P4": "#7055b5", + "PDDL": "#0d00ff", "PEG.js": "#234d6b", "PHP": "#4F5D95", "PLSQL": "#dad8d8", @@ -350,7 +370,9 @@ "PicoLisp": "#6067af", "PigLatin": "#fcd7de", "Pike": "#005390", + "PlantUML": "#fbbd16", "PogoScript": "#d80074", + "Polar": "#ae81ff", "Portugol": "#f8bd00", "PostCSS": "#dc3a0c", "PostScript": "#da291c", @@ -366,6 +388,7 @@ "Puppet": "#302B6D", "PureBasic": "#5a6986", "PureScript": "#1D222D", + "Pyret": "#ee1e10", "Python": "#3572A5", "Python console": "#3572A5", "Python traceback": "#3572A5", @@ -414,6 +437,7 @@ "Sass": "#a53b70", "Scala": "#c22d40", "Scaml": "#bd181a", + "Scenic": "#fdc700", "Scheme": "#1e4aec", "Scilab": "#ca0f21", "Self": "#0579aa", @@ -421,6 +445,7 @@ "Shell": "#89e051", "ShellCheck Config": "#cecfcb", "Shen": "#120F14", + "Simple File Verification": "#C9BFED", "Singularity": "#64E6AD", "Slash": "#007eff", "Slice": "#003fa2", @@ -428,6 +453,8 @@ "SmPL": "#c94949", "Smalltalk": "#596706", "Smarty": "#f0c040", + "Smithy": "#c44536", + "Snakemake": "#419179", "Solidity": "#AA6746", "SourcePawn": "#f69e1d", "Squirrel": "#800000", @@ -441,6 +468,7 @@ "SugarSS": "#2fcc9f", "SuperCollider": "#46390b", "Svelte": "#ff3e00", + "Sway": "#dea584", "Swift": "#F05138", "SystemVerilog": "#DAE1C2", "TI Program": "#A0AA87", @@ -478,6 +506,7 @@ "Vim Script": "#199f4b", "Vim Snippet": "#199f4b", "Visual Basic .NET": "#945db7", + "Visual Basic 6.0": "#2c6353", "Volt": "#1F1F1F", "Vue": "#41b883", "Vyper": "#2980b9", diff --git a/src/common/retryer.js b/src/common/retryer.js index c898ef3f9e207..5351cbe8cf99a 100644 --- a/src/common/retryer.js +++ b/src/common/retryer.js @@ -1,7 +1,22 @@ import { CustomError, logger } from "./utils.js"; +// Script variables. +const PATs = Object.keys(process.env).filter((key) => + /PAT_\d*$/.exec(key), +).length; +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 + */ const retryer = async (fetcher, variables, retries = 0) => { - if (retries > 7) { + if (retries > RETRIES) { throw new CustomError("Maximum retries exceeded", CustomError.MAX_RETRY); } try { @@ -30,12 +45,17 @@ const retryer = async (fetcher, variables, retries = 0) => { // prettier-ignore // also checking for bad credentials if any tokens gets invalidated const isBadCredential = err.response.data && err.response.data.message === "Bad credentials"; + const isAccountSuspended = + err.response.data && + err.response.data.message === "Sorry. Your account was suspended."; - if (isBadCredential) { + if (isBadCredential || isAccountSuspended) { logger.log(`PAT_${retries + 1} Failed`); retries++; // directly return from the function return retryer(fetcher, variables, retries); + } else { + return err.response; } } }; diff --git a/src/common/utils.js b/src/common/utils.js index 7660bbd1355d1..f82544604cf9c 100644 --- a/src/common/utils.js +++ b/src/common/utils.js @@ -4,20 +4,27 @@ import toEmoji from "emoji-name-map"; import wrap from "word-wrap"; import { themes } from "../../themes/index.js"; +// Script parameters. +const ERROR_CARD_LENGTH = 576.5; + /** - * @param {string} message - * @param {string} secondaryMessage - * @returns {string} + * Renders error message on the card. + * + * @param {string} message Main error message. + * @param {string} secondaryMessage The secondary error message. + * @returns {string} The SVG markup. */ const renderError = (message, secondaryMessage = "") => { return ` - + - + Something went wrong! file an issue at https://tiny.one/readme-stats ${encodeHTML(message)} @@ -28,86 +35,110 @@ const renderError = (message, secondaryMessage = "") => { }; /** + * Encode string as HTML. + * * @see https://stackoverflow.com/a/48073476/10629172 - * @param {string} str - * @returns {string} + * + * @param {string} str String to encode. + * @returns {string} Encoded string. */ -function encodeHTML(str) { +const encodeHTML = (str) => { return str .replace(/[\u00A0-\u9999<>&](?!#)/gim, (i) => { return "&#" + i.charCodeAt(0) + ";"; }) .replace(/\u0008/gim, ""); -} +}; /** - * @param {number} num + * Retrieves num with suffix k(thousands) precise to 1 decimal if greater than 999. + * + * @param {number} num The number to format. + * @returns {string|number} The formatted number. */ -function kFormatter(num) { +const kFormatter = (num) => { return Math.abs(num) > 999 ? Math.sign(num) * parseFloat((Math.abs(num) / 1000).toFixed(1)) + "k" : Math.sign(num) * Math.abs(num); -} +}; /** - * @param {string} hexColor - * @returns {boolean} + * Checks if a string is a valid hex color. + * + * @param {string} hexColor String to check. + * @returns {boolean} True if the given string is a valid hex color. */ -function isValidHexColor(hexColor) { +const isValidHexColor = (hexColor) => { return new RegExp( /^([A-Fa-f0-9]{8}|[A-Fa-f0-9]{6}|[A-Fa-f0-9]{3}|[A-Fa-f0-9]{4})$/, ).test(hexColor); -} +}; /** - * @param {string} value - * @returns {boolean | string} + * Returns boolean if value is either "true" or "false" else the value as it is. + * + * @param {string | boolean} value The value to parse. + * @returns {boolean | undefined } The parsed value. */ -function parseBoolean(value) { - if (value === "true") { - return true; - } else if (value === "false") { - return false; - } else { - return value; +const parseBoolean = (value) => { + if (typeof value === "boolean") return value; + + if (typeof value === "string") { + if (value.toLowerCase() === "true") { + return true; + } else if (value.toLowerCase() === "false") { + return false; + } } -} + return undefined; +}; /** - * @param {string} str + * Parse string to array of strings. + * + * @param {string} str The string to parse. + * @returns {string[]} The array of strings. */ -function parseArray(str) { +const parseArray = (str) => { if (!str) return []; return str.split(","); -} +}; /** - * @param {number} number - * @param {number} min - * @param {number} max + * Clamp the given number between the given range. + * + * @param {number} number The number to clamp. + * @param {number} min The minimum value. + * @param {number} max The maximum value. + * returns {number} The clamped number. */ -function clampValue(number, min, max) { +const clampValue = (number, min, max) => { // @ts-ignore if (Number.isNaN(parseInt(number))) return min; return Math.max(min, Math.min(number, max)); -} +}; /** - * @param {string[]} colors + * Check if the given string is a valid gradient. + * + * @param {string[]} colors Array of colors. + * @returns {boolean} True if the given string is a valid gradient. */ -function isValidGradient(colors) { +const isValidGradient = (colors) => { return isValidHexColor(colors[1]) && isValidHexColor(colors[2]); -} +}; /** - * @param {string} color - * @param {string} fallbackColor - * @returns {string | string[]} + * Retrieves a gradient if color has more than one valid hex codes else a single color. + * + * @param {string} color The color to parse. + * @param {string} fallbackColor The fallback color. + * @returns {string | string[]} The gradient or color. */ -function fallbackColor(color, fallbackColor) { - let colors = color.split(","); +const fallbackColor = (color, fallbackColor) => { let gradient = null; + let colors = color ? color.split(",") : []; if (colors.length > 1 && isValidGradient(colors)) { gradient = colors; } @@ -116,13 +147,16 @@ function fallbackColor(color, fallbackColor) { (gradient ? gradient : isValidHexColor(color) && `#${color}`) || fallbackColor ); -} +}; /** - * @param {import('axios').AxiosRequestConfig['data']} data - * @param {import('axios').AxiosRequestConfig['headers']} headers + * Send GraphQL request to GitHub API. + * + * @param {import('axios').AxiosRequestConfig['data']} data Request data. + * @param {import('axios').AxiosRequestConfig['headers']} headers Request headers. + * @returns {Promise} Request response. */ -function request(data, headers) { +const request = (data, headers) => { // @ts-ignore return axios({ url: "https://api.github.com/graphql", @@ -130,22 +164,20 @@ function request(data, headers) { headers, data, }); -} +}; /** - * @param {object} props - * @param {string[]} props.items - * @param {number} props.gap - * @param {number[]?=} props.sizes - * @param {"column" | "row"?=} props.direction - * - * @returns {string[]} + * Auto layout utility, allows us to layout things vertically or horizontally with + * proper gaping. * - * @description - * Auto layout utility, allows us to layout things - * vertically or horizontally with proper gaping + * @param {object} props Function properties. + * @param {string[]} props.items Array of items to layout. + * @param {number} props.gap Gap between items. + * @param {number[]?=} props.sizes Array of sizes for each item. + * @param {"column" | "row"?=} props.direction Direction to layout items. + * @returns {string[]} Array of items with proper layout. */ -function flexLayout({ items, gap, direction, sizes = [] }) { +const flexLayout = ({ items, gap, direction, sizes = [] }) => { let lastSize = 0; // filter() for filtering out empty strings return items.filter(Boolean).map((item, i) => { @@ -157,31 +189,31 @@ function flexLayout({ items, gap, direction, sizes = [] }) { lastSize += size + gap; return `${item}`; }); -} +}; /** - * @typedef {object} CardColors - * @prop {string?=} title_color - * @prop {string?=} text_color - * @prop {string?=} icon_color - * @prop {string?=} bg_color - * @prop {string?=} border_color - * @prop {keyof typeof import('../../themes')?=} fallbackTheme - * @prop {keyof typeof import('../../themes')?=} theme - */ -/** - * returns theme based colors with proper overrides and defaults - * @param {CardColors} options + * Returns theme based colors with proper overrides and defaults. + * + * @param {Object[]} args Function arguments. + * @param {string} args.title_color Card title color. + * @param {string} args.text_color Card text color. + * @param {string} args.icon_color Card icon color. + * @param {string} args.bg_color Card background color. + * @param {string} args.border_color Card border color. + * @param {string} args.theme Card theme. + * @param {string} args.fallbackTheme Fallback theme. + * */ -function getCardColors({ +const getCardColors = ({ title_color, text_color, icon_color, bg_color, border_color, + ring_color, theme, fallbackTheme = "default", -}) { +}) => { const defaultTheme = themes[fallbackTheme]; const selectedTheme = themes[theme] || defaultTheme; const defaultBorderColor = @@ -193,6 +225,13 @@ function getCardColors({ title_color || selectedTheme.title_color, "#" + defaultTheme.title_color, ); + + // get the color provided by the user else the theme color + // finally if both colors are invalid we use the titleColor + const ringColor = fallbackColor( + ring_color || selectedTheme.ring_color, + titleColor, + ); const iconColor = fallbackColor( icon_color || selectedTheme.icon_color, "#" + defaultTheme.icon_color, @@ -211,16 +250,18 @@ function getCardColors({ "#" + defaultBorderColor, ); - return { titleColor, iconColor, textColor, bgColor, borderColor }; -} + return { titleColor, iconColor, textColor, bgColor, borderColor, ringColor }; +}; /** - * @param {string} text - * @param {number} width - * @param {number} maxLines - * @returns {string[]} + * Split text over multiple lines based on the card width. + * + * @param {string} text Text to split. + * @param {number} width Line width in number of characters. + * @param {number} maxLines Maximum number of lines. + * @returns {string[]} Array of lines. */ -function wrapTextMultiline(text, width = 59, maxLines = 3) { +const wrapTextMultiline = (text, width = 59, maxLines = 3) => { const fullWidthComma = "，"; const encoded = encodeHTML(text); const isChinese = encoded.includes(fullWidthComma); @@ -245,7 +286,7 @@ function wrapTextMultiline(text, width = 59, maxLines = 3) { // Remove empty lines if text fits in less than maxLines lines const multiLineText = lines.filter(Boolean); return multiLineText; -} +}; const noop = () => {}; // return console instance based on the environment @@ -263,12 +304,16 @@ const SECONDARY_ERROR_MESSAGES = { MAX_RETRY: "Please add an env variable called PAT_1 with your github token in vercel", USER_NOT_FOUND: "Make sure the provided username is not an organization", + GRAPHQL_ERROR: "Please try again later", }; +/** + * Custom error class to handle custom GRS errors. + */ class CustomError extends Error { /** - * @param {string} message - * @param {string} type + * @param {string} message Error message. + * @param {string} type Error type. */ constructor(message, type) { super(message); @@ -278,8 +323,12 @@ class CustomError extends Error { static MAX_RETRY = "MAX_RETRY"; static USER_NOT_FOUND = "USER_NOT_FOUND"; + static GRAPHQL_ERROR = "GRAPHQL_ERROR"; } +/** + * Missing query parameter class. + */ class MissingParamError extends Error { /** * @param {string[]} missedParams @@ -296,12 +345,14 @@ class MissingParamError extends Error { } /** + * Retrieve text length. + * * @see https://stackoverflow.com/a/48172630/10629172 - * @param {string} str - * @param {number} fontSize - * @returns + * @param {string} str String to measure. + * @param {number} fontSize Font size. + * @returns {number} Text length. */ -function measureText(str, fontSize = 10) { +const measureText = (str, fontSize = 10) => { // prettier-ignore const widths = [ 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, @@ -333,18 +384,20 @@ function measureText(str, fontSize = 10) { ) .reduce((cur, acc) => acc + cur) * fontSize ); -} +}; /** @param {string} name */ const lowercaseTrim = (name) => name.toLowerCase().trim(); /** - * @template T - * @param {Array} arr - * @param {number} perChunk - * @returns {Array} + * Split array of languages in two columns. + * + * @template T Language object. + * @param {Array} arr Array of languages. + * @param {number} perChunk Number of languages per column. + * @returns {Array} Array of languages split in two columns. */ -function chunkArray(arr, perChunk) { +const chunkArray = (arr, perChunk) => { return arr.reduce((resultArray, item, index) => { const chunkIndex = Math.floor(index / perChunk); @@ -356,39 +409,56 @@ function chunkArray(arr, perChunk) { return resultArray; }, []); -} +}; /** + * Parse emoji from string. * - * @param {string} str - * @returns {string} + * @param {string} str String to parse emoji from. + * @returns {string} String with emoji parsed. */ -function parseEmojis(str) { +const parseEmojis = (str) => { if (!str) throw new Error("[parseEmoji]: str argument not provided"); return str.replace(/:\w+:/gm, (emoji) => { return toEmoji.get(emoji) || ""; }); -} +}; + +/** + * Get diff in minutes + * @param {Date} d1 + * @param {Date} d2 + * @returns {number} + */ +const dateDiff = (d1, d2) => { + const date1 = new Date(d1); + const date2 = new Date(d2); + const diff = date1.getTime() - date2.getTime(); + return Math.round(diff / (1000 * 60)); +}; export { + ERROR_CARD_LENGTH, renderError, - kFormatter, encodeHTML, + kFormatter, isValidHexColor, - request, - parseArray, parseBoolean, + parseArray, + clampValue, + isValidGradient, fallbackColor, + request, flexLayout, getCardColors, - clampValue, wrapTextMultiline, - measureText, logger, CONSTANTS, CustomError, MissingParamError, + measureText, lowercaseTrim, chunkArray, parseEmojis, + dateDiff, }; diff --git a/src/fetchers/repo-fetcher.js b/src/fetchers/repo-fetcher.js index 37bce0e7ae352..ff7a2be8164cc 100644 --- a/src/fetchers/repo-fetcher.js +++ b/src/fetchers/repo-fetcher.js @@ -3,8 +3,11 @@ import { retryer } from "../common/retryer.js"; import { MissingParamError, request } from "../common/utils.js"; /** - * @param {import('Axios').AxiosRequestHeaders} variables - * @param {string} token + * Repo data fetcher. + * + * @param {import('Axios').AxiosRequestHeaders} variables Fetcher variables. + * @param {string} token GitHub token. + * @returns {Promise} The response. */ const fetcher = (variables, token) => { return request( @@ -51,11 +54,13 @@ const fetcher = (variables, token) => { const urlExample = "/api/pin?username=USERNAME&repo=REPO_NAME"; /** - * @param {string} username - * @param {string} reponame - * @returns {Promise} + * Fetch repository data. + * + * @param {string} username GitHub username. + * @param {string} reponame GitHub repository name. + * @returns {Promise} Repository data. */ -async function fetchRepo(username, reponame) { +const fetchRepo = async (username, reponame) => { if (!username && !reponame) { throw new MissingParamError(["username", "repo"], urlExample); } @@ -95,7 +100,7 @@ async function fetchRepo(username, reponame) { starCount: data.organization.repository.stargazers.totalCount, }; } -} +}; export { fetchRepo }; export default fetchRepo; diff --git a/src/fetchers/stats-fetcher.js b/src/fetchers/stats-fetcher.js index b9493adfdbb43..8603e38bbf59d 100644 --- a/src/fetchers/stats-fetcher.js +++ b/src/fetchers/stats-fetcher.js @@ -9,53 +9,77 @@ import { logger, MissingParamError, request, + wrapTextMultiline, } from "../common/utils.js"; dotenv.config(); +// GraphQL queries. +const GRAPHQL_REPOS_FIELD = ` + repositories(first: 100, ownerAffiliations: OWNER, orderBy: {direction: DESC, field: STARGAZERS}, after: $after) { + totalCount + nodes { + name + stargazers { + totalCount + } + } + pageInfo { + hasNextPage + endCursor + } + } +`; + +const GRAPHQL_REPOS_QUERY = ` + query userInfo($login: String!, $after: String) { + user(login: $login) { + ${GRAPHQL_REPOS_FIELD} + } + } +`; + +const GRAPHQL_STATS_QUERY = ` + query userInfo($login: String!, $after: String) { + user(login: $login) { + name + login + contributionsCollection { + totalCommitContributions + restrictedContributionsCount + } + repositoriesContributedTo(first: 1, contributionTypes: [COMMIT, ISSUE, PULL_REQUEST, REPOSITORY]) { + totalCount + } + pullRequests(first: 1) { + totalCount + } + openIssues: issues(states: OPEN) { + totalCount + } + closedIssues: issues(states: CLOSED) { + totalCount + } + followers { + totalCount + } + ${GRAPHQL_REPOS_FIELD} + } + } +`; + /** - * @param {import('axios').AxiosRequestHeaders} variables - * @param {string} token + * Stats fetcher object. + * + * @param {import('axios').AxiosRequestHeaders} variables Fetcher variables. + * @param {string} token GitHub token. + * @returns {Promise} Stats fetcher response. */ const fetcher = (variables, token) => { + const query = !variables.after ? GRAPHQL_STATS_QUERY : GRAPHQL_REPOS_QUERY; return request( { - query: ` - query userInfo($login: String!) { - user(login: $login) { - name - login - contributionsCollection { - totalCommitContributions - restrictedContributionsCount - } - repositoriesContributedTo(first: 1, contributionTypes: [COMMIT, ISSUE, PULL_REQUEST, REPOSITORY]) { - totalCount - } - pullRequests(first: 1) { - totalCount - } - openIssues: issues(states: OPEN) { - totalCount - } - closedIssues: issues(states: CLOSED) { - totalCount - } - followers { - totalCount - } - repositories(first: 100, ownerAffiliations: OWNER, orderBy: {direction: DESC, field: STARGAZERS}) { - totalCount - nodes { - name - stargazers { - totalCount - } - } - } - } - } - `, + query, variables, }, { @@ -64,8 +88,54 @@ const fetcher = (variables, token) => { ); }; -// https://github.com/anuraghazra/github-readme-stats/issues/92#issuecomment-661026467 -// https://github.com/anuraghazra/github-readme-stats/pull/211/ +/** + * Fetch stats information for a given username. + * + * @param {string} username Github username. + * @returns {Promise} GraphQL Stats object. + * + * @description This function supports multi-page fetching if the 'FETCH_MULTI_PAGE_STARS' environment variable is set to true. + */ +const statsFetcher = async (username) => { + let stats; + let hasNextPage = true; + let endCursor = null; + while (hasNextPage) { + const variables = { login: username, first: 100, after: endCursor }; + let res = await retryer(fetcher, variables); + if (res.data.errors) return res; + + // Store stats data. + const repoNodes = res.data.data.user.repositories.nodes; + if (!stats) { + stats = res; + } else { + stats.data.data.user.repositories.nodes.push(...repoNodes); + } + + // Disable multi page fetching on public Vercel instance due to rate limits. + const repoNodesWithStars = repoNodes.filter( + (node) => node.stargazers.totalCount !== 0, + ); + hasNextPage = + process.env.FETCH_MULTI_PAGE_STARS === "true" && + repoNodes.length === repoNodesWithStars.length && + res.data.data.user.repositories.pageInfo.hasNextPage; + endCursor = res.data.data.user.repositories.pageInfo.endCursor; + } + + return stats; +}; + +/** + * Fetch all the commits for all the repositories of a given username. + * + * @param {*} username GitHub username. + * @returns {Promise} Total commits. + * + * @description Done like this because the GitHub API does not provide a way to fetch all the commits. See + * #92#issuecomment-661026467 and #211 for more information. + */ const totalCommitsFetcher = async (username) => { if (!githubUsernameRegex.test(username)) { logger.log("Invalid username"); @@ -100,17 +170,19 @@ const totalCommitsFetcher = async (username) => { }; /** - * @param {string} username - * @param {boolean} count_private - * @param {boolean} include_all_commits - * @returns {Promise} + * Fetch stats for a given username. + * + * @param {string} username GitHub username. + * @param {boolean} count_private Include private contributions. + * @param {boolean} include_all_commits Include all commits. + * @returns {Promise} Stats data. */ -async function fetchStats( +const fetchStats = async ( username, count_private = false, include_all_commits = false, exclude_repo = [], -) { +) => { if (!username) throw new MissingParamError(["username"]); const stats = { @@ -123,13 +195,26 @@ async function fetchStats( rank: { level: "C", score: 0 }, }; - let res = await retryer(fetcher, { login: username }); + let res = await statsFetcher(username); + // Catch GraphQL errors. if (res.data.errors) { logger.error(res.data.errors); + if (res.data.errors[0].type === "NOT_FOUND") { + throw new CustomError( + res.data.errors[0].message || "Could not fetch user.", + CustomError.USER_NOT_FOUND, + ); + } + if (res.data.errors[0].message) { + throw new CustomError( + wrapTextMultiline(res.data.errors[0].message, 90, 1)[0], + res.statusText, + ); + } throw new CustomError( - res.data.errors[0].message || "Could not fetch user", - CustomError.USER_NOT_FOUND, + "Something went wrong while trying to retrieve the stats data using the GraphQL API.", + CustomError.GRAPHQL_ERROR, ); } @@ -185,7 +270,7 @@ async function fetchStats( }); return stats; -} +}; export { fetchStats }; export default fetchStats; diff --git a/src/fetchers/top-languages-fetcher.js b/src/fetchers/top-languages-fetcher.js index 181375d9e66bc..45b2ba7d85183 100644 --- a/src/fetchers/top-languages-fetcher.js +++ b/src/fetchers/top-languages-fetcher.js @@ -1,13 +1,19 @@ // @ts-check -import * as dotenv from "dotenv"; import { retryer } from "../common/retryer.js"; -import { logger, MissingParamError, request } from "../common/utils.js"; - -dotenv.config(); +import { + CustomError, + logger, + MissingParamError, + request, + wrapTextMultiline, +} from "../common/utils.js"; /** - * @param {import('Axios').AxiosRequestHeaders} variables - * @param {string} token + * Top languages fetcher object. + * + * @param {import('Axios').AxiosRequestHeaders} variables Fetcher variables. + * @param {string} token GitHub token. + * @returns {Promise} Languages fetcher response. */ const fetcher = (variables, token) => { return request( @@ -42,11 +48,18 @@ const fetcher = (variables, token) => { }; /** - * @param {string} username - * @param {string[]} exclude_repo - * @returns {Promise} + * Fetch top languages for a given username. + * + * @param {string} username GitHub username. + * @param {string[]} exclude_repo List of repositories to exclude. + * @returns {Promise} Top languages data. */ -async function fetchTopLanguages(username, exclude_repo = []) { +const fetchTopLanguages = async ( + username, + exclude_repo = [], + size_weight = 1, + count_weight = 0, +) => { if (!username) throw new MissingParamError(["username"]); const res = await retryer(fetcher, { login: username }); @@ -56,6 +69,27 @@ async function fetchTopLanguages(username, exclude_repo = []) { throw Error(res.data.errors[0].message || "Could not fetch user"); } + // Catch GraphQL errors. + if (res.data.errors) { + logger.error(res.data.errors); + if (res.data.errors[0].type === "NOT_FOUND") { + throw new CustomError( + res.data.errors[0].message || "Could not fetch user.", + CustomError.USER_NOT_FOUND, + ); + } + if (res.data.errors[0].message) { + throw new CustomError( + wrapTextMultiline(res.data.errors[0].message, 90, 1)[0], + res.statusText, + ); + } + throw new CustomError( + "Something went while trying to retrieve the language data using the GraphQL API.", + CustomError.GRAPHQL_ERROR, + ); + } + let repoNodes = res.data.data.user.repositories.nodes; let repoToHide = {}; @@ -72,6 +106,8 @@ async function fetchTopLanguages(username, exclude_repo = []) { .sort((a, b) => b.size - a.size) .filter((name) => !repoToHide[name.name]); + let repoCount = 0; + repoNodes = repoNodes .filter((node) => node.languages.edges.length > 0) // flatten the list of language nodes @@ -82,9 +118,14 @@ async function fetchTopLanguages(username, exclude_repo = []) { // if we already have the language in the accumulator // & the current language name is same as previous name - // add the size to the language size. + // add the size to the language size and increase repoCount. if (acc[prev.node.name] && prev.node.name === acc[prev.node.name].name) { langSize = prev.size + acc[prev.node.name].size; + repoCount += 1; + } else { + // reset repoCount to 1 + // language must exist in at least one repo to be detected + repoCount = 1; } return { ...acc, @@ -92,10 +133,18 @@ async function fetchTopLanguages(username, exclude_repo = []) { name: prev.node.name, color: prev.node.color, size: langSize, + count: repoCount, }, }; }, {}); + Object.keys(repoNodes).forEach((name) => { + // comparison index calculation + repoNodes[name].size = + Math.pow(repoNodes[name].size, size_weight) * + Math.pow(repoNodes[name].count, count_weight); + }); + const topLangs = Object.keys(repoNodes) .sort((a, b) => repoNodes[b].size - repoNodes[a].size) .reduce((result, key) => { @@ -104,7 +153,7 @@ async function fetchTopLanguages(username, exclude_repo = []) { }, {}); return topLangs; -} +}; export { fetchTopLanguages }; export default fetchTopLanguages; diff --git a/src/fetchers/wakatime-fetcher.js b/src/fetchers/wakatime-fetcher.js index 97adcdc87fc83..fa1f3d890920f 100644 --- a/src/fetchers/wakatime-fetcher.js +++ b/src/fetchers/wakatime-fetcher.js @@ -2,8 +2,10 @@ import axios from "axios"; import { MissingParamError } from "../common/utils.js"; /** - * @param {{username: string, api_domain: string, range: string}} props - * @returns {Promise} + * WakaTime data fetcher. + * + * @param {{username: string, api_domain: string, range: string}} props Fetcher props. + * @returns {Promise} WakaTime data response. */ const fetchWakatimeStats = async ({ username, api_domain, range }) => { if (!username) throw new MissingParamError(["username"]); diff --git a/src/getStyles.js b/src/getStyles.js index 3c77787e7e655..f7b90f4adc7b4 100644 --- a/src/getStyles.js +++ b/src/getStyles.js @@ -1,6 +1,9 @@ // @ts-check /** - * @param {number} value + * Calculates progress along the boundary of the circle i.e it's circumference. + * + * @param {number} value The rank value to calculate progress for. + * @returns {number} Progress value. */ const calculateCircleProgress = (value) => { const radius = 40; @@ -13,9 +16,11 @@ const calculateCircleProgress = (value) => { }; /** + * Retrieves the animation to display progress along the circumference of circle + * from the beginning to the given value in a clockwise direction. * - * @param {{progress: number}} param0 - * @returns + * @param {{progress: number}} progress The progress value to animate to. + * @returns {string} Progress animation css. */ const getProgressAnimation = ({ progress }) => { return ` @@ -30,6 +35,11 @@ const getProgressAnimation = ({ progress }) => { `; }; +/** + * Retrieves css animations for a card. + * + * @returns {string} Animation css. + */ const getAnimations = () => { return ` /* Animations */ @@ -53,18 +63,21 @@ const getAnimations = () => { }; /** - * @param {{ - * titleColor?: string | string[] - * textColor?: string | string[] - * iconColor?: string | string[] - * show_icons?: boolean; - * progress?: number; - * }} args + * Retrieves CSS styles for a card. + * + * @param {Object[]} colors The colors to use for the card. + * @param {string} colors.titleColor The title color. + * @param {string} colors.textColor The text color. + * @param {string} colors.iconColor The icon color. + * @param {boolean} colors.show_icons Whether to show icons. + * @param {number} colors.progress The progress value to animate to. + * @returns {string} Card CSS styles. */ const getStyles = ({ titleColor, textColor, iconColor, + ringColor, show_icons, progress, }) => { @@ -93,13 +106,13 @@ const getStyles = ({ } .rank-circle-rim { - stroke: ${titleColor}; + stroke: ${ringColor}; fill: none; stroke-width: 6; opacity: 0.2; } .rank-circle { - stroke: ${titleColor}; + stroke: ${ringColor}; stroke-dasharray: 250; fill: none; stroke-width: 6; diff --git a/src/index.js b/src/index.js new file mode 100644 index 0000000000000..27577f80f58db --- /dev/null +++ b/src/index.js @@ -0,0 +1,3 @@ +export * from "./common/index.js"; +export * from "./cards/index.js"; +export { getStyles, getAnimations } from "./getStyles.js"; diff --git a/src/translations.js b/src/translations.js index 3f931bc8ee585..45c8295e024de 100644 --- a/src/translations.js +++ b/src/translations.js @@ -1,5 +1,12 @@ import { encodeHTML } from "./common/utils.js"; +/** + * Retrieves stat card labels in the available locales. + * + * @param {string} name The name of the locale. + * @param {string} apostrophe Whether to use apostrophe or not. + * @returns {Object} The locales object. + */ const statCardLocales = ({ name, apostrophe }) => { const encodedName = encodeHTML(name); return { @@ -30,7 +37,7 @@ const statCardLocales = ({ name, apostrophe }) => { sk: `GitHub štatistiky používateľa ${encodedName}`, tr: `${encodedName} Hesabının GitHub Yıldızları`, pl: `Statystyki GitHub użytkownika ${encodedName}`, - uz: `${encodedName}ning Github'dagi statistikasi`, + uz: `${encodedName}ning GitHub'dagi statistikasi`, vi: `Thống Kê GitHub ${encodedName}`, se: `GitHubstatistik för ${encodedName}`, }, @@ -60,7 +67,7 @@ const statCardLocales = ({ name, apostrophe }) => { my: "Jumlah Bintang", sk: "Hviezdy", tr: "Toplam Yıldız", - pl: "Liczba Gwiazdek dostanych", + pl: "Liczba otrzymanych gwiazdek", uz: "Yulduzchalar", vi: "Tổng Số Sao", se: "Antal intjänade stjärnor", @@ -153,7 +160,7 @@ const statCardLocales = ({ name, apostrophe }) => { my: "Jumlah Isu Dilaporkan", sk: "Všetky problémy", tr: "Toplam Hata", - pl: "Wszystkie Issues", + pl: "Wszystkie problemy", uz: "'Issue'lar", vi: "Tổng Số Vấn Đề", se: "Total antal issues", @@ -315,7 +322,7 @@ const wakatimeCardLocales = { my: "Statistik Wakatime", sk: "Wakatime štatistika", tr: "Waketime İstatistikler", - pl: "statystyki Wakatime", + pl: "Statystyki Wakatime", vi: "Thống Kê Wakatime", se: "Wakatime statistik", }, @@ -354,9 +361,15 @@ const wakatimeCardLocales = { const availableLocales = Object.keys(repoCardLocales["repocard.archived"]); -function isLocaleAvailable(locale) { +/** + * Checks whether the locale is available or not. + * + * @param {string} locale The locale to check. + * @returns {boolean} Boolean specifying whether the locale is available or not. + */ +const isLocaleAvailable = (locale) => { return availableLocales.includes(locale.toLowerCase()); -} +}; export { isLocaleAvailable, diff --git a/tests/__snapshots__/renderWakatimeCard.test.js.snap b/tests/__snapshots__/renderWakatimeCard.test.js.snap index dd9ffd318a61a..6dfaf98e9742a 100644 --- a/tests/__snapshots__/renderWakatimeCard.test.js.snap +++ b/tests/__snapshots__/renderWakatimeCard.test.js.snap @@ -51,13 +51,13 @@ exports[`Test Render Wakatime Card should render correctly with compact layout 1 } .rank-circle-rim { - stroke: #2f80ed; + stroke: undefined; fill: none; stroke-width: 6; opacity: 0.2; } .rank-circle { - stroke: #2f80ed; + stroke: undefined; stroke-dasharray: 250; fill: none; stroke-width: 6; @@ -69,7 +69,209 @@ exports[`Test Render Wakatime Card should render correctly with compact layout 1 } + @keyframes slideInAnimation { + from { + width: 0; + } + to { + width: calc(100%-100px); + } + } + @keyframes growWidthAnimation { + from { + width: 0; + } + to { + width: 100%; + } + } + .lang-name { font: 400 11px 'Segoe UI', Ubuntu, Sans-Serif; fill: #434d58 } + #rect-mask rect{ + animation: slideInAnimation 1s ease-in-out forwards; + } + .lang-progress{ + animation: growWidthAnimation 0.6s ease-in-out forwards; + } + + + + + + + + + + + + + + Wakatime Stats + + + + + + + + + + + + + + + + + + + + + Other - 19 mins + + + + + + + TypeScript - 1 min + + + + + + + + + " +`; + +exports[`Test Render Wakatime Card should render correctly with compact layout when langs_count is set 1`] = ` +" + + + +