Add comment template

README.md

@@ -48,8 +48,13 @@ comments found.
 You can configure the action further by providing inputs:
 
 - `token`: The GitHub token to use for commenting on the PR. This is required.
-- `exclude`: A list of glob patterns to exclude from the search. This is
-  optional.
+- `exclude`: (**optional**) A list of glob patterns to exclude from the search.
+- `comment_on_todo`: (**optional**) Whether to comment on the PR with the TODOs
+  found. Default is `true`.
+- `comment_body`: (**optional**) The body of the comment to post on the PR. Use
+  `{todo}` to insert the Todo content.
+- `comment_checkbox`: (**optional**) The text to use for the checkbox in the
+  comment. Use `{todo}` to insert the Todo content
 
 ```yaml
 steps:
@@ -63,4 +68,8 @@ steps:
       exclude: |
         *.md
         **/config/*.yml
+      comment_on_todo: true
+      comment_body: |
+        'A new Todo was discovered. If it is not a priority right now, consider marking it for later attention.\n{todo}\n'
+      comment_checkbox: 'Ignore'
 ```

__test__/main.test.ts

@@ -1,4 +1,5 @@
-import { findTodos } from '../src/tools'
+import exp from 'constants'
+import { findTodos, generateComment } from '../src/tools'
 import { Todo } from '../src/types'
 import { excludeFilesPrDiff, todoPrDiff } from './test_data'
 
@@ -69,3 +70,32 @@ describe('extractTodos', () => {
     expect(fileTodos).toEqual(expectedTodos)
   })
 })
+
+describe('setting comment body and checkbox', () => {
+  it('should be used correctly', () => {
+    const commentBodyTemplate = `A new Todo was discovered. If it is not a priority right now, consider marking it for later attention.\n{todo}\n`
+    const commentCheckboxTemplate = 'Ignore'
+
+    const todo = {
+      filename: 'included/other.txt',
+      line: 22,
+      content: 'TODO - in included directory',
+      isAdded: true
+    }
+
+    const comment = generateComment(
+      commentBodyTemplate,
+      commentCheckboxTemplate,
+      todo
+    )
+
+    const expectedComment = [
+      'A new Todo was discovered. If it is not a priority right now, consider marking it for later attention.',
+      'TODO - in included directory',
+      '',
+      '- [ ] Ignore'
+    ].join('\n')
+
+    expect(comment).toEqual(expectedComment)
+  })
+})

action.yml

@@ -10,6 +10,23 @@ inputs:
     description:
       'Exclude file patterns. User list of globs separated by new line.'
     required: false
+  comment_on_todo:
+    description: 'Comment on the TODO in the PR'
+    required: false
+    default: 'true'
+  comment_body:
+    description:
+      'Comment body to use when a TODO is found. Use {todo} to insert the TODO
+      message.'
+    required: false
+    default: "A new Todo was discovered. If it is not a priority right now,\
+      consider marking it for later attention.\n{todo}\n"
+  comment_checkbox:
+    description:
+      'Checkbox message to ignore the TODO. Use {todo} to insert the TODO
+      message.'
+    required: false
+    default: 'Ignore'
 
 runs:
   using: 'node20'

dist/index.js

@@ -29302,6 +29302,9 @@ function run() {
             const token = core.getInput('token');
             // Get the user's glbbing input and split it into an array of patterns
             const excludePatterns = core.getInput('exclude').split('\n');
+            const commentOnTodo = core.getInput('comment_on_todo') === 'true';
+            const commentBodyTemplate = core.getInput('comment_body');
+            const commentCheckboxTemplate = core.getInput('comment_checkbox');
             const octokit = github.getOctokit(token);
             const botName = 'github-actions[bot]';
             const pr = github.context.payload.pull_request;
@@ -29318,11 +29321,11 @@ function run() {
                 console.log('Comment change detected');
                 yield updateCommitStatus(octokit, pr.number, botName);
             }
-            else {
+            else if (commentOnTodo) {
                 const prDiff = yield getPrDiff(octokit, pr.base.sha, pr.head.sha);
                 const todos = (0, tools_1.findTodos)(prDiff, excludePatterns);
                 console.log('Todos:', JSON.stringify(todos));
-                yield commentPr(octokit, pr.number, botName, todos);
+                yield commentPr(octokit, pr.number, botName, todos, commentBodyTemplate, commentCheckboxTemplate);
             }
         }
         catch (error) {
@@ -29349,7 +29352,7 @@ function getPrDiff(octokit, base, head) {
         return ((_a = response === null || response === void 0 ? void 0 : response.data) === null || _a === void 0 ? void 0 : _a.files) || [];
     });
 }
-function commentPr(octokit, prNumber, botName, todos) {
+function commentPr(octokit, prNumber, botName, todos, commentBodyTemplate, commentCheckboxTemplate) {
     return __awaiter(this, void 0, void 0, function* () {
         var _a, _b;
         const { owner, repo } = github.context.repo;
@@ -29391,7 +29394,7 @@ function commentPr(octokit, prNumber, botName, todos) {
                 owner,
                 repo,
                 pull_number: prNumber,
-                body: (0, tools_1.generateComment)(todo),
+                body: (0, tools_1.generateComment)(commentBodyTemplate, commentCheckboxTemplate, todo),
                 commit_id: headSha,
                 path: todo.filename,
                 side: 'RIGHT',
@@ -29526,14 +29529,14 @@ function getTodoIfFound(line) {
         return;
     return match[1];
 }
-function generateComment(todo) {
-    let comment = 'A new Todo was found. If you want to fix it later on, mark it as ignore.\n';
-    comment += `*${todo.content}*\n`;
+function generateComment(bodyTemplate, checkboxTemplate, todo) {
+    let comment = bodyTemplate.replace('{todo}', todo.content);
+    comment += '\n';
     if (todo.isAdded) {
-        comment += `- [ ] Ignore`;
+        comment += `- [ ] ${checkboxTemplate.replace('{todo}', todo.content)}`;
     }
     else {
-        comment += `- [x] Ignore`;
+        comment += `- [x] ${checkboxTemplate.replace('{todo}', todo.content)}`;
     }
     console.log(comment);
     return comment;

src/main.ts

@@ -9,6 +9,9 @@ export async function run(): Promise<void> {
 
     // Get the user's glbbing input and split it into an array of patterns
     const excludePatterns = core.getInput('exclude').split('\n')
+    const commentOnTodo = core.getInput('comment_on_todo') === 'true'
+    const commentBodyTemplate = core.getInput('comment_body')
+    const commentCheckboxTemplate = core.getInput('comment_checkbox')
 
     const octokit = github.getOctokit(token)
     const botName = 'github-actions[bot]'
@@ -30,12 +33,19 @@ export async function run(): Promise<void> {
       console.log('User:', user)
       console.log('Comment change detected')
       await updateCommitStatus(octokit, pr.number, botName)
-    } else {
+    } else if (commentOnTodo) {
       const prDiff = await getPrDiff(octokit, pr.base.sha, pr.head.sha)
 
       const todos = findTodos(prDiff, excludePatterns)
       console.log('Todos:', JSON.stringify(todos))
-      await commentPr(octokit, pr.number, botName, todos)
+      await commentPr(
+        octokit,
+        pr.number,
+        botName,
+        todos,
+        commentBodyTemplate,
+        commentCheckboxTemplate
+      )
     }
   } catch (error) {
     if (error instanceof Error) {
@@ -67,7 +77,9 @@ async function commentPr(
   octokit: ReturnType<typeof github.getOctokit>,
   prNumber: number,
   botName: string,
-  todos: Todo[]
+  todos: Todo[],
+  commentBodyTemplate: string,
+  commentCheckboxTemplate: string
 ): Promise<void> {
   const { owner, repo } = github.context.repo
   const issueNumber = github.context.payload.pull_request?.number
@@ -119,7 +131,7 @@ async function commentPr(
       owner,
       repo,
       pull_number: prNumber,
-      body: generateComment(todo),
+      body: generateComment(commentBodyTemplate, commentCheckboxTemplate, todo),
       commit_id: headSha,
       path: todo.filename,
       side: 'RIGHT',

src/tools.ts

@@ -55,14 +55,17 @@ function getTodoIfFound(line: string): string | undefined {
   return match[1]
 }
 
-export function generateComment(todo: Todo): string {
-  let comment =
-    'A new Todo was found. If you want to fix it later on, mark it as ignore.\n'
-  comment += `*${todo.content}*\n`
+export function generateComment(
+  bodyTemplate: string,
+  checkboxTemplate: string,
+  todo: Todo
+): string {
+  let comment = bodyTemplate.replace('{todo}', todo.content)
+  comment += '\n'
   if (todo.isAdded) {
-    comment += `- [ ] Ignore`
+    comment += `- [ ] ${checkboxTemplate.replace('{todo}', todo.content)}`
   } else {
-    comment += `- [x] Ignore`
+    comment += `- [x] ${checkboxTemplate.replace('{todo}', todo.content)}`
   }
   console.log(comment)
   return comment