Issue #764: Add custom year

api/index.js

@@ -24,6 +24,7 @@ export default async (req, res) => {
     show_icons,
     count_private,
     include_all_commits,
+    year,
     line_height,
     title_color,
     icon_color,
@@ -55,6 +56,7 @@ export default async (req, res) => {
       parseBoolean(count_private),
       parseBoolean(include_all_commits),
       parseArray(exclude_repo),
+      parseInt(year),
     );
 
     const cacheSeconds = clampValue(
@@ -74,6 +76,7 @@ export default async (req, res) => {
         card_width: parseInt(card_width, 10),
         hide_rank: parseBoolean(hide_rank),
         include_all_commits: parseBoolean(include_all_commits),
+        year: parseInt(year),
         line_height,
         title_color,
         icon_color,

readme.md

@@ -130,6 +130,13 @@ You can add the count of all your private contributions to the total commits cou
 ![Anurag's GitHub stats](https://github-readme-stats.vercel.app/api?username=anuraghazra&count_private=true)
 ```
 
+### Specifying Year
+
+You can specify a year and fetch only the commits that were made in that year by passing `&year=YYYY` to the parameter.
+
+```md
+![Anurag's GitHub stats](https://github-readme-stats.vercel.app/api?username=anuraghazra&year=2020)
+```
 ### Showing icons
 
 To enable icons, you can pass `show_icons=true` in the query param, like so:
@@ -196,6 +203,7 @@ You can provide multiple comma-separated values in the bg_color option to render
 -   `custom_title` - Sets a custom title for the card. Default:  `<username> Github Stats`.
 -   `text_bold` - Use bold text _(boolean)_. Default: `true`.
 -   `disable_animations` - Disables all animations in the card _(boolean)_. Default: `false`.
+-   `year` - Count commit of the entire year _(YYYY)_. Default: `<current year> (one year to date)`
 
 > **Note**
 > When hide_rank=`true`, the minimum card width is 270 px + the title length and padding.

src/cards/stats-card.js

@@ -87,6 +87,7 @@ const renderStatsCard = (stats = {}, options = { hide: [] }) => {
     card_width,
     hide_rank = false,
     include_all_commits = false,
+    year,
     line_height = 25,
     title_color,
     icon_color,
@@ -133,7 +134,11 @@ const renderStatsCard = (stats = {}, options = { hide: [] }) => {
     commits: {
       icon: icons.commits,
       label: `${i18n.t("statcard.commits")}${
-        include_all_commits ? "" : ` (${new Date().getFullYear()})`
+        include_all_commits 
+          ? "" 
+          : year
+            ? ` (${year})`
+            : ` (${new Date().getFullYear()})`
       }`,
       value: totalCommits,
       id: "commits",

src/cards/types.d.ts

@@ -19,6 +19,7 @@ export type StatCardOptions = CommonOptions & {
   card_width: number;
   hide_rank: boolean;
   include_all_commits: boolean;
+  year?: number;
   line_height: number | string;
   custom_title: string;
   disable_animations: boolean;

src/fetchers/stats-fetcher.js

@@ -25,11 +25,11 @@ const fetcher = (variables, token) => {
   return request(
     {
       query: `
-      query userInfo($login: String!) {
+      query userInfo($login: String!, $starttime: DateTime!) {
         user(login: $login) {
           name
           login
-          contributionsCollection {
+          contributionsCollection(from: $starttime) {
             totalCommitContributions
             restrictedContributionsCount
           }
@@ -186,13 +186,15 @@ const totalStarsFetcher = async (username, repoToHide) => {
  * @param {string} username Github username.
  * @param {boolean} count_private Include private contributions.
  * @param {boolean} include_all_commits Include all commits.
+ * @param {number|undefined} year Year to count total commits
  * @returns {Promise<import("./types").StatsData>} Stats data.
  */
 async function fetchStats(
   username,
   count_private = false,
   include_all_commits = false,
   exclude_repo = [],
+  year,
 ) {
   if (!username) throw new MissingParamError(["username"]);
 
@@ -206,7 +208,10 @@ async function fetchStats(
     rank: { level: "C", score: 0 },
   };
 
-  let res = await retryer(fetcher, { login: username });
+  let res = await retryer(fetcher, { 
+    login: username, 
+    starttime: year ? `${year}-01-01T00:00:00Z` : undefined
+  });
 
   // Catch GraphQL errors.
   if (res.data.errors) {

tests/fetchStats.test.js

@@ -253,4 +253,74 @@ describe("Test fetchStats", () => {
       rank,
     });
   });
+
+  it("should get present year commits when provide no year", async () => {
+    const data2003 = {...data, data: 
+      {...data.data, user: 
+        {...data.data.user, contributionsCollection: {
+      totalCommitContributions: 2003,
+      restrictedContributionsCount: 3,
+    }}}}
+    mock.onPost("https://api.github.com/graphql").reply((cfg) => {
+      if (cfg.data.includes("contributionsCollection(from: 2003-01-01T00:00:00Z)"))
+        return [200, data2003];
+      return [200, data];
+    });
+
+    let stats = await fetchStats("anuraghazra", true, false, []);
+    const rank = calculateRank({
+      totalCommits: 150,
+      totalRepos: 5,
+      followers: 100,
+      contributions: 61,
+      stargazers: 400,
+      prs: 300,
+      issues: 200,
+    });
+
+    expect(stats).toStrictEqual({
+      contributedTo: 61,
+      name: "Anurag Hazra",
+      totalCommits: 150,
+      totalIssues: 200,
+      totalPRs: 300,
+      totalStars: 400,
+      rank,
+    });
+  });
+
+  it("should get commits of provided year", async () => {
+    const data2003 = {...data, data: 
+      {...data.data, user: 
+        {...data.data.user, contributionsCollection: {
+      totalCommitContributions: 2003,
+      restrictedContributionsCount: 3,
+    }}}}
+    mock.onPost("https://api.github.com/graphql").reply((cfg) => {
+      if (cfg.data.includes(`"starttime":"2003-01-01T00:00:00Z"`)) 
+        return [200, data2003];
+      return [200, data];
+    });
+
+    let stats = await fetchStats("anuraghazra", true, false, [], 2003);
+    const rank = calculateRank({
+      totalCommits: 2006,
+      totalRepos: 5,
+      followers: 100,
+      contributions: 61,
+      stargazers: 400,
+      prs: 300,
+      issues: 200,
+    });
+
+    expect(stats).toStrictEqual({
+      contributedTo: 61,
+      name: "Anurag Hazra",
+      totalCommits: 2006,
+      totalIssues: 200,
+      totalPRs: 300,
+      totalStars: 400,
+      rank,
+    });
+  });
 });