render on real issue

Author: legomushroom

.env-template

@@ -0,0 +1,2 @@
+REPO_GITHUB_PAT="<github PAT>"
+CONFIG_PATH="./testConfig2.json"

TODO.md

@@ -1,6 +1,8 @@
+
+- Add support for issues from external repos
+- Add the developer stats and badges/achievements
 - Pass the config JSON file refrence thru the yml file
-- issue markers
-- Add the PR parsing logic
-- Add developer achievements
+- Add the PR parsing logic on teh card/issue and render it for the "In review" items
 
-- stats on when moved from one column to another ?
+- project pulse - graph on how many items fixed on particular day ?
+- stats on when moved from one column to another ?

src/interfaces/IProjectData.ts

@@ -4,7 +4,7 @@ export interface IProjectData {
   inWorkIssues: IWrappedIssue[];
   doneOrDeployIssues: IWrappedIssue[];
   allPlannedIssues: IWrappedIssue[];
-  toSolveIssues: IWrappedIssue[];
+  issuesToSolve: IWrappedIssue[];
   // raw:
   backlogIssues: IWrappedIssue[];
   committedIssues: IWrappedIssue[];

src/main.ts

@@ -58,10 +58,7 @@ const updateBoardIssue = async (
     return await overwriteBoardIssue(issueContents, config, projectKit);
   }
 
-  const issue = await projectKit.getBoardIssue(
-    config.boardIssue,
-    issueContents,
-  );
+  const issue = await projectKit.getBoardIssue(config.boardIssue);
 
   const { body } = issue;
   const newBody = body.replace(getRegex(), wrapIssueText(issueContents));

src/octokit/ProjectsOctoKit.ts

@@ -214,14 +214,13 @@ export class ProjectsOctoKit extends OctoKitBase {
     });
   };
 
-  public getBoardIssue = async (issueUrl: string, body: string) => {
+  public getBoardIssue = async (issueUrl: string) => {
     const { owner, repo, issueNumber } = parseIssueUrl(issueUrl);
 
     const { status, data } = await this.kit.issues.get({
       owner,
       repo,
-      issue_number: issueNumber,
-      body,
+      issue_number: issueNumber
     });
 
     if (status !== 200) {

src/utils/getProjectData.ts

@@ -65,7 +65,7 @@ export const getProjectData = async (
     inWorkIssues,
     doneOrDeployIssues,
     allPlannedIssues,
-    toSolveIssues,
+    issuesToSolve: toSolveIssues,
     // plain
     backlogIssues,
     committedIssues,

src/utils/getProjectStats.ts

@@ -67,7 +67,7 @@ export const getProjectStats = (data: IProjectData, config: IConfig): IProjectSt
     inWorkIssues,
     doneOrDeployIssues,
     allPlannedIssues,
-    toSolveIssues,
+    issuesToSolve: toSolveIssues,
     // plain
     committedIssues,
   } = data;

src/views/renderIssue.ts

@@ -2,6 +2,16 @@ import { IIssueState } from '../interfaces/IIssueState';
 import { TColumnTypes } from '../interfaces/TColumnTypes';
 import { TRepoIssue } from '../interfaces/TRepoIssue';
 import { pluck } from '../utils/pluck';
+import { ident } from './ident';
+
+const emojiIcon = (icon: string, title?: string) => {
+  const iconString = `${icon}${ident(1)}`;
+  if (!title) {
+    return iconString;
+  }
+
+  return `<i title="${title}">${iconString}</i>`;
+};
 
 const mapColumnToEmoji = (column: TColumnTypes) => {
   switch (column) {
@@ -14,19 +24,19 @@ const mapColumnToEmoji = (column: TColumnTypes) => {
     }
 
     case TColumnTypes.InReview: {
-      return '👀  ';
+      return emojiIcon('👀', column);
     }
 
     case TColumnTypes.WaitingToDeploy: {
-      return '🏗️  ';
+      return emojiIcon('🏗️', column);
     }
 
     case TColumnTypes.Blocked: {
       return '';
     }
 
     case TColumnTypes.Done: {
-      return '✅  ';
+      return emojiIcon('✅', column);
     }
 
     default:
@@ -46,7 +56,7 @@ const mapIssueTypeToEmoji = (issue: TRepoIssue) => {
   const isBug = labels.map(pluck('name')).map(toLowerCase).includes('bug');
 
   if (isBug) {
-    return '🐛  ';
+    return emojiIcon('🐛', 'Bug');
   }
 
   return '';

src/views/renderIssuesBlock.ts

@@ -99,7 +99,7 @@ const renderIssuesSection = (
   for (let wrappedIssue of issues) {
     const { column, issue } = wrappedIssue;
     const item = renderIssue(column, issue, isCheckList);
-    issueItems.push(`${ident(1)}${item}`);
+    issueItems.push(`${ident(0)}${item}`);
   }
 
   return issueItems.filter(notEmpty).join('\n');
@@ -129,8 +129,9 @@ const renderIssuesList = (
         return;
       }
 
-      const title =
-        labelName === NONE_LABEL ? undefined : `- **${capitalize(labelName)}**`;
+      const title = (labelName === NONE_LABEL)
+        ? undefined
+        : `\n**${capitalize(labelName)}**`;
 
       return renderIssuesSection(issues, projectConfig, title);
     });

src/views/renderProjectOverview.ts

@@ -1,5 +1,6 @@
 import { IConfig } from '../interfaces/IConfig';
 import { IDeveloperWithIssuesCount } from '../interfaces/IDeveloperWithIssuesCount';
+import { IProjectStats } from '../interfaces/IProjectStats';
 import { IProjectWithData } from '../interfaces/IProjectWithData';
 import { getProjectStats } from '../utils/getProjectStats';
 import { ident } from './ident';
@@ -17,60 +18,103 @@ const renderPerLine = (
 
   const left = leftRatio.toFixed(1);
   const was = totalRatio.toFixed(1);
-  return `${ident(identation)}- ${unit}: **${left} left** / **${was} started**`;
+  return `${ident(identation)}- ${unit}: **${left}** left / **${was}** total`;
 };
 
+// const renderDeveloper = (
+//   developer: IDeveloperWithIssuesCount,
+//   config: IConfig,
+//   identation = 0,
+// ) => {
+//   const { login, issuesCount } = developer
+
+//   const daysLeft = getWorkDays(config);
+//   const suffix = (daysLeft)
+//     ? ` / **${(issuesCount / Math.max(1, daysLeft.businessDaysLeft)).toFixed(1)} per day left**`
+//     : '';
+
+//   return `${ident(identation)}- 🥵 @${login}: **${issuesCount} issues**${suffix}`;
+// };
+
 const renderDeveloper = (
-  developer: IDeveloperWithIssuesCount,
+  developer: string,
   config: IConfig,
   identation = 0,
 ) => {
-  const { login, issuesCount } = developer
+  return `${ident(identation)}- @${developer}`;
+};
+
+const renderDevelopers = (developers: string[], config: IConfig, identation = 0) => {
+  const title = `${ident(identation)}- 🧑‍💻 **${developers.length}** developers`;
 
-  const daysLeft = getWorkDays(config);
-  const suffix = (daysLeft)
-    ? ` / **${(issuesCount / Math.max(1, daysLeft.businessDaysLeft)).toFixed(1)} per day left**`
-    : '';
+  // const devs = developers
+  //   .sort()
+  //   .map((developer) => {
+  //     return renderDeveloper(developer, config, identation + 1);
+  //   })
+  //   .join('\n');
 
-  return `${ident(identation)}- 🥵 @${login}: **${issuesCount} issues**${suffix}`;
+  return [
+    title,
+    // devs,
+  ].join('\n');
 };
 
-/**
- * Render the `🔭 Overview` section with project stats.
- */
-export const renderProjectOverview = (
-  config: IConfig,
-  projectWithData: IProjectWithData,
-): string => {
-  const { data } = projectWithData;
+const renderIssuesLoad = (stats: IProjectStats, config: IConfig, identation = 0) => {
   const {
-    developers,
     issuesDeveloperLeftRatio,
     issuesDeveloperRatio,
     issuesDayLeftRatio,
     issuesDayRatio,
     issuesDeveloperDayRatio,
     issuesDeveloperDayLeftRatio,
-    devWithMostAssignedIssues,
-  } = getProjectStats(data, config);
+    // devWithMostAssignedIssues,
+  } = stats;
+
+  // Load - 🔥 <b>high</b>
 
   return [
-    `- 📅 ${renderDaysLeft(config)}`,
-    `- 🧑‍💻 **${developers.length}** developers`,
-    renderDeveloper(devWithMostAssignedIssues, config, 1),
-    `- 🌡️ Issues load per:`,
-    renderPerLine('day', issuesDayLeftRatio, issuesDayRatio, 1),
+    '<details>',
+    '<summary>🌡️ <b>Load</b></summary>',
+    '',
+    renderPerLine('issues per day', issuesDayLeftRatio, issuesDayRatio),
     renderPerLine(
-      'developer',
+      'issues per developer',
       issuesDeveloperLeftRatio,
       issuesDeveloperRatio,
-      1,
     ),
     renderPerLine(
-      'developer/day',
+      'issues per developer/day',
       issuesDeveloperDayLeftRatio,
       issuesDeveloperDayRatio,
-      1,
     ),
+    '</details>',
+  ].join('\n');
+}
+
+/**
+ * Render the `🔭 Overview` section with project stats.
+ */
+export const renderProjectOverview = (
+  config: IConfig,
+  projectWithData: IProjectWithData,
+): string => {
+  const { data } = projectWithData;
+  const {
+    issuesToSolve,
+    allPlannedIssues,
+  } = data;
+  const stats = getProjectStats(data, config);
+
+  const {
+    developers,
+    // devWithMostAssignedIssues,
+  } = stats;
+
+  return [
+    `- 📅 ${renderDaysLeft(config)}`,
+    `- 🗒️ **${issuesToSolve.length}** issues left / **${allPlannedIssues.length}** total`,
+    renderDevelopers(developers, config),
+    renderIssuesLoad(stats, config),
   ].join('\n');
 };