refactor: Add sampleTaskLinesForValidStatuses()

Author: claremacrae

src/Statuses/StatusSettingsReport.ts

@@ -1,9 +1,9 @@
 import { StatusSettings } from '../Config/StatusSettings';
 import { MarkdownTable } from '../lib/MarkdownTable';
 import { i18n } from '../i18n/i18n';
-import type { StatusConfiguration } from './StatusConfiguration';
-import { StatusType } from './StatusConfiguration';
+import { type StatusConfiguration, StatusType } from './StatusConfiguration';
 import { Status } from './Status';
+import { StatusRegistry } from './StatusRegistry';
 
 function getFirstIndex(statusConfigurations: StatusConfiguration[], wantedSymbol: string) {
     return statusConfigurations.findIndex((s) => s.symbol === wantedSymbol);
@@ -114,3 +114,25 @@ export function tabulateStatusSettings(statusSettings: StatusSettings) {
     });
     return table.markdown;
 }
+
+/**
+ * Generates a list of Markdown lines, containing sample tasks based on the given status settings.
+ *
+ * @param {StatusSettings} statusSettings - The settings object containing custom and core statuses.
+ *
+ * @returns {string[]} An array of markdown strings representing sample tasks.
+ * Each task includes a symbol, an introductory text, and the name of the status.
+ * Only the actually registered symbols are used; duplicate and empty symbols are ignored.
+ */
+export function sampleTaskLinesForValidStatuses(statusSettings: StatusSettings) {
+    const statusRegistry = new StatusRegistry();
+    StatusSettings.applyToStatusRegistry(statusSettings, statusRegistry);
+    const registeredStatuses: StatusConfiguration[] = statusRegistry.registeredStatuses;
+
+    return registeredStatuses.map((status, index) => {
+        const intro = `Sample task ${index + 1}`;
+        const symbol = `status symbol=${getPrintableSymbol(status.symbol)}`;
+        const name = `status name='${status.name}'`;
+        return `- [${status.symbol}] ${intro}: ${symbol} ${name}`;
+    });
+}

tests/Statuses/StatusSettingsReport.test.StatusSettingsReport_should_create_set_of_sample_task_lines,_excluding_duplicate_and_empty_symbols.approved.md

@@ -0,0 +1,4 @@
+- [ ] Sample task 1: status symbol=`space` status name='Todo'
+- [x] Sample task 2: status symbol=`x` status name='Done'
+- [/] Sample task 3: status symbol=`/` status name='A slash'
+- [p] Sample task 4: status symbol=`p` status name='A p'

tests/Statuses/StatusSettingsReport.test.ts

@@ -1,5 +1,5 @@
 import { StatusSettings } from '../../src/Config/StatusSettings';
-import { tabulateStatusSettings } from '../../src/Statuses/StatusSettingsReport';
+import { sampleTaskLinesForValidStatuses, tabulateStatusSettings } from '../../src/Statuses/StatusSettingsReport';
 import type { StatusCollection } from '../../src/Statuses/StatusCollection';
 import { verifyWithFileExtension } from '../TestingTools/ApprovalTestHelpers';
 import { coreStatusesData, createStatuses } from '../TestingTools/StatusesTestHelpers';
@@ -36,4 +36,17 @@ describe('StatusSettingsReport', () => {
         const markdown = tabulateStatusSettings(statusSettings);
         verifyWithFileExtension(markdown, '.md');
     });
+
+    it('should create set of sample task lines, excluding duplicate and empty symbols', () => {
+        const customStatusesData: StatusCollection = [
+            ['/', 'A slash', 'x', 'IN_PROGRESS'],
+            ['/', 'In Progress DUPLICATE - SHOULD NOT BE IN SAMPLE TASK LINES', 'x', 'IN_PROGRESS'],
+            ['', 'EMPTY STATUS SYMBOL - SHOULD NOT BE IN SAMPLE TASK LINES', '', 'TODO'],
+            ['p', 'A p', 'q', 'TODO'],
+        ];
+        const { statusSettings } = createStatuses(coreStatusesData, customStatusesData);
+
+        const taskLines = sampleTaskLinesForValidStatuses(statusSettings);
+        verifyWithFileExtension(taskLines.join('\n'), '.md');
+    });
 });