render labels once

Author: legomushroom

src/interfaces/IProjectWithConfig.ts

@@ -1,7 +1,9 @@
+import { IParsedRepo } from './IParsedRepo';
 import { TProject } from './TProject';
 import { TProjectConfig } from './TProjetConfig';
 
 export interface IProjectWithConfig {
   project: TProject;
   projectConfig: TProjectConfig;
+  repo: IParsedRepo;
 }

src/octokit/ProjectsOctoKit.ts

@@ -69,6 +69,7 @@ export class ProjectsOctoKit extends OctoKitBase {
         return {
           project,
           projectConfig: proj,
+          repo,
         };
       })
       .filter(notEmpty);

src/utils/cardLink.ts

@@ -0,0 +1,7 @@
+import { IProjectWithConfig } from '../interfaces/IProjectWithConfig';
+import { TColumnCard } from '../interfaces/TColumnCard';
+import { projectLink } from './projectLink';
+
+export const cardLink = (card: TColumnCard, projectWithConfig: IProjectWithConfig) => {
+  return `${projectLink(projectWithConfig)}#card-${card.id}`;
+};

src/utils/projectLink.ts

@@ -0,0 +1,7 @@
+import { IProjectWithConfig } from '../interfaces/IProjectWithConfig';
+import { repoUrl } from './repoUrl';
+
+export const projectLink = (projectWithConfig: IProjectWithConfig) => {
+  const { project, repo } = projectWithConfig;
+  return `${repoUrl(repo)}/projects/${project.number}`;
+};

src/utils/repoUrl.ts

@@ -0,0 +1,5 @@
+import { IParsedRepo } from '../interfaces/IParsedRepo';
+
+export const repoUrl = (repo: IParsedRepo) => {
+  return `https://github.com/${repo.owner}/${repo.repo}`;
+};

src/views/renderIssue.ts

@@ -1,8 +1,25 @@
 import { ICardWithIssue } from '../interfaces/ICardWithIssue';
 import { IIssueState } from '../interfaces/IIssueState';
+import { IProjectWithConfig } from '../interfaces/IProjectWithConfig';
 import { TColumnTypes } from '../interfaces/TColumnTypes';
+import { TProjectConfig } from '../interfaces/TProjetConfig';
 import { pluck } from '../utils/pluck';
 import { ident } from './ident';
+import { cardLink } from '../utils/cardLink';
+
+
+const isDoneColumn = (column: TColumnTypes) => {
+  switch (column) {
+    case TColumnTypes.WaitingToDeploy:
+    case TColumnTypes.Done: {
+      return true;
+    }
+
+    default: {
+      return false;
+    }
+  }
+}
 
 const emojiIcon = (icon: string, title?: string) => {
   const iconString = `${icon}${ident(1)}`;
@@ -89,41 +106,41 @@ const renderAssignees = (cardWithIssue: ICardWithIssue) => {
 
 const renderItemIssueStatus = (
   cardWithIssue: ICardWithIssue,
+  column: TColumnTypes,
   asCheckList: boolean,
 ) => {
   if (!asCheckList) {
     return '';
   }
 
-  const { issue, card } = cardWithIssue;
+  const { issue } = cardWithIssue;
 
   if (!issue) {
-    return !card.archived ? '[ ] ' : '[x] ';
+    return !isDoneColumn(column) ? '[ ] ' : '[x] ';
   }
 
   return issue.state === IIssueState.Open ? '[ ] ' : '[x] ';
 };
 
 export const renderIssue = (
-  column: TColumnTypes,
   cardWithIssue: ICardWithIssue,
+  projectWithConfig: IProjectWithConfig,
   asCheckList = false,
 ) => {
-
-  const { issue, card } = cardWithIssue;
+  const { column, issue, card } = cardWithIssue;
 
   const title = (!issue)
     ? card.note
     : issue.title;
 
-    const url = (!issue)
-    ? card.content_url
+  const url = (!issue)
+    ? `[#card-${card.id}](${cardLink(card, projectWithConfig)})`
     : issue.html_url;
 
   const assignees = renderAssignees(cardWithIssue);
   const stateEmoji = mapColumnToEmoji(column);
   const bugEmoji = mapIssueTypeToEmoji(cardWithIssue);
-  const issueStatus = renderItemIssueStatus(cardWithIssue, asCheckList);
+  const issueStatus = renderItemIssueStatus(cardWithIssue, column, asCheckList);
 
   return `- ${issueStatus}${stateEmoji}${bugEmoji}${title} ${url} ${assignees}`;
 };

src/views/renderIssuesBlock.ts

@@ -6,6 +6,7 @@ import { notEmpty } from '../utils/notEmpty';
 import { capitalize } from '../utils/capitalize';
 import { TProjectConfig } from '../interfaces/TProjetConfig';
 import { ICardWithIssue } from '../interfaces/ICardWithIssue';
+import { IProjectWithConfig } from '../interfaces/IProjectWithConfig';
 
 type TLabeledIssues = Record<string, ICardWithIssue[]>;
 
@@ -39,17 +40,30 @@ const sortIssuesListByUsername = (cardsWithIssue: ICardWithIssue[]) => {
 
 const getIssuesForLabel = (
   label: string,
+  labels: string[],
   cardsWithIssue: ICardWithIssue[],
 ): ICardWithIssue[] => {
   const result = cardsWithIssue.filter(({ issue }) => {
     if (!issue) {
       return false;
     }
 
+    const firstLabelFromTheList = issue.labels.find((issueLabel) => {
+      return labels.includes(issueLabel.name);
+    });
+
     const foundLabel = issue.labels.find((issueLabel) => {
       return issueLabel.name === label;
     });
 
+    /**
+     * The `labels` array has the descending priority for the defined labels,
+     * hence if the found label is not the first in the list, dont use it
+     */
+    if (firstLabelFromTheList !== foundLabel) {
+      return false;
+    }
+
     return !!foundLabel;
   });
 
@@ -58,17 +72,19 @@ const getIssuesForLabel = (
 
 const groupIssuesByLabels = (
   issues: ICardWithIssue[],
-  projectConfig: TProjectConfig,
+  projectWithConfig: IProjectWithConfig,
 ): TLabeledIssues => {
   const result: TLabeledIssues = {};
+  const { projectConfig } = projectWithConfig;
 
-  const labels =
-    typeof projectConfig === 'number' ? [] : projectConfig.trackLabels ?? [];
+  const labels = typeof projectConfig === 'number'
+    ? []
+    : projectConfig.trackLabels ?? [];
 
   const includedIssues = new Set<ICardWithIssue>();
   for (let label of labels) {
     const issuesForLabel = sortIssuesListByUsername(
-      getIssuesForLabel(label, issues),
+      getIssuesForLabel(label, labels, issues),
     );
 
     result[label] = issuesForLabel;
@@ -94,9 +110,10 @@ const renderTitle = (title: string) => {
 
 const renderIssuesSection = (
   cardsWithIssues: ICardWithIssue[],
-  projectConfig: TProjectConfig,
+  projectWithConfig: IProjectWithConfig,
   title?: string,
 ) => {
+  const { projectConfig } = projectWithConfig;
   const issueItems = [title];
 
   const isCheckList =
@@ -105,8 +122,7 @@ const renderIssuesSection = (
       : projectConfig.isCheckListItems;
 
   for (let cardWithIssue of cardsWithIssues) {
-    const { column } = cardWithIssue;
-    const item = renderIssue(column, cardWithIssue, isCheckList);
+    const item = renderIssue(cardWithIssue, projectWithConfig, isCheckList);
     issueItems.push(`${ident(0)}${item}`);
   }
 
@@ -115,9 +131,10 @@ const renderIssuesSection = (
 
 const renderIssuesList = (
   issues: ICardWithIssue[],
-  projectConfig: TProjectConfig,
+  projectWithConfig: IProjectWithConfig,
 ) => {
-  const issueGroups = groupIssuesByLabels(issues, projectConfig);
+  const { projectConfig } = projectWithConfig;
+  const issueGroups = groupIssuesByLabels(issues, projectWithConfig);
 
   const items = Object.entries(issueGroups)
     // make the general section to be first in the lsit
@@ -141,7 +158,7 @@ const renderIssuesList = (
         ? undefined
         : `\n**${capitalize(labelName)}**`;
 
-      return renderIssuesSection(issues, projectConfig, title);
+      return renderIssuesSection(issues, projectWithConfig, title);
     });
 
   return items.filter(notEmpty).join('\n');
@@ -150,7 +167,7 @@ const renderIssuesList = (
 export const renderIssuesBlock = (
   title: string,
   issues: ICardWithIssue[],
-  projectConfig: TProjectConfig,
+  projectConfig: IProjectWithConfig,
   /**
    * if there is no issues in the list, should we render the title?
    * For some of the blocks, for instance the `In work`, it makes

src/views/renderProject.ts

@@ -32,34 +32,33 @@ export const renderProject = (
 
   const {
     project,
-    projectConfig,
   } = projectWithConfig;
 
   const blockedIssuesString = renderIssuesBlock(
     `⚠️  ${blockedIssues.length} Blocked`,
     blockedIssues,
-    projectConfig,
+    projectWithConfig,
     false,
   );
 
   const inWorkCount = `${inWorkIssues.length}/${allPlannedIssues.length}`;
   const inWorkIssuesString = renderIssuesBlock(
     `🏃  ${inWorkCount} In work (${rateToPercent(inWorkRate)})`,
     inWorkIssues,
-    projectConfig,
+    projectWithConfig,
   );
 
   const committedIssuesString = renderIssuesBlock(
     `💪 ${committedIssues.length} Committed (${rateToPercent(committedRate)})`,
     committedIssues,
-    projectConfig,
+    projectWithConfig,
   );
 
   const doneCount = `${doneOrDeployIssues.length}/${allPlannedIssues.length}`;
   const doneIssuesString = renderIssuesBlock(
     `🙌 ${doneCount} Done (${rateToPercent(doneRate)})`,
     doneOrDeployIssues,
-    projectConfig,
+    projectWithConfig,
   );
 
   const projectTitle = `## ${project.name} - ${rateToPercent(doneRate)} done`;