feat: use PR title for current node in render (#73)

Author: tranhl

.editorconfig-checker

@@ -1,5 +1,4 @@
 {
-  "Version": "v3.4.1",
   "Verbose": false,
   "Debug": false,
   "IgnoreDefaults": false,

.eslintrc.cjs

@@ -34,5 +34,13 @@ module.exports = {
     '@typescript-eslint/array-type': ['error', { default: 'array-simple' }],
     '@typescript-eslint/require-await': 'off',
     'import/no-extraneous-dependencies': 'off'
-  }
+  },
+  overrides: [
+    {
+      files: ['**/*.config.*'],
+      rules: {
+        'import/no-default-export': 'off',
+      },
+    },
+  ],
 };

.github/workflows/git-town.yml

@@ -3,7 +3,7 @@ name: Git Town
 on:
   pull_request:
     branches:
-      - '**'
+      - "**"
 
 concurrency:
   group: git-town-${{ github.sha }}

.node-version

@@ -1 +1 @@
-20.5.1
+24.1.0

dist/index.js

@@ -42769,10 +42769,12 @@ function renderVisualization(graph, terminatingRefs) {
         line += `- \`${stackNode.ref}\``;
       }
       if (stackNode.type === "pull-request") {
-        line += `- #${stackNode.number}`;
-      }
-      if (stackNode.isCurrent) {
-        line += " :point_left:";
+        if (stackNode.isCurrent) {
+          line += `- **${stackNode.title}**`;
+          line += " :point_left:";
+        } else {
+          line += `- #${stackNode.number}`;
+        }
       }
       if (depth === 0) {
         line += ` ${ANCHOR}`;
@@ -46891,7 +46893,8 @@ var pullRequestSchema = objectType({
     ref: stringType()
   }),
   state: stringType(),
-  body: stringType().optional().nullable()
+  body: stringType().optional().nullable(),
+  title: stringType()
 });
 
 // src/locations/types.ts
@@ -47012,6 +47015,7 @@ var inputs = {
         base: { ref: item.base.ref },
         head: { ref: item.head.ref },
         body: item.body ?? void 0,
+        title: item.title,
         state: item.state
       };
     }

src/inputs.test.ts

@@ -136,6 +136,7 @@ describe('getCurrentPullRequest', () => {
           number: 100,
           base: { ref: 'main' },
           head: { ref: 'feat/git-town-action' },
+          title: 'feat: git town action',
           state: 'open',
         },
       },
@@ -147,6 +148,7 @@ describe('getCurrentPullRequest', () => {
       number: 100,
       base: { ref: 'main' },
       head: { ref: 'feat/git-town-action' },
+      title: 'feat: git town action',
       state: 'open',
     })
   })

src/inputs.ts

@@ -161,6 +161,7 @@ export const inputs = {
         base: { ref: item.base.ref },
         head: { ref: item.head.ref },
         body: item.body ?? undefined,
+        title: item.title,
         state: item.state,
       }
     }

src/renderer.test.ts

@@ -16,6 +16,7 @@ describe('getOutput', () => {
       },
       state: 'TODO',
       body: 'pr 1 body',
+      title: 'feat: implement feature 1',
     }
     const pullRequest2: PullRequest = {
       number: 2,
@@ -27,6 +28,7 @@ describe('getOutput', () => {
       },
       state: 'TODO',
       body: 'pr 2 body',
+      title: 'feat: implement feature 2',
     }
     const repoGraph = new DirectedGraph<StackNodeAttributes>()
     repoGraph.mergeNode('main', { type: 'perennial', ref: 'main' })
@@ -46,7 +48,7 @@ describe('getOutput', () => {
     const visualization = renderVisualization(stackGraph, ['main'])
     const expected = [
       '- `main` <!-- branch-stack -->',
-      '  - #1 :point_left:',
+      '  - **feat: implement feature 1** :point_left:',
       '    - #2',
     ].join('\n')
 

src/renderer.ts

@@ -44,13 +44,16 @@ export function renderVisualization(
       }
 
       if (stackNode.type === 'pull-request') {
-        line += `- #${stackNode.number}`
-      }
-
-      if (stackNode.isCurrent) {
-        line += ' :point_left:'
+        if (stackNode.isCurrent) {
+          line += `- **${stackNode.title}**`
+          line += ' :point_left:'
+        } else {
+          line += `- #${stackNode.number}`
+        }
       }
 
+      // Attach anchor tag to root of visualization to enable subsequent runs to locate
+      // visualization directly
       if (depth === 0) {
         line += ` ${ANCHOR}`
       }

src/types.ts

@@ -15,6 +15,7 @@ export const pullRequestSchema = object({
   }),
   state: string(),
   body: string().optional().nullable(),
+  title: string(),
 })
 export type PullRequest = InferType<typeof pullRequestSchema>