build: create npm package

This commit makes sure that the common modules of the GRS package can be
imported as an npm package.

Author: rickstaa

.github/labeler.yml

@@ -1,3 +1,3 @@
 themes: themes/index.js
 doc-translation: docs/*
-card-i18n: src/translations.js
+card-i18n: src/assets/translations.js

api/index.js

@@ -9,7 +9,7 @@ import {
   renderError,
 } from "../src/common/utils.js";
 import { fetchStats } from "../src/fetchers/stats-fetcher.js";
-import { isLocaleAvailable } from "../src/translations.js";
+import { isLocaleAvailable } from "../src/assets/translations.js";
 
 dotenv.config();
 

api/pin.js

@@ -7,7 +7,7 @@ import {
   renderError,
 } from "../src/common/utils.js";
 import { fetchRepo } from "../src/fetchers/repo-fetcher.js";
-import { isLocaleAvailable } from "../src/translations.js";
+import { isLocaleAvailable } from "../src/assets/translations.js";
 
 export default async (req, res) => {
   const {

api/top-langs.js

@@ -9,7 +9,7 @@ import {
   renderError,
 } from "../src/common/utils.js";
 import { fetchTopLanguages } from "../src/fetchers/top-languages-fetcher.js";
-import { isLocaleAvailable } from "../src/translations.js";
+import { isLocaleAvailable } from "../src/assets/translations.js";
 
 dotenv.config();
 

api/wakatime.js

@@ -8,7 +8,7 @@ import {
   renderError,
 } from "../src/common/utils.js";
 import { fetchWakatimeStats } from "../src/fetchers/wakatime-fetcher.js";
-import { isLocaleAvailable } from "../src/translations.js";
+import { isLocaleAvailable } from "../src/assets/translations.js";
 
 dotenv.config();
 

package.json

@@ -1,9 +1,23 @@
 {
   "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",

src/translations.js renamed to src/assets/translations.js

@@ -1,4 +1,4 @@
-import { encodeHTML } from "./common/utils.js";
+import { encodeHTML } from "../common/utils.js";
 
 const statCardLocales = ({ name, apostrophe }) => {
   const encodedName = encodeHTML(name);

src/cards/repo-card.js

@@ -11,7 +11,7 @@ import {
   parseEmojis,
   wrapTextMultiline,
 } from "../common/utils.js";
-import { repoCardLocales } from "../translations.js";
+import { repoCardLocales } from "../assets/translations.js";
 
 /**
  * @param {string} label

src/cards/stats-card.js

@@ -9,8 +9,8 @@ import {
   kFormatter,
   measureText,
 } from "../common/utils.js";
-import { getStyles } from "../getStyles.js";
-import { statCardLocales } from "../translations.js";
+import { getStyles } from "../common/getStyles.js";
+import { statCardLocales } from "../assets/translations.js";
 
 /**
  * Create a stats card text item.

src/cards/top-languages-card.js

@@ -10,7 +10,7 @@ import {
   lowercaseTrim,
   measureText,
 } from "../common/utils.js";
-import { langCardLocales } from "../translations.js";
+import { langCardLocales } from "../assets/translations.js";
 
 const DEFAULT_CARD_WIDTH = 300;
 const MIN_CARD_WIDTH = 230;

src/cards/wakatime-card.js

@@ -8,8 +8,8 @@ import {
   getCardColors,
   lowercaseTrim,
 } from "../common/utils.js";
-import { getStyles } from "../getStyles.js";
-import { wakatimeCardLocales } from "../translations.js";
+import { getStyles } from "../common/getStyles.js";
+import { wakatimeCardLocales } from "../assets/translations.js";
 
 /** Import language colors.
  *

src/common/Card.js

@@ -1,4 +1,4 @@
-import { getAnimations } from "../getStyles.js";
+import { getAnimations } from "./getStyles.js";
 import { encodeHTML, flexLayout } from "./utils.js";
 
 class Card {

src/getStyles.js renamed to src/common/getStyles.js

@@ -0,0 +1,29 @@
+export { blacklist } from "./blacklist.js";
+export { Card } from "./Card.js";
+export { createProgressNode } from "./createProgressNode.js";
+export { getStyles, getAnimations } from "./getStyles.js";
+export { i18n } from "./i18n.js";
+export { icons } from "./icons.js";
+export { retryer } from "./retryer.js";
+export {
+  renderError,
+  kFormatter,
+  encodeHTML,
+  isValidHexColor,
+  request,
+  parseArray,
+  parseBoolean,
+  fallbackColor,
+  flexLayout,
+  getCardColors,
+  clampValue,
+  wrapTextMultiline,
+  measureText,
+  logger,
+  CONSTANTS,
+  CustomError,
+  MissingParamError,
+  lowercaseTrim,
+  chunkArray,
+  parseEmojis,
+} from "./utils.js";

src/common/index.js

@@ -2,7 +2,7 @@
 import axios from "axios";
 import * as dotenv from "dotenv";
 import githubUsernameRegex from "github-username-regex";
-import { calculateRank } from "../calculateRank.js";
+import { calculateRank } from "./helpers/calculateRank.js";
 import { retryer } from "../common/retryer.js";
 import {
   CustomError,

src/calculateRank.js renamed to src/fetchers/helpers/calculateRank.js

@@ -0,0 +1 @@
+export * from "./common/index.js";

src/fetchers/stats-fetcher.js

@@ -2,7 +2,7 @@ import { jest } from "@jest/globals";
 import axios from "axios";
 import MockAdapter from "axios-mock-adapter";
 import api from "../api/index.js";
-import { calculateRank } from "../src/calculateRank.js";
+import { calculateRank } from "../src/fetchers/helpers/calculateRank.js";
 import { renderStatsCard } from "../src/cards/stats-card.js";
 import { CONSTANTS, renderError } from "../src/common/utils.js";
 

src/index.js

@@ -1,5 +1,5 @@
 import "@testing-library/jest-dom";
-import { calculateRank } from "../src/calculateRank.js";
+import { calculateRank } from "../src/fetchers/helpers/calculateRank.js";
 
 describe("Test calculateRank", () => {
   it("should calculate rank correctly", () => {

tests/api.test.js

@@ -1,7 +1,7 @@
 import "@testing-library/jest-dom";
 import axios from "axios";
 import MockAdapter from "axios-mock-adapter";
-import { calculateRank } from "../src/calculateRank.js";
+import { calculateRank } from "../src/fetchers/helpers/calculateRank.js";
 import { fetchStats } from "../src/fetchers/stats-fetcher.js";
 
 const data = {