Update readme.md

* Add support for hide_progress in top languages feature

* Fix mistake

* Add documents for all languages

* Remove unnecessary value check

* Update top-languages-card.js

* Revert document for all languages except English

* Update documentation

* Update documentation

---------

Co-authored-by: Zohan Subhash <zohan.subhash@gmail.com>

.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"

api/status/pat-info.js

@@ -6,7 +6,7 @@
  */
 
 import { logger, request, dateDiff } from "../../src/common/utils.js";
-export const RATE_LIMIT_SECONDS = 60 * 10; // 1 request per 10 minutes
+export const RATE_LIMIT_SECONDS = 60 * 5; // 1 request per 10 minutes
 
 /**
  * Simple uptime check fetcher for the PATs.
@@ -98,12 +98,20 @@ const getPATInfo = async (fetcher, variables) => {
     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"),
+    exhaustedPATs: filterPATsByStatus("exhausted"),
+    suspendedPATs: filterPATsByStatus("suspended"),
     errorPATs: filterPATsByStatus("error"),
-    details,
+    details: sortedDetails,
   };
 };
 

api/top-langs.js

@@ -30,6 +30,7 @@ export default async (req, res) => {
     border_radius,
     border_color,
     disable_animations,
+    hide_progress,
   } = req.query;
   res.setHeader("Content-Type", "image/svg+xml");
 
@@ -77,6 +78,7 @@ export default async (req, res) => {
         border_color,
         locale: locale ? locale.toLowerCase() : null,
         disable_animations: parseBoolean(disable_animations),
+        hide_progress: parseBoolean(hide_progress),
       }),
     );
   } catch (err) {

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)

readme.md

@@ -92,7 +92,9 @@ Visit <https://indiafightscorona.giveindia.org> and make a small donation to hel
     -   [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)
+-   [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
@@ -305,6 +307,7 @@ You can provide multiple comma-separated values in the bg_color option to render
 -   `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`.
 
 > **Warning**
 > Language names should be URI-escaped, as specified in [Percent Encoding](https://en.wikipedia.org/wiki/Percent-encoding)
@@ -398,6 +401,14 @@ 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)
@@ -406,6 +417,10 @@ 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)
 
+- 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.
@@ -496,7 +511,9 @@ By default, GitHub does not lay out the cards side by side. To do that, you can
 </a>
 ```
 
-## Deploy on your own Vercel instance
+## Deploy on your own
+
+### On Vercel
 
 #### :film_projector: [Check Out Step By Step Video Tutorial By @codeSTACKr](https://youtu.be/n6d4KHSKqGk?t=107)
 
@@ -533,6 +550,23 @@ Since the GitHub API only allows 5k requests per hour, my `https://github-readme
 
 </details>
 
+### 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.
+
+<details>
+<summary><b>:hammer_and_wrench: Step-by-step guide for deploying on other platforms</b></summary>
+
+1. Fork or clone this repo as per your needs
+2. Add `express` to the dependencies section of `package.json`
+https://github.com/anuraghazra/github-readme-stats/blob/ba7c2f8b55eac8452e479c8bd38b044d204d0424/package.json#L54-L61
+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
+https://github.com/anuraghazra/github-readme-stats/blob/ba7c2f8b55eac8452e479c8bd38b044d204d0424/package.json#L11
+5. You're done 🎉
+</details>
+
 ### 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.

src/cards/top-languages-card.js

@@ -76,10 +76,11 @@ const createProgressTextNode = ({ width, color, name, progress, index }) => {
  * @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, index }) => {
+const createCompactLangNode = ({ lang, totalSize, hideProgress, index }) => {
   const percentage = ((lang.size / totalSize) * 100).toFixed(2);
   const staggerDelay = (index + 3) * 150;
   const color = lang.color || "#858585";
@@ -88,7 +89,7 @@ const createCompactLangNode = ({ lang, totalSize, index }) => {
     <g class="stagger" style="animation-delay: ${staggerDelay}ms">
       <circle cx="5" cy="6" r="5" fill="${color}" />
       <text data-testid="lang-name" x="15" y="10" class='lang-name'>
-        ${lang.name} ${percentage}%
+        ${lang.name} ${hideProgress ? "" : percentage + "%"}
       </text>
     </g>
   `;
@@ -100,9 +101,10 @@ const createCompactLangNode = ({ lang, totalSize, index }) => {
  * @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) => {
@@ -111,6 +113,7 @@ const createLanguageTextNode = ({ langs, totalSize }) => {
       createCompactLangNode({
         lang,
         totalSize,
+        hideProgress,
         index,
       }),
     );
@@ -160,9 +163,10 @@ const renderNormalLayout = (langs, width, totalLanguageSize) => {
  * @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
@@ -193,15 +197,21 @@ const renderCompactLayout = (langs, width, totalLanguageSize) => {
     .join("");
 
   return `
-    <mask id="rect-mask">
+  ${
+    !hideProgress
+      ? `
+  <mask id="rect-mask">
       <rect x="0" y="0" width="${offsetWidth}" height="8" fill="white" rx="5"/>
     </mask>
     ${compactProgressBar}
-
+  `
-    <g transform="translate(0, 25)">
+      : ""
+  }
+    <g transform="translate(0, ${hideProgress ? "0" : "25"})">
       ${createLanguageTextNode({
         langs,
         totalSize: totalLanguageSize,
+        hideProgress: hideProgress,
       })}
     </g>
   `;
@@ -276,6 +286,7 @@ const renderTopLanguages = (topLangs, options = {}) => {
     text_color,
     bg_color,
     hide,
+    hide_progress,
     theme,
     layout,
     custom_title,
@@ -305,11 +316,17 @@ const renderTopLanguages = (topLangs, options = {}) => {
   let height = calculateNormalLayoutHeight(langs.length);
 
   let finalLayout = "";
-  if (layout === "compact") {
+  if (layout === "compact" || hide_progress == true) {
     width = width + 50; // padding
-    height = calculateCompactLayoutHeight(langs.length);
+    height =
+      calculateCompactLayoutHeight(langs.length) + (hide_progress ? -25 : 0);
 
-    finalLayout = renderCompactLayout(langs, width, totalLanguageSize);
+    finalLayout = renderCompactLayout(
+      langs,
+      width,
+      totalLanguageSize,
+      hide_progress,
+    );
   } else {
     finalLayout = renderNormalLayout(langs, width, totalLanguageSize);
   }

src/cards/types.d.ts

@@ -38,6 +38,7 @@ export type TopLangOptions = CommonOptions & {
   custom_title: string;
   langs_count: number;
   disable_animations: boolean;
+  hide_progress: boolean;
 };
 
 type WakaTimeOptions = CommonOptions & {

src/common/languageColors.json

@@ -102,6 +102,7 @@
     "Csound Score": "#1a1a1a",
     "Cuda": "#3A4E3A",
     "Curry": "#531242",
+    "Cypher": "#34c0eb",
     "Cython": "#fedf5b",
     "D": "#ba595e",
     "DM": "#447265",
@@ -124,6 +125,7 @@
     "Earthly": "#2af0ff",
     "Easybuild": "#069406",
     "Ecere Projects": "#913960",
+    "Ecmarkup": "#eb8131",
     "EditorConfig": "#fff1f2",
     "Eiffel": "#4d6977",
     "Elixir": "#6e4a7e",
@@ -215,6 +217,7 @@
     "Idris": "#b30000",
     "Ignore List": "#000000",
     "ImageJ Macro": "#99AAFF",
+    "Imba": "#16cec6",
     "Inno Setup": "#264b99",
     "Io": "#a9188d",
     "Ioke": "#078193",
@@ -286,6 +289,7 @@
     "Mathematica": "#dd1100",
     "Max": "#c4a79c",
     "Mercury": "#ff2b2b",
+    "Mermaid": "#ff3670",
     "Meson": "#007800",
     "Metal": "#8f14e9",
     "MiniYAML": "#ff1111",
@@ -318,6 +322,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 +335,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",
@@ -351,6 +363,7 @@
     "PigLatin": "#fcd7de",
     "Pike": "#005390",
     "PogoScript": "#d80074",
+    "Polar": "#ae81ff",
     "Portugol": "#f8bd00",
     "PostCSS": "#dc3a0c",
     "PostScript": "#da291c",
@@ -414,6 +427,7 @@
     "Sass": "#a53b70",
     "Scala": "#c22d40",
     "Scaml": "#bd181a",
+    "Scenic": "#fdc700",
     "Scheme": "#1e4aec",
     "Scilab": "#ca0f21",
     "Self": "#0579aa",
@@ -421,6 +435,7 @@
     "Shell": "#89e051",
     "ShellCheck Config": "#cecfcb",
     "Shen": "#120F14",
+    "Simple File Verification": "#C9BFED",
     "Singularity": "#64E6AD",
     "Slash": "#007eff",
     "Slice": "#003fa2",
@@ -428,6 +443,7 @@
     "SmPL": "#c94949",
     "Smalltalk": "#596706",
     "Smarty": "#f0c040",
+    "Smithy": "#c44536",
     "Solidity": "#AA6746",
     "SourcePawn": "#f69e1d",
     "Squirrel": "#800000",
@@ -478,6 +494,7 @@
     "Vim Script": "#199f4b",
     "Vim Snippet": "#199f4b",
     "Visual Basic .NET": "#945db7",
+    "Visual Basic 6.0": "#2c6353",
     "Volt": "#1F1F1F",
     "Vue": "#41b883",
     "Vyper": "#2980b9",
@@ -514,6 +531,7 @@
     "fish": "#4aae47",
     "hoon": "#00b171",
     "jq": "#c7254e",
+    "just": "#384d54",
     "kvlang": "#1da6e0",
     "mIRC Script": "#3d57c3",
     "mcfunction": "#E22837",

tests/pat-info.test.js

@@ -88,7 +88,8 @@ describe("Test /api/status/pat-info", () => {
         {
           validPATs: ["PAT_2", "PAT_3", "PAT_4"],
           expiredPATs: [],
-          exhaustedPATS: ["PAT_1"],
+          exhaustedPATs: ["PAT_1"],
+          suspendedPATs: [],
           errorPATs: [],
           details: {
             PAT_1: {
@@ -132,7 +133,8 @@ describe("Test /api/status/pat-info", () => {
         {
           validPATs: ["PAT_2", "PAT_3", "PAT_4"],
           expiredPATs: [],
-          exhaustedPATS: [],
+          exhaustedPATs: [],
+          suspendedPATs: [],
           errorPATs: ["PAT_1"],
           details: {
             PAT_1: {
@@ -178,7 +180,8 @@ describe("Test /api/status/pat-info", () => {
         {
           validPATs: ["PAT_2", "PAT_3", "PAT_4"],
           expiredPATs: ["PAT_1"],
-          exhaustedPATS: [],
+          exhaustedPATs: [],
+          suspendedPATs: [],
           errorPATs: [],
           details: {
             PAT_1: {

themes/index.js

@@ -374,6 +374,13 @@ export const themes = {
     border_color: "170F0C",
     bg_color: "170F0C",
   },
+  rose: {
+    title_color: "8d192b",
+    text_color: "862931",
+    icon_color: "B71F36",
+    border_color: "e9d8d4",
+    bg_color: "e9d8d4",
+  },
 };
 
 export default themes;