@stats-organization/github-readme-stats-core 2.1.3 → 2.1.5

package/src/common/color.ts

@@ -0,0 +1,212 @@
+import { themes } from "../themes/index.js";
+
+/** Matches a 3-, 4-, 6-, or 8-digit hex color with no leading `#`. */
+const HEX_COLOR =
+  /^([A-Fa-f0-9]{8}|[A-Fa-f0-9]{6}|[A-Fa-f0-9]{4}|[A-Fa-f0-9]{3})$/;
+
+/**
+ * Checks if a value is a bare hex color, i.e. hex digits with no `#` prefix
+ * (`"f00"`, `"ffffff"`). This is the form user-supplied color params and
+ * gradient stops arrive in.
+ *
+ * @param value Value to check.
+ * @returns True if the value is a bare hex color.
+ */
+const isBareHexColor = (value: unknown): boolean => {
+  return typeof value === "string" && HEX_COLOR.test(value);
+};
+
+/**
+ * Checks if a value is a `#`-prefixed hex color (`"#f00"`, `"#ffffff"`). This
+ * is the form colors take once resolved by {@link getCardColors}, i.e. right
+ * before they are written into the SVG.
+ *
+ * @param value Value to check.
+ * @returns True if the value is a `#`-prefixed hex color.
+ */
+const isPrefixedHexColor = (value: unknown): boolean => {
+  return (
+    typeof value === "string" &&
+    value.startsWith("#") &&
+    HEX_COLOR.test(value.slice(1))
+  );
+};
+
+/**
+ * Checks if the given parts form a valid gradient: a finite numeric angle
+ * followed by at least two bare-hex color stops, e.g. `["90", "f00", "0f0"]`.
+ * The angle is written into the SVG `gradientTransform="rotate(...)"`.
+ *
+ * @param parts Gradient parts: `[angle, ...stops]`.
+ * @returns True if the parts form a valid gradient.
+ */
+const isValidGradient = (parts: Array<string>): boolean => {
+  const [angle, ...stops] = parts;
+  return (
+    stops.length >= 2 &&
+    angle !== undefined &&
+    angle.trim() !== "" &&
+    Number.isFinite(Number(angle)) &&
+    stops.every(isBareHexColor)
+  );
+};
+
+/**
+ * Checks if a string is a valid input for a color or gradient.
+ *
+ * @param color String to check, may be null or undefined.
+ * @returns True if the given string is a valid input.
+ */
+const isValidColorInput = (color: string | null | undefined): boolean => {
+  if (color === null || color === undefined) {
+    return true;
+  }
+  return isValidGradient(color.split(",")) || isBareHexColor(color);
+};
+
+/**
+ * Iterates over a collection of colors inputs and verifies that each is a valid color or gradient.
+ *
+ * @param colors Object whose values are checked as valid color inputs.
+ * @return The first key where the associated input value is not valid. null if all inputs are valid.
+ */
+const findInvalidColor = (
+  colors: Record<string, string | null | undefined>,
+): string | null => {
+  for (const [key, value] of Object.entries(colors)) {
+    if (!isValidColorInput(value)) {
+      return key;
+    }
+  }
+  return null;
+};
+
+/**
+ * Retrieves a gradient if color has more than one valid hex codes else a single color.
+ *
+ * @param color The color to parse.
+ * @param fallbackColor The fallback color.
+ * @returns The gradient or color.
+ */
+const fallbackColor = (
+  color: string | undefined,
+  fallbackColor: string | Array<string>,
+): string | Array<string> => {
+  const colors = color ? color.split(",") : [];
+  if (colors.length > 1 && isValidGradient(colors)) {
+    return colors;
+  }
+
+  if (color !== undefined && isBareHexColor(color)) {
+    return `#${color}`;
+  }
+
+  return fallbackColor;
+};
+
+/**
+ * Object containing card colors.
+ */
+interface CardColors {
+  titleColor: string;
+  iconColor: string;
+  textColor: string;
+  bgColor: string | Array<string>;
+  borderColor: string;
+  ringColor: string;
+}
+
+/**
+ * Returns theme based colors with proper overrides and defaults.
+ *
+ * @param props Function arguments.
+ * @param props.title_color Card title color.
+ * @param props.text_color Card text color.
+ * @param props.icon_color Card icon color.
+ * @param props.bg_color Card background color.
+ * @param props.border_color Card border color.
+ * @param props.ring_color Card ring color.
+ * @param props.theme Card theme.
+ * @returns Card colors.
+ */
+const getCardColors = ({
+  title_color,
+  text_color,
+  icon_color,
+  bg_color,
+  border_color,
+  ring_color,
+  theme,
+}: {
+  title_color?: string | undefined;
+  text_color?: string | undefined;
+  icon_color?: string | undefined;
+  bg_color?: string | undefined;
+  border_color?: string | undefined;
+  ring_color?: string | undefined;
+  theme?: string | undefined;
+}): CardColors => {
+  const defaultTheme = themes.default;
+  const isThemeProvided = theme !== undefined && theme in themes;
+
+  const selectedTheme = isThemeProvided
+    ? themes[theme as keyof typeof themes]
+    : defaultTheme;
+
+  const defaultBorderColor =
+    "border_color" in selectedTheme
+      ? selectedTheme.border_color
+      : defaultTheme.border_color;
+
+  // get the color provided by the user else the theme color
+  // finally if both colors are invalid fallback to default theme
+  const titleColor = fallbackColor(
+    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
+  // NOTE: no built-in theme defines `ring_color`, so it falls back to the title color.
+  const ringColor = fallbackColor(ring_color, titleColor);
+  const iconColor = fallbackColor(
+    icon_color || selectedTheme.icon_color,
+    "#" + defaultTheme.icon_color,
+  );
+  const textColor = fallbackColor(
+    text_color || selectedTheme.text_color,
+    "#" + defaultTheme.text_color,
+  );
+  const bgColor = fallbackColor(
+    bg_color || selectedTheme.bg_color,
+    "#" + defaultTheme.bg_color,
+  );
+
+  const borderColor = fallbackColor(
+    border_color || defaultBorderColor,
+    "#" + defaultBorderColor,
+  );
+
+  if (
+    typeof titleColor !== "string" ||
+    typeof textColor !== "string" ||
+    typeof ringColor !== "string" ||
+    typeof iconColor !== "string" ||
+    typeof borderColor !== "string"
+  ) {
+    throw new Error(
+      "Unexpected behavior, all colors except background should be string.",
+    );
+  }
+
+  return { titleColor, iconColor, textColor, bgColor, borderColor, ringColor };
+};
+
+export {
+  fallbackColor,
+  getCardColors,
+  findInvalidColor,
+  isValidGradient,
+  isBareHexColor,
+  isPrefixedHexColor,
+};

package/src/common/config.ts

@@ -0,0 +1,83 @@
+type Env = Record<string, string | undefined>;
+
+interface PersonalAccessToken {
+  name: string;
+  value: string;
+}
+
+interface Config {
+  whitelist: Array<string> | undefined;
+  gistWhitelist: Array<string> | undefined;
+  excludeRepositories: Array<string>;
+  fetchMultiPageStars: string | undefined;
+  pats: Array<PersonalAccessToken>;
+}
+
+/**
+ * @param value Comma-separated string.
+ * @returns Parsed string values.
+ */
+const parseCsv = (value: string | undefined): Array<string> | undefined => {
+  if (!value) {
+    return undefined;
+  }
+  return value.split(",");
+};
+
+/**
+ * @param env Environment variables to inspect.
+ * @returns Personal access tokens found in the environment.
+ */
+const parsePATsFromEnv = (env: Env): Array<PersonalAccessToken> => {
+  return Object.keys(env)
+    .filter((key) => /PAT_\d*$/.exec(key))
+    .map((name) => ({
+      name,
+      value: env[name] ?? "",
+    }));
+};
+
+/**
+ * @returns `process.env` if available, otherwise `{}`.
+ */
+const getDefaultEnv = (): Env => {
+  const processEnv = (globalThis as { process?: { env?: Env } }).process?.env;
+  return processEnv ?? {};
+};
+
+/**
+ * @param config (Partial) config values to normalize.
+ * @returns Normalized config object with defaults applied.
+ */
+const normalizeConfig = (config: Partial<Config> = {}): Config => {
+  return {
+    whitelist: config.whitelist,
+    gistWhitelist: config.gistWhitelist,
+    excludeRepositories: config.excludeRepositories ?? [],
+    fetchMultiPageStars: config.fetchMultiPageStars,
+    pats: config.pats ?? [],
+  };
+};
+
+let currentConfig: Config;
+
+/**
+ * @param env Environment variables used to build the runtime config.
+ */
+export const loadConfigFromEnv = (env: Env = getDefaultEnv()): void => {
+  const whitelist = parseCsv(env["WHITELIST"]);
+  const gistWhitelist = parseCsv(env["GIST_WHITELIST"]);
+  const excludeRepositories = parseCsv(env["EXCLUDE_REPO"]) ?? [];
+
+  currentConfig = normalizeConfig({
+    whitelist,
+    gistWhitelist,
+    excludeRepositories,
+    fetchMultiPageStars: env["FETCH_MULTI_PAGE_STARS"],
+    pats: parsePATsFromEnv(env),
+  });
+};
+
+loadConfigFromEnv();
+
+export const getConfig = (): Config => currentConfig;

package/src/common/constants.ts

@@ -0,0 +1,10 @@
+/**
+ * Valid owner affiliations for GitHub API queries.
+ */
+const OWNER_AFFILIATIONS: Array<string> = [
+  "OWNER",
+  "COLLABORATOR",
+  "ORGANIZATION_MEMBER",
+];
+
+export { OWNER_AFFILIATIONS };

package/src/common/{error.js → error.ts}

@@ -1,14 +1,12 @@
-// @ts-check
-
 import { OWNER_AFFILIATIONS } from "./constants.js";
 
 /**
- * @type {string} A general message to ask user to try again later.
+ * A general message to ask user to try again later.
  */
 const TRY_AGAIN_LATER = "Please try again later";
 
 /**
- * @type {Object<string, string>} A map of error types to secondary error messages.
+ * A map of error types to secondary error messages.
  */
 const SECONDARY_ERROR_MESSAGES = {
   MAX_RETRY:
@@ -28,16 +26,21 @@ const SECONDARY_ERROR_MESSAGES = {
  * Custom error class to handle custom GRS errors.
  */
 class CustomError extends Error {
+  type: string;
+  secondaryMessage: string;
+
   /**
    * Custom error constructor.
    *
-   * @param {string} message Error message.
-   * @param {string} type Error type.
+   * @param message Error message.
+   * @param type Error type.
    */
-  constructor(message, type) {
+  constructor(message: string, type: string) {
     super(message);
     this.type = type;
-    this.secondaryMessage = SECONDARY_ERROR_MESSAGES[type] || type;
+    type PartialRecord = Partial<Record<string, string>>;
+    this.secondaryMessage =
+      (SECONDARY_ERROR_MESSAGES as PartialRecord)[type] ?? type;
   }
 
   static MAX_RETRY = "MAX_RETRY";
@@ -53,13 +56,16 @@ class CustomError extends Error {
  * Missing query parameter class.
  */
 class MissingParamError extends Error {
+  missedParams: Array<string>;
+  secondaryMessage: string | undefined;
+
   /**
    * Missing query parameter error constructor.
    *
-   * @param {string[]} missedParams An array of missing parameters names.
-   * @param {string=} secondaryMessage Optional secondary message to display.
+   * @param missedParams An array of missing parameters names.
+   * @param secondaryMessage Optional secondary message to display.
    */
-  constructor(missedParams, secondaryMessage) {
+  constructor(missedParams: Array<string>, secondaryMessage?: string) {
     const msg = `Missing params ${missedParams
       .map((p) => `"${p}"`)
       .join(", ")} make sure you pass the parameters in URL`;
@@ -72,10 +78,10 @@ class MissingParamError extends Error {
 /**
  * Retrieve secondary message from an error object.
  *
- * @param {Error} err The error object.
- * @returns {string|undefined} The secondary message if available, otherwise undefined.
+ * @param err The error object.
+ * @returns The secondary message if available, otherwise undefined.
  */
-const retrieveSecondaryMessage = (err) => {
+const retrieveSecondaryMessage = (err: Error): string | undefined => {
   return "secondaryMessage" in err && typeof err.secondaryMessage === "string"
     ? err.secondaryMessage
     : undefined;

package/src/common/{fmt.js → fmt.ts}

@@ -1,16 +1,14 @@
-// @ts-check
-
 import { encodeHTML } from "./html.js";
 import { splitWrappedText } from "./render.js";
 
 /**
  * Retrieves num with suffix k(thousands) precise to given decimal places.
  *
- * @param {number} num The number to format.
- * @param {number=} precision The number of decimal places to include.
- * @returns {string|number} The formatted number.
+ * @param num The number to format.
+ * @param precision The number of decimal places to include.
+ * @returns The formatted number.
  */
-const kFormatter = (num, precision) => {
+const kFormatter = (num: number, precision?: number): string | number => {
   const abs = Math.abs(num);
   const sign = Math.sign(num);
 
@@ -22,17 +20,17 @@ const kFormatter = (num, precision) => {
     return sign * abs;
   }
 
-  return sign * parseFloat((abs / 1000).toFixed(1)) + "k";
+  return `${sign * parseFloat((abs / 1000).toFixed(1))}k`;
 };
 
 /**
  * Convert bytes to a human-readable string representation.
  *
- * @param {number} bytes The number of bytes to convert.
- * @returns {string} The human-readable representation of bytes.
+ * @param bytes The number of bytes to convert.
+ * @returns The human-readable representation of bytes.
  * @throws {Error} If bytes is negative or too large.
  */
-const formatBytes = (bytes) => {
+const formatBytes = (bytes: number): string => {
   if (bytes < 0) {
     throw new Error("Bytes must be a non-negative number");
   }
@@ -45,23 +43,29 @@ const formatBytes = (bytes) => {
   const base = 1024;
   const i = Math.floor(Math.log(bytes) / Math.log(base));
 
-  if (i >= sizes.length) {
+  const unit = sizes[i];
+  if (unit === undefined) {
     throw new Error("Bytes is too large to convert to a human-readable string");
   }
 
-  return `${(bytes / Math.pow(base, i)).toFixed(1)} ${sizes[i]}`;
+  return `${(bytes / Math.pow(base, i)).toFixed(1)} ${unit}`;
 };
 
 /**
  * Split text over multiple lines based on the card width.
  *
- * @param {string} text Text to split.
- * @param {number} width Available wrap width in px.
- * @param {number} fontSize Font size in px.
- * @param {number} maxLines Maximum number of lines.
- * @returns {string[]} Array of lines.
+ * @param text Text to split.
+ * @param width Available wrap width in px.
+ * @param fontSize Font size in px.
+ * @param maxLines Maximum number of lines.
+ * @returns Array of lines.
  */
-const wrapTextMultiline = (text, width, fontSize, maxLines = 3) => {
+const wrapTextMultiline = (
+  text: string,
+  width: number,
+  fontSize: number,
+  maxLines = 3,
+): Array<string> => {
   const wrapped = splitWrappedText(text, fontSize, width);
   const lines = wrapped
     .map((line) => encodeHTML(line.trim()))
@@ -69,7 +73,11 @@ const wrapTextMultiline = (text, width, fontSize, maxLines = 3) => {
 
   // Add "..." to the last line if the text exceeds maxLines
   if (wrapped.length > maxLines) {
-    lines[maxLines - 1] += "...";
+    const lastIndex = maxLines - 1;
+    const lastLine = lines[lastIndex];
+    if (lastLine !== undefined) {
+      lines[lastIndex] = `${lastLine}...`;
+    }
   }
 
   // Remove empty lines if text fits in less than maxLines lines

package/src/common/{html.js → html.ts}

@@ -1,18 +1,13 @@
-// @ts-check
-
 /**
  * Encode string as HTML.
  *
  * @see https://stackoverflow.com/a/48073476/10629172
- *
- * @param {string} str String to encode.
- * @returns {string} Encoded string.
  */
-const encodeHTML = (str) => {
+const encodeHTML = (str: string): string => {
   return (
     str
-      .replace(/[\u00A0-\u9999<>&](?!#)/gim, (i) => {
-        return "&#" + i.charCodeAt(0) + ";";
+      .replace(/[\u00A0-\u9999<>&"'](?!#)/gim, (i: string) => {
+        return `&#${i.charCodeAt(0)};`;
       })
       // eslint-disable-next-line no-control-regex
       .replace(/\u0008/gim, "")

package/src/common/http.ts

@@ -0,0 +1,31 @@
+import axios from "axios";
+import type { AxiosRequestConfig, AxiosResponse } from "axios";
+
+/** Body of a GraphQL request sent to the GitHub API. */
+interface GraphQLRequest {
+  /** The GraphQL query. */
+  query: string;
+  /** Variables referenced by the query. */
+  variables: Record<string, unknown>;
+}
+
+/**
+ * Send GraphQL request to GitHub API.
+ *
+ * @param data Request data.
+ * @param headers Request headers.
+ * @returns Request response.
+ */
+const request = (
+  data: GraphQLRequest,
+  headers: NonNullable<AxiosRequestConfig["headers"]>,
+): Promise<AxiosResponse> => {
+  return axios({
+    url: "https://api.github.com/graphql",
+    method: "post",
+    headers,
+    data,
+  });
+};
+
+export { request };

package/src/common/{icons.js → icons.ts}

@@ -1,5 +1,3 @@
-// @ts-check
-
 /*
 The icons in this file are based on https://github.com/primer/octicons which is released under the MIT license:
 
@@ -46,12 +44,16 @@ const icons = {
 /**
  * Get rank icon
  *
- * @param {string} rankIcon - The rank icon type.
- * @param {string} rankLevel - The rank level.
- * @param {number} percentile - The rank percentile.
- * @returns {string} - The SVG code of the rank icon
+ * @param rankIcon - The rank icon type.
+ * @param rankLevel - The rank level.
+ * @param percentile - The rank percentile.
+ * @returns The SVG code of the rank icon
  */
-const rankIcon = (rankIcon, rankLevel, percentile) => {
+const rankIcon = (
+  rankIcon: string,
+  rankLevel: string,
+  percentile: number,
+): string => {
   switch (rankIcon) {
     case "github":
       return `

package/src/common/languageColors.json

@@ -44,6 +44,7 @@
   "Awk": "#c30e9b",
   "B (Formal Method)": "#8aa8c5",
   "B4X": "#00e4ff",
+  "BAML": "#a855f7",
   "BASIC": "#ff0000",
   "BQN": "#2b7067",
   "Ballerina": "#FF5000",
@@ -58,6 +59,7 @@
   "Blade": "#f7523f",
   "BlitzBasic": "#00FFAE",
   "BlitzMax": "#cd6400",
+  "Blueprint": "#3584E4",
   "Bluespec": "#12223c",
   "Bluespec BH": "#12223c",
   "Boo": "#d4bec1",
@@ -69,7 +71,7 @@
   "Bru": "#F4AA41",
   "BuildStream": "#006bff",
   "C": "#555555",
-  "C#": "#178600",
+  "C#": "#7355dd",
   "C++": "#f34b7d",
   "C3": "#2563eb",
   "CAP CDS": "#0092d1",
@@ -227,6 +229,7 @@
   "Graphviz (DOT)": "#2596be",
   "Groovy": "#4298b8",
   "Groovy Server Pages": "#4298b8",
+  "GtkRC": "#7fe719",
   "HAProxy": "#106da9",
   "HCL": "#844FBA",
   "HIP": "#4F3A4F",
@@ -416,6 +419,7 @@
   "OpenSCAD": "#e5cd45",
   "Option List": "#476732",
   "Org": "#77aa99",
+  "OverPy": "#78b355",
   "OverpassQL": "#cce2aa",
   "Oxygene": "#cdd0e3",
   "Oz": "#fab738",
@@ -445,10 +449,12 @@
   "Portugol": "#f8bd00",
   "PostCSS": "#dc3a0c",
   "PostScript": "#da291c",
+  "Power Query": "#d38e0d",
   "PowerBuilder": "#8f0f8d",
   "PowerShell": "#012456",
   "Praat": "#c8506d",
   "Prisma": "#0c344b",
+  "Pro*C": "#bb8368",
   "Processing": "#0096D8",
   "Procfile": "#3B2F63",
   "Prolog": "#74283c",
@@ -490,6 +496,7 @@
   "Rebol": "#358a5b",
   "Record Jar": "#0673ba",
   "Red": "#f50000",
+  "Redscript": "#f44336",
   "Regular Expression": "#009a00",
   "Ren'Py": "#ff7f7f",
   "Rez": "#FFDAB3",
@@ -659,6 +666,7 @@
   "nanorc": "#2d004d",
   "nesC": "#94B0C7",
   "ooc": "#b0b77e",
+  "pkg-config": "#2b5e82",
   "q": "#0040cd",
   "reStructuredText": "#141414",
   "sed": "#64b970",