fix: readme generation script

fix: workflow file
fix: readme generate script 'Add new theme' table item
2020-07-27 22:22:38 +05:30 · 2020-07-26 14:32:17 +05:30 · 2020-07-26 14:24:13 +05:30 · 2020-07-26 14:11:30 +05:30 · 2020-07-26 13:15:11 +05:30 · 2020-07-26 13:10:35 +05:30
6 changed files with 230 additions and 45 deletions
@@ -0,0 +1,35 @@
+name: Generate Theme Readme
+
+on:
+  push:
+    branches:
+      - master
+    paths:
+      - "themes/index.js"
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v1
+      - name: setup node
+        uses: actions/setup-node@v1
+        with:
+          node-version: "12.x"
+
+      - name: npm install, generate readme
+        run: |
+          npm install
+          npm run theme-readme-gen
+        env:
+          CI: true
+
+      - name: Run Script
+        uses: skx/github-action-tester@master
+        with:
+          script: ./push-theme-readme.sh
+        env:
+          CI: true
+          PERSONAL_TOKEN: ${{ secrets.PERSONAL_TOKEN }}
+          GH_REPO: ${{ secrets.GH_REPO }}
@@ -5,7 +5,8 @@
  "main": "index.js",
  "scripts": {
    "test": "jest --coverage",
-    "test:watch": "jest --watch"
+    "test:watch": "jest --watch",
+    "theme-readme-gen": "node scripts/generate-theme-doc"
  },
  "author": "Anurag Hazra",
  "license": "MIT",
@@ -0,0 +1,115 @@
+const theme = require("../themes/index");
+const fs = require("fs");
+
+const TARGET_FILE = "./themes/README.md";
+const REPO_CARD_LINKS_FLAG = "<!-- REPO_CARD_LINKS -->";
+const STAT_CARD_LINKS_FLAG = "<!-- STATS_CARD_LINKS -->";
+
+const STAT_CARD_TABLE_FLAG = "<!-- STATS_CARD_TABLE -->";
+const REPO_CARD_TABLE_FLAG = "<!-- REPO_CARD_TABLE -->";
+
+const THEME_TEMPLATE = `## Available Themes
+
+<!-- DO NOT EDIT THIS FILE DIRECTLY -->
+
+With inbuilt themes you can customize the look of the card without doing any manual customization.
+
+Use \`?theme=THEME_NAME\` parameter like so :-
+
+\`\`\`md
+![Anurag's github stats](https://github-readme-stats.vercel.app/api?username=anuraghazra&theme=dark&show_icons=true)
+\`\`\`
+
+## Stats
+
+> These themes work both for the Stats Card and Repo Card.
+
+| | | |
+| :--: | :--: | :--: |
+${STAT_CARD_TABLE_FLAG}
+
+## Repo Card
+
+> These themes work both for the Stats Card and Repo Card.
+
+| | | |
+| :--: | :--: | :--: |
+${REPO_CARD_TABLE_FLAG}
+
+${STAT_CARD_LINKS_FLAG}
+
+${REPO_CARD_LINKS_FLAG}
+
+
+[add-theme]: https://github.com/anuraghazra/github-readme-stats/edit/master/themes/index.js
+
+Wanted to add a new theme? Consider reading the [contribution guidelines](../CONTRIBUTING.md#themes-contribution) :D
+`;
+
+const createRepoMdLink = (theme) => {
+  return `\n[${theme}_repo]: https://github-readme-stats.vercel.app/api/pin/?username=anuraghazra&repo=github-readme-stats&cache_seconds=86400&theme=${theme}`;
+};
+const createStatMdLink = (theme) => {
+  return `\n[${theme}]: https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true&hide=contribs,prs&cache_seconds=86400&theme=${theme}`;
+};
+
+const generateLinks = (fn) => {
+  return Object.keys(theme)
+    .map((name) => fn(name))
+    .join("");
+};
+
+const createTableItem = ({ link, label, isRepoCard }) => {
+  if (!link || !label) return "";
+  return `\`${label}\` ![${link}][${link}${isRepoCard ? "_repo" : ""}]`;
+};
+const generateTable = ({ isRepoCard }) => {
+  const rows = [];
+  const themes = Object.keys(theme).filter(
+    (name) => name !== (!isRepoCard ? "default_repocard" : "default")
+  );
+
+  for (let i = 0; i < themes.length; i += 3) {
+    const one = themes[i];
+    const two = themes[i + 1];
+    const three = themes[i + 2];
+
+    let tableItem1 = createTableItem({ link: one, label: one, isRepoCard });
+    let tableItem2 = createTableItem({ link: two, label: two, isRepoCard });
+    let tableItem3 = createTableItem({ link: three, label: three, isRepoCard });
+
+    if (three === undefined) {
+      tableItem3 = `[Add your theme][add-theme]`;
+    }
+    rows.push(`| ${tableItem1} | ${tableItem2} | ${tableItem3} |`);
+
+    // if it's the last row & the row has no empty space push a new row
+    if (three && i + 3 === themes.length) {
+      rows.push(`| [Add your theme][add-theme] | | |`);
+    }
+  }
+
+  return rows.join("\n");
+};
+
+const buildReadme = () => {
+  return THEME_TEMPLATE.split("\n")
+    .map((line) => {
+      if (line.includes(REPO_CARD_LINKS_FLAG)) {
+        return generateLinks(createRepoMdLink);
+      }
+      if (line.includes(STAT_CARD_LINKS_FLAG)) {
+        return generateLinks(createStatMdLink);
+      }
+      if (line.includes(REPO_CARD_TABLE_FLAG)) {
+        return generateTable({ isRepoCard: true });
+      }
+      if (line.includes(STAT_CARD_TABLE_FLAG)) {
+        return generateTable({ isRepoCard: false });
+      }
+      return line;
+    })
+    .join("\n");
+};
+
+fs.writeFileSync(TARGET_FILE, buildReadme());
@@ -0,0 +1,14 @@
+#!/bin/bash
+set -x
+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 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 remote add origin-$BRANCH_NAME https://${PERSONAL_TOKEN}@github.com/${GH_REPO}.git
+git push --force --quiet --set-upstream origin-$BRANCH_NAME $BRANCH_NAME
@@ -1,68 +1,82 @@
 ## Available Themes

+<!-- DO NOT EDIT THIS FILE DIRECTLY -->
+
 With inbuilt themes you can customize the look of the card without doing any manual customization.

 Use `?theme=THEME_NAME` parameter like so :-

 ```md
-![Anurag's github stats](https://github-readme-stats.vercel.app/api?username=anuraghazra&theme=dark&show_icons=true
+![Anurag's github stats](https://github-readme-stats.vercel.app/api?username=anuraghazra&theme=dark&show_icons=true)
 ```

 ## Stats

 > These themes work both for the Stats Card and Repo Card.

-|                               |                                        |                                              |
-| :---------------------------: | :------------------------------------: | :------------------------------------------: |
-| `default` ![default][default] |     `radical` ![radical][radical]      |           `merko` ![merko][merko]            |
-| `gruvbox` ![gruvbox][gruvbox] | `tokyonight` ![tokyonight][tokyonight] |        `onedark` ![onedark][onedark]         |
-|  `cobalt` ![cobalt][cobalt]   |  `synthwave` ![synthwave][synthwave]   | `highcontrast` ![highcontrast][highcontrast] |
-| `dracula` ![dracula][dracula] |          `dark` ![dark][dark]          |      `prussian` ![prussian][prussian]        |
-| [Add your theme][add-theme]   |||
+| | | |
+| :--: | :--: | :--: |
+| `default` ![default][default] | `dark` ![dark][dark] | `radical` ![radical][radical] |
+| `merko` ![merko][merko] | `gruvbox` ![gruvbox][gruvbox] | `tokyonight` ![tokyonight][tokyonight] |
+| `onedark` ![onedark][onedark] | `cobalt` ![cobalt][cobalt] | `synthwave` ![synthwave][synthwave] |
+| `highcontrast` ![highcontrast][highcontrast] | `dracula` ![dracula][dracula] | `prussian` ![prussian][prussian] |
+| `monokai` ![monokai][monokai] | `vue` ![vue][vue] | `shades-of-purple` ![shades-of-purple][shades-of-purple] |
+| `nightowl` ![nightowl][nightowl] | `buefy` ![buefy][buefy] | [Add your theme][add-theme] |

 ## Repo Card

 > These themes work both for the Stats Card and Repo Card.

-|                                                          |                                                 |                                                       |
-| :------------------------------------------------------: | :---------------------------------------------: | :---------------------------------------------------: |
-| `default_repocard` ![default_repocard][default_repocard] |     `radical` ![radical][radical_repocard]      |           `merko` ![merko][merko_repocard]            |
-|          `gruvbox` ![gruvbox][gruvbox_repocard]          | `tokyonight` ![tokyonight][tokyonight_repocard] |        `onedark` ![onedark][onedark_repocard]         |
-|           `cobalt` ![cobalt][cobalt_repocard]            |  `synthwave` ![synthwave][synthwave_repocard]   | `highcontrast` ![highcontrast][highcontrast_repocard] |
-|          `dracula` ![dracula][dracula_repocard]          |     `dark` ![dark_repocard][dark_repocard]      |  `prussian` ![prussian_repocard][prussian_repocard]         |
-| [Add your theme][add-theme]   |||
+| | | |
+| :--: | :--: | :--: |
+| `default_repocard` ![default_repocard][default_repocard_repo] | `dark` ![dark][dark_repo] | `radical` ![radical][radical_repo] |
+| `merko` ![merko][merko_repo] | `gruvbox` ![gruvbox][gruvbox_repo] | `tokyonight` ![tokyonight][tokyonight_repo] |
+| `onedark` ![onedark][onedark_repo] | `cobalt` ![cobalt][cobalt_repo] | `synthwave` ![synthwave][synthwave_repo] |
+| `highcontrast` ![highcontrast][highcontrast_repo] | `dracula` ![dracula][dracula_repo] | `prussian` ![prussian][prussian_repo] |
+| `monokai` ![monokai][monokai_repo] | `vue` ![vue][vue_repo] | `shades-of-purple` ![shades-of-purple][shades-of-purple_repo] |
+| `nightowl` ![nightowl][nightowl_repo] | `buefy` ![buefy][buefy_repo] | [Add your theme][add-theme] |


-<!-- Repo Card Theme previews -->
+[default]: https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true&hide=contribs,prs&cache_seconds=86400&theme=default
+[default_repocard]: https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true&hide=contribs,prs&cache_seconds=86400&theme=default_repocard
+[dark]: https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true&hide=contribs,prs&cache_seconds=86400&theme=dark
+[radical]: https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true&hide=contribs,prs&cache_seconds=86400&theme=radical
+[merko]: https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true&hide=contribs,prs&cache_seconds=86400&theme=merko
+[gruvbox]: https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true&hide=contribs,prs&cache_seconds=86400&theme=gruvbox
+[tokyonight]: https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true&hide=contribs,prs&cache_seconds=86400&theme=tokyonight
+[onedark]: https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true&hide=contribs,prs&cache_seconds=86400&theme=onedark
+[cobalt]: https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true&hide=contribs,prs&cache_seconds=86400&theme=cobalt
+[synthwave]: https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true&hide=contribs,prs&cache_seconds=86400&theme=synthwave
+[highcontrast]: https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true&hide=contribs,prs&cache_seconds=86400&theme=highcontrast
+[dracula]: https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true&hide=contribs,prs&cache_seconds=86400&theme=dracula
+[prussian]: https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true&hide=contribs,prs&cache_seconds=86400&theme=prussian
+[monokai]: https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true&hide=contribs,prs&cache_seconds=86400&theme=monokai
+[vue]: https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true&hide=contribs,prs&cache_seconds=86400&theme=vue
+[shades-of-purple]: https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true&hide=contribs,prs&cache_seconds=86400&theme=shades-of-purple
+[nightowl]: https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true&hide=contribs,prs&cache_seconds=86400&theme=nightowl
+[buefy]: https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true&hide=contribs,prs&cache_seconds=86400&theme=buefy

-[default_repocard]: https://github-readme-stats.vercel.app/api/pin/?username=anuraghazra&repo=github-readme-stats&cache_seconds=86400&theme=default_repocard
-[dark_repocard]: https://github-readme-stats.vercel.app/api/pin/?username=anuraghazra&repo=github-readme-stats&cache_seconds=86400&theme=dark
-[radical_repocard]: https://github-readme-stats.vercel.app/api/pin/?username=anuraghazra&repo=github-readme-stats&cache_seconds=86400&theme=radical
-[merko_repocard]: https://github-readme-stats.vercel.app/api/pin/?username=anuraghazra&repo=github-readme-stats&cache_seconds=86400&theme=merko
-[gruvbox_repocard]: https://github-readme-stats.vercel.app/api/pin/?username=anuraghazra&repo=github-readme-stats&cache_seconds=86400&theme=gruvbox
-[cobalt_repocard]: https://github-readme-stats.vercel.app/api/pin/?username=anuraghazra&repo=github-readme-stats&cache_seconds=86400&theme=cobalt
-[dark_repocard]: https://github-readme-stats.vercel.app/api/pin/?username=anuraghazra&repo=github-readme-stats&cache_seconds=86400&theme=dark
-[dracula_repocard]: https://github-readme-stats.vercel.app/api/pin/?username=anuraghazra&repo=github-readme-stats&cache_seconds=86400&theme=dracula
-[tokyonight_repocard]: https://github-readme-stats.vercel.app/api/pin/?username=anuraghazra&repo=github-readme-stats&cache_seconds=86400&theme=tokyonight
-[synthwave_repocard]: https://github-readme-stats.vercel.app/api/pin/?username=anuraghazra&repo=github-readme-stats&cache_seconds=86400&theme=synthwave
-[onedark_repocard]: https://github-readme-stats.vercel.app/api/pin/?username=anuraghazra&repo=github-readme-stats&cache_seconds=86400&theme=onedark
-[highcontrast_repocard]: https://github-readme-stats.vercel.app/api/pin/?username=anuraghazra&repo=github-readme-stats&cache_seconds=86400&theme=highcontrast
-[prussian_repocard]: https://github-readme-stats.vercel.app/api/pin/?username=anuraghazra&repo=github-readme-stats&cache_seconds=86400&theme=prussian

-<!-- Stats Theme previews -->
-
-[default]: https://github-readme-stats.vercel.app/api?username=anuraghazra&theme=default&hide=["contribs","prs"]&cache_seconds=86400
-[dark]: https://github-readme-stats.vercel.app/api?username=anuraghazra&theme=dark&hide=["contribs","prs"]&cache_seconds=86400
-[radical]: https://github-readme-stats.vercel.app/api?username=anuraghazra&theme=radical&hide=["contribs","prs"]&cache_seconds=86400
-[merko]: https://github-readme-stats.vercel.app/api?username=anuraghazra&theme=merko&hide=["contribs","prs"]&cache_seconds=86400
-[gruvbox]: https://github-readme-stats.vercel.app/api?username=anuraghazra&theme=gruvbox&hide=["contribs","prs"]&cache_seconds=86400
-[tokyonight]: https://github-readme-stats.vercel.app/api?username=anuraghazra&theme=tokyonight&hide=["contribs","prs"]&cache_seconds=86400
-[onedark]: https://github-readme-stats.vercel.app/api?username=anuraghazra&theme=onedark&hide=["contribs","prs"]&cache_seconds=86400
-[cobalt]: https://github-readme-stats.vercel.app/api?username=anuraghazra&theme=cobalt&hide=["contribs","prs"]&cache_seconds=86400
-[synthwave]: https://github-readme-stats.vercel.app/api?username=anuraghazra&theme=synthwave&hide=["contribs","prs"]&cache_seconds=86400
-[highcontrast]: https://github-readme-stats.vercel.app/api?username=anuraghazra&theme=highcontrast&hide=["contribs","prs"]&cache_seconds=86400
-[dracula]: https://github-readme-stats.vercel.app/api?username=anuraghazra&theme=dracula&hide=["contribs","prs"]&cache_seconds=86400
-[prussian]: https://github-readme-stats.vercel.app/api?username=anuraghazra&theme=prussian&hide=["contribs","prs"]&cache_seconds=86400
+[default_repo]: https://github-readme-stats.vercel.app/api/pin/?username=anuraghazra&repo=github-readme-stats&cache_seconds=86400&theme=default
+[default_repocard_repo]: https://github-readme-stats.vercel.app/api/pin/?username=anuraghazra&repo=github-readme-stats&cache_seconds=86400&theme=default_repocard
+[dark_repo]: https://github-readme-stats.vercel.app/api/pin/?username=anuraghazra&repo=github-readme-stats&cache_seconds=86400&theme=dark
+[radical_repo]: https://github-readme-stats.vercel.app/api/pin/?username=anuraghazra&repo=github-readme-stats&cache_seconds=86400&theme=radical
+[merko_repo]: https://github-readme-stats.vercel.app/api/pin/?username=anuraghazra&repo=github-readme-stats&cache_seconds=86400&theme=merko
+[gruvbox_repo]: https://github-readme-stats.vercel.app/api/pin/?username=anuraghazra&repo=github-readme-stats&cache_seconds=86400&theme=gruvbox
+[tokyonight_repo]: https://github-readme-stats.vercel.app/api/pin/?username=anuraghazra&repo=github-readme-stats&cache_seconds=86400&theme=tokyonight
+[onedark_repo]: https://github-readme-stats.vercel.app/api/pin/?username=anuraghazra&repo=github-readme-stats&cache_seconds=86400&theme=onedark
+[cobalt_repo]: https://github-readme-stats.vercel.app/api/pin/?username=anuraghazra&repo=github-readme-stats&cache_seconds=86400&theme=cobalt
+[synthwave_repo]: https://github-readme-stats.vercel.app/api/pin/?username=anuraghazra&repo=github-readme-stats&cache_seconds=86400&theme=synthwave
+[highcontrast_repo]: https://github-readme-stats.vercel.app/api/pin/?username=anuraghazra&repo=github-readme-stats&cache_seconds=86400&theme=highcontrast
+[dracula_repo]: https://github-readme-stats.vercel.app/api/pin/?username=anuraghazra&repo=github-readme-stats&cache_seconds=86400&theme=dracula
+[prussian_repo]: https://github-readme-stats.vercel.app/api/pin/?username=anuraghazra&repo=github-readme-stats&cache_seconds=86400&theme=prussian
+[monokai_repo]: https://github-readme-stats.vercel.app/api/pin/?username=anuraghazra&repo=github-readme-stats&cache_seconds=86400&theme=monokai
+[vue_repo]: https://github-readme-stats.vercel.app/api/pin/?username=anuraghazra&repo=github-readme-stats&cache_seconds=86400&theme=vue
+[shades-of-purple_repo]: https://github-readme-stats.vercel.app/api/pin/?username=anuraghazra&repo=github-readme-stats&cache_seconds=86400&theme=shades-of-purple
+[nightowl_repo]: https://github-readme-stats.vercel.app/api/pin/?username=anuraghazra&repo=github-readme-stats&cache_seconds=86400&theme=nightowl
+[buefy_repo]: https://github-readme-stats.vercel.app/api/pin/?username=anuraghazra&repo=github-readme-stats&cache_seconds=86400&theme=buefy


 [add-theme]: https://github.com/anuraghazra/github-readme-stats/edit/master/themes/index.js
+
+Wanted to add a new theme? Consider reading the [contribution guidelines](../CONTRIBUTING.md#themes-contribution) :D
@@ -91,7 +91,7 @@ const themes = {
  },
  "shades-of-purple": {
    title_color: "FAD000",
-    icon_color: "FB94FF",
+    icon_color: "B362FF",
    text_color: "A599E9",
    bg_color: "2D2B55",
  },
@@ -101,6 +101,12 @@ const themes = {
    text_color: "7FDBCA",
    bg_color: "011627",
  },
+  buefy: {
+    title_color: "7957d5",
+    icon_color: "ff3860",
+    text_color: "363636",
+    bg_color: "ffffff",
+  },
 };

 module.exports = themes;
Author	SHA1	Message	Date
anuraghazra	5076d88a34	fix: readme generation script Test / build (push) Canceled after 0s Details	2020-07-27 22:22:38 +05:30
anuraghazra	1f79d503bd	fix: workflow file	2020-07-26 14:32:17 +05:30
anuraghazra	ef57cc7dcf	fix: readme generate script 'Add new theme' table item	2020-07-26 14:24:13 +05:30
anuraghazra	f0a0dfe51c	infra: added auto theme readme generator script	2020-07-26 14:11:30 +05:30
anuraghazra	7f220bb072	docs: updated & fixed themes.md	2020-07-26 13:15:11 +05:30
Ming Tsai	57cf490e3e	style(themes): add buefy theme (#193 ) * styles(themes): add buefy configuration * docs(theme): update table * docs: add missing parentheses on the example	2020-07-26 13:10:35 +05:30
Ahmad Awais ⚡️	6d1b1e220c	👌 IMPROVE: Shades of Purple Icon color (#190 ) Looks like this https://github-readme-stats.vercel.app/api?username=maedahbatool&show_icons=true&theme=shades-of-purple&icon_color=B362FF	2020-07-25 20:56:23 +05:30
Anurag Hazra	662ae95b02	docs: updated themes table	2020-07-25 20:54:46 +05:30
Anurag HazraandVasu Gamdha	e38df2932c	docs: added CONTRIBUTING.md (#188 ) * Create CONTRIBUTING.md * docs: added contributing.md Co-authored-by: Vasu Gamdha <40864108+vasugamdha@users.noreply.github.com>	2020-07-25 20:34:42 +05:30