todo,todo-backend: add tag field to TodoItems

Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>

plugins/todo-backend/src/lib/TodoReader/TodoScmReader.ts

@@ -96,8 +96,9 @@ export class TodoScmReader implements TodoReader {
         });
 
         todos.push(
-          ...items.map(({ lineNumber, text, author }) => ({
+          ...items.map(({ lineNumber, text, tag, author }) => ({
             text,
+            tag,
             author,
             lineNumber,
             repoFilePath: file.path,

plugins/todo-backend/src/lib/TodoReader/createTodoParser.ts

@@ -34,6 +34,7 @@ export function createTodoParser(options: TodoParserOptions = {}): TodoParser {
 
       return comments.map(comment => ({
         text: comment.text,
+        tag: comment.tag,
         author: comment.ref,
         lineNumber: comment.line,
       }));

plugins/todo-backend/src/lib/TodoReader/types.ts

@@ -18,6 +18,9 @@ export type TodoItem = {
   /** The contents of the TODO comment */
   text: string;
 
+  /** The tag used, e.g. TODO, FIXME */
+  tag: string;
+
   /** References author, if any */
   author?: string;
 
@@ -59,6 +62,7 @@ type TodoParserContext = {
 
 type TodoParserResult = {
   text: string;
+  tag: string;
   author?: string;
   lineNumber: number;
 };

plugins/todo-backend/src/service/router.test.ts

@@ -21,7 +21,7 @@ import { createRouter } from './router';
 import { TodoService } from './types';
 
 const mockListBody = {
-  items: [{ text: 'my todo' }],
+  items: [{ text: 'my todo', tag: 'TODO' }],
   totalCount: 1,
   offset: 0,
   limit: 10,

plugins/todo-backend/src/service/router.ts

@@ -22,6 +22,7 @@ import { TodoService } from './types';
 
 const ALLOWED_ORDER_BY_FIELDS = [
   'text',
+  'tag',
   'author',
   'viewUrl',
   'repoFilePath',

plugins/todo-backend/src/service/types.ts

@@ -22,7 +22,7 @@ export type ListTodosRequest = {
   offset?: number;
   limit?: number;
   orderBy?: {
-    field: 'text' | 'author' | 'viewUrl' | 'repoFilePath';
+    field: 'text' | 'tag' | 'author' | 'viewUrl' | 'repoFilePath';
     direction: 'asc' | 'desc';
   };
 };