@stats-organization/github-readme-stats-core 2.1.4 → 2.2.0

package/src/graphql/generated/top-languages.ts

@@ -0,0 +1,75 @@
+// Generated file — see .github/CONTRIBUTING.md
+
+/** Internal type. DO NOT USE DIRECTLY. */
+type Exact<T extends { [key: string]: unknown }> = { [K in keyof T]: T[K] };
+import type * as Types from "./common.js";
+
+import { graphqlDocument } from "../graphqlDocument.js";
+export type TopLanguageFragment = {
+  size: number;
+  node: { color: string | null; name: string };
+};
+
+export type TopLanguagesRepositoryFragment = {
+  name: string;
+  languages: {
+    edges: Array<{
+      size: number;
+      node: { color: string | null; name: string };
+    } | null> | null;
+  } | null;
+};
+
+export type TopLanguagesQueryVariables = Exact<{
+  login: string;
+  ownerAffiliations?:
+    | Array<Types.RepositoryAffiliation | null | undefined>
+    | Types.RepositoryAffiliation
+    | null
+    | undefined;
+}>;
+
+export type TopLanguagesQuery = {
+  user: {
+    repositories: {
+      nodes: Array<{
+        name: string;
+        languages: {
+          edges: Array<{
+            size: number;
+            node: { color: string | null; name: string };
+          } | null> | null;
+        } | null;
+      } | null> | null;
+    };
+  } | null;
+};
+
+export const TopLanguagesDocument = graphqlDocument<
+  TopLanguagesQuery,
+  TopLanguagesQueryVariables
+>(`
+query topLanguages($login: String!, $ownerAffiliations: [RepositoryAffiliation]) {
+  user(login: $login) {
+    repositories(ownerAffiliations: $ownerAffiliations, isFork: false, first: 100) {
+      nodes {
+        ...TopLanguagesRepository
+      }
+    }
+  }
+}
+fragment TopLanguagesRepository on Repository {
+  name
+  languages(first: 10, orderBy: {field: SIZE, direction: DESC}) {
+    edges {
+      ...TopLanguage
+    }
+  }
+}
+fragment TopLanguage on LanguageEdge {
+  size
+  node {
+    color
+    name
+  }
+}`);

package/src/graphql/graphqlDocument.ts

@@ -0,0 +1,25 @@
+/**
+ * A GraphQL query paired with the types of its result and variables.
+ *
+ * `text` is what goes over the wire; the other two members only carry types and are never assigned.
+ * Documents are generated from `queries/*.graphql`
+ * See `scripts/generate-graphql-types.js`.
+ */
+interface GraphQLDocument<TResult, TVariables> {
+  readonly text: string;
+  readonly __result?: TResult;
+  readonly __variables?: TVariables;
+}
+
+/**
+ * Build a typed document.
+ *
+ * @param text The query text, including every fragment it spreads.
+ * @returns The document to pass to the function created by `createGraphQLFetcher`.
+ */
+const graphqlDocument = <TResult, TVariables>(
+  text: string,
+): GraphQLDocument<TResult, TVariables> => ({ text });
+
+export { graphqlDocument };
+export type { GraphQLDocument };

package/src/graphql/queries/gist.graphql

@@ -0,0 +1,25 @@
+fragment GistFileInfo on GistFile {
+  name
+  language {
+    name
+  }
+  size
+}
+
+query gistInfo($gistName: String!) {
+  viewer {
+    gist(name: $gistName) {
+      description
+      owner {
+        login
+      }
+      stargazerCount
+      forks {
+        totalCount
+      }
+      files {
+        ...GistFileInfo
+      }
+    }
+  }
+}

package/src/graphql/queries/repo.graphql

@@ -0,0 +1,28 @@
+fragment RepoInfo on Repository {
+  name
+  nameWithOwner
+  isPrivate
+  isArchived
+  isTemplate
+  stargazerCount
+  description
+  primaryLanguage {
+    color
+    id
+    name
+  }
+  forkCount
+}
+
+query getRepo($login: String!, $repo: String!) {
+  user(login: $login) {
+    repository(name: $repo) {
+      ...RepoInfo
+    }
+  }
+  organization(login: $login) {
+    repository(name: $repo) {
+      ...RepoInfo
+    }
+  }
+}

package/src/graphql/queries/stats.graphql

@@ -0,0 +1,120 @@
+fragment RepoNode on Repository {
+  name
+  stargazerCount
+}
+
+fragment RepoStars on User {
+  repositories(
+    first: 100
+    after: $after
+    ownerAffiliations: $ownerAffiliations
+    orderBy: { direction: DESC, field: STARGAZERS }
+  ) {
+    totalCount
+    nodes {
+      ...RepoNode
+    }
+    pageInfo {
+      hasNextPage
+      endCursor
+    }
+  }
+}
+
+query userRepos(
+  $login: String!
+  $after: String
+  $ownerAffiliations: [RepositoryAffiliation]
+) {
+  user(login: $login) {
+    ...RepoStars
+  }
+}
+
+query userInfo(
+  $login: String!
+  $after: String
+  $includeMergedPullRequests: Boolean!
+  $includeDiscussions: Boolean!
+  $includeDiscussionsAnswers: Boolean!
+  $startTime: DateTime = null
+  $ownerAffiliations: [RepositoryAffiliation]
+  $includeUserRepositories: Boolean!
+) {
+  user(login: $login) {
+    name
+    login
+    commits: contributionsCollection(from: $startTime) {
+      totalCommitContributions
+    }
+    reviews: contributionsCollection {
+      totalPullRequestReviewContributions
+    }
+    repositoriesContributedTo(
+      first: 1
+      contributionTypes: [COMMIT, ISSUE, PULL_REQUEST, REPOSITORY]
+      includeUserRepositories: $includeUserRepositories
+    ) {
+      totalCount
+    }
+    pullRequests(first: 1) {
+      totalCount
+    }
+    mergedPullRequests: pullRequests(states: MERGED)
+      @include(if: $includeMergedPullRequests) {
+      totalCount
+    }
+    openIssues: issues(states: OPEN) {
+      totalCount
+    }
+    closedIssues: issues(states: CLOSED) {
+      totalCount
+    }
+    followers {
+      totalCount
+    }
+    repositoryDiscussions @include(if: $includeDiscussions) {
+      totalCount
+    }
+    repositoryDiscussionComments(onlyAnswers: true)
+      @include(if: $includeDiscussionsAnswers) {
+      totalCount
+    }
+    contributionsCollection {
+      contributionYears
+    }
+    ...RepoStars
+  }
+}
+
+fragment YearContributions on ContributionsCollection {
+  contributionCalendar {
+    totalContributions
+  }
+}
+
+fragment RangeContributionsByRepo on ContributionsCollection {
+  commitContributionsByRepository(maxRepositories: $maxRepositories) {
+    repository {
+      nameWithOwner
+    }
+  }
+  issueContributionsByRepository(maxRepositories: $maxRepositories) {
+    repository {
+      nameWithOwner
+    }
+  }
+  pullRequestContributionsByRepository(maxRepositories: $maxRepositories) {
+    repository {
+      nameWithOwner
+    }
+  }
+  repositoryContributions(first: $maxRepositories)
+    @include(if: $includeOwnRepos) {
+    nodes {
+      repository {
+        nameWithOwner
+      }
+    }
+  }
+}

package/src/graphql/queries/top-languages.graphql

@@ -0,0 +1,34 @@
+fragment TopLanguage on LanguageEdge {
+  size
+  node {
+    color
+    name
+  }
+}
+
+fragment TopLanguagesRepository on Repository {
+  name
+  languages(first: 10, orderBy: { field: SIZE, direction: DESC }) {
+    edges {
+      ...TopLanguage
+    }
+  }
+}
+
+query topLanguages(
+  $login: String!
+  $ownerAffiliations: [RepositoryAffiliation]
+) {
+  user(login: $login) {
+    # do not fetch forks
+    repositories(
+      ownerAffiliations: $ownerAffiliations
+      isFork: false
+      first: 100
+    ) {
+      nodes {
+        ...TopLanguagesRepository
+      }
+    }
+  }
+}

package/src/graphql/reposContributedToDocument.ts

@@ -0,0 +1,86 @@
+import type { GitHubDateRange } from "../common/date.js";
+import { toGitHubDateTime } from "../common/date.js";
+
+import type { RangeContributionsByRepoFragment } from "./generated/stats.js";
+import { graphqlDocument } from "./graphqlDocument.js";
+
+/** max value GitHub allows for `first/maxRepositories` */
+const MAX_REPOSITORIES_LIMIT = 100;
+
+interface ReposContributedToQueryVariables {
+  login: string;
+  maxRepositories: number;
+}
+
+interface ReposContributedToQuery {
+  user: Record<`range_${number}`, RangeContributionsByRepoFragment> | null;
+}
+
+/**
+ * Build a query for the repositories a user contributed to within multiple time
+ * ranges. One aliased `contributionsCollection` field per range, so all ranges
+ * are fetched in a single request. The shape is only known at runtime.
+ *
+ * Mirrors the `contributionTypes: [COMMIT, ISSUE, PULL_REQUEST, REPOSITORY]`
+ * filter used by `repositoriesContributedTo` in `stats.graphql`.
+ *
+ * @param ranges Ranges to fetch, one `range_<index>` alias each.
+ * @param includeOwnRepos Whether to select `repositoryContributions`.
+ * @returns Document for `createGraphQLFetcher`.
+ */
+const buildReposContributedToDocument = (
+  ranges: Array<GitHubDateRange>,
+  includeOwnRepos: boolean,
+) => {
+  const rangeFields = ranges
+    .map(
+      ({ from, to }, index) =>
+        `range_${index}: contributionsCollection(from: "${toGitHubDateTime(from)}", to: "${toGitHubDateTime(to)}") { ...RangeContributionsByRepo }`,
+    )
+    .join("\n");
+
+  // `repositoryContributions` only ever returns repos the user owns,
+  // so it is left out rather than gated with @include: an excluded field still counts toward the query's node cost.
+  // stats.graphql carries the directive so the generated type marks the field optional.
+  const ownRepoField = includeOwnRepos
+    ? `repositoryContributions(first: $maxRepositories) {
+    nodes {
+      repository {
+        nameWithOwner
+      }
+    }
+  }`
+    : "";
+
+  // fragment must match queries/stats.graphql, which generates its type
+  return graphqlDocument<
+    ReposContributedToQuery,
+    ReposContributedToQueryVariables
+  >(`
+query userReposContributedTo($login: String!, $maxRepositories: Int!) {
+  user(login: $login) {
+    ${rangeFields}
+  }
+}
+fragment RangeContributionsByRepo on ContributionsCollection {
+  commitContributionsByRepository(maxRepositories: $maxRepositories) {
+    repository {
+      nameWithOwner
+    }
+  }
+  issueContributionsByRepository(maxRepositories: $maxRepositories) {
+    repository {
+      nameWithOwner
+    }
+  }
+  pullRequestContributionsByRepository(maxRepositories: $maxRepositories) {
+    repository {
+      nameWithOwner
+    }
+  }
+  ${ownRepoField}
+}`);
+};
+
+export { buildReposContributedToDocument, MAX_REPOSITORIES_LIMIT };
+export type { ReposContributedToQuery };

package/src/index.ts

@@ -9,7 +9,8 @@ export { retryer } from "./common/retryer.js";
 
 export { renderError } from "./common/render.js";
 
-export { dateDiff, clampValue } from "./common/ops.js";
+export { clampValue } from "./common/ops.js";
+export { dateDiff } from "./common/date.js";
 
 export { logger } from "./common/log.js";
 export { request } from "./common/http.js";
@@ -23,3 +24,4 @@ export { default as wakatime } from "./api/wakatime.js";
 export { getConfig, loadConfigFromEnv } from "./common/config.js";
 
 export { themes } from "./themes/index.js";
+export type { ThemeName } from "./themes/index.js";

package/src/themes/index.ts

@@ -23,6 +23,34 @@ export const themes = {
     text_color: "434d58",
     bg_color: "fffefe",
   },
+  light_github: {
+    title_color: "0969da",
+    icon_color: "0969da",
+    text_color: "59636e",
+    bg_color: "ffffff",
+    border_color: "d1d9e0",
+  },
+  dark_github: {
+    title_color: "4493f8",
+    icon_color: "4493f8",
+    text_color: "9198a1",
+    bg_color: "0d1117",
+    border_color: "3d444d",
+  },
+  light_github_repocard: {
+    title_color: "0969da",
+    icon_color: "59636e",
+    text_color: "59636e",
+    bg_color: "ffffff",
+    border_color: "d1d9e0",
+  },
+  dark_github_repocard: {
+    title_color: "4493f8",
+    icon_color: "9198a1",
+    text_color: "9198a1",
+    bg_color: "0d1117",
+    border_color: "3d444d",
+  },
   transparent: {
     title_color: "006AFF",
     icon_color: "0579C3",
@@ -474,3 +502,8 @@ export const themes = {
     bg_color: "35,4158d0,c850c0,ffcc70",
   },
 } as const satisfies Record<string, Theme>;
+
+/**
+ * Name of one of the {@link themes}.
+ */
+export type ThemeName = keyof typeof themes;

package/src/translations.ts

@@ -362,6 +362,9 @@ const statCardLocales = ({
       no: "Bidro til (i fjor)",
       be: "Уклад (за мінулы год)",
     },
+    "statcard.all-time-contribs": {
+      en: "Contributed to (all time)",
+    },
     "statcard.reviews": {
       en: "Total PRs Reviewed",
       ar: "طلبات السحب التي تم مراجعتها",
@@ -511,18 +514,27 @@ const statCardLocales = ({
     },
     "statcard.prs-authored": {
       en: "PRs Created",
+      "zh-tw": "建立的拉取請求",
     },
     "statcard.prs-commented": {
       en: "PRs Commented",
+      "zh-tw": "參與討論的拉取請求",
     },
     "statcard.prs-reviewed": {
       en: "PRs Reviewed",
+      "zh-tw": "審核的拉取請求",
     },
     "statcard.issues-authored": {
       en: "Issues Created",
+      "zh-tw": "建立的議題",
     },
     "statcard.issues-commented": {
       en: "Issues Commented",
+      "zh-tw": "參與討論的議題",
+    },
+    "statcard.contributions": {
+      en: "Total Contributions",
+      "zh-tw": "總貢獻數量",
     },
     "statcard.prs-merged": {
       en: "Total PRs Merged",
@@ -724,18 +736,23 @@ const repoCardLocales = {
   },
   "repocard.prs-authored": {
     en: "my created PRs",
+    "zh-tw": "我所創建的拉取請求",
   },
   "repocard.prs-commented": {
     en: "my commented PRs",
+    "zh-tw": "我所參與的拉取請求",
   },
   "repocard.prs-reviewed": {
     en: "my reviewed PRs",
+    "zh-tw": "我所審核的拉取請求",
   },
   "repocard.issues-authored": {
     en: "my created issues",
+    "zh-tw": "我所創建的議題",
   },
   "repocard.issues-commented": {
     en: "my commented issues",
+    "zh-tw": "我所參與的議題",
   },
 };
 

package/src/cards/types.d.ts

@@ -1,78 +0,0 @@
-type ThemeNames = keyof typeof import("../themes/index.ts");
-type RankIcon = "default" | "github" | "percentile";
-
-interface CommonOptions {
-  title_color: string;
-  icon_color: string;
-  text_color: string;
-  bg_color: string;
-  theme: ThemeNames;
-  border_radius: number;
-  border_color: string;
-  locale: string;
-  hide_border: boolean;
-}
-
-export type StatCardOptions = CommonOptions & {
-  hide: Array<string>;
-  show_icons: boolean;
-  hide_title: boolean;
-  card_width: number;
-  hide_rank: boolean;
-  include_all_commits: boolean;
-  commits_year: number;
-  line_height: number | string;
-  custom_title: string;
-  disable_animations: boolean;
-  number_format: string;
-  number_precision: number;
-  ring_color: string;
-  text_bold: boolean;
-  rank_icon: RankIcon;
-  show: Array<string>;
-};
-
-export type RepoCardOptions = CommonOptions & {
-  show_owner: boolean;
-  browser_rendering: boolean;
-  description_lines_count: number;
-  card_width_input;
-  show: Array<string>;
-  show_icons: boolean;
-  number_format: string;
-  text_bold: boolean;
-  line_height: number | string;
-  username;
-};
-
-export type TopLangOptions = CommonOptions & {
-  hide_title: boolean;
-  card_width: number;
-  hide: Array<string>;
-  layout: "compact" | "normal" | "donut" | "donut-vertical" | "pie";
-  custom_title: string;
-  langs_count: number;
-  disable_animations: boolean;
-  hide_progress: boolean;
-  hide_values: boolean;
-  prog_bar_bg_color: string;
-  stats_format: "percentages" | "bytes";
-};
-
-export type WakaTimeOptions = CommonOptions & {
-  hide_title: boolean;
-  hide: Array<string>;
-  card_width: number;
-  line_height: string;
-  hide_progress: boolean;
-  custom_title: string;
-  layout: "compact" | "normal";
-  langs_count: number;
-  display_format: "time" | "percent";
-  disable_animations: boolean;
-};
-
-export type GistCardOptions = CommonOptions & {
-  show_owner: boolean;
-  browser_rendering: boolean;
-};

package/src/common/http.js

@@ -1,19 +0,0 @@
-import axios from "axios";
-
-/**
- * Send GraphQL request to GitHub API.
- *
- * @param {import('axios').AxiosRequestConfig['data']} data Request data.
- * @param {import('axios').AxiosRequestConfig['headers']} headers Request headers.
- * @returns {Promise<any>} Request response.
- */
-const request = (data, headers) => {
-  return axios({
-    url: "https://api.github.com/graphql",
-    method: "post",
-    headers,
-    data,
-  });
-};
-
-export { request };