feat: 'Review and check your Statuses' report now includes sample task lines

Author: claremacrae

src/Statuses/StatusRegistryReport.ts

@@ -1,7 +1,7 @@
 import type { StatusSettings } from '../Config/StatusSettings';
 import { i18n } from '../i18n/i18n';
 import type { StatusRegistry } from './StatusRegistry';
-import { tabulateStatusSettings } from './StatusSettingsReport';
+import { sampleTaskLinesForValidStatuses, tabulateStatusSettings } from './StatusSettingsReport';
 
 export function createStatusRegistryReport(
     statusSettings: StatusSettings,
@@ -17,6 +17,7 @@ export function createStatusRegistryReport(
     const detailed = true;
     const settingsTable = tabulateStatusSettings(statusSettings);
     const mermaidText = statusRegistry.mermaidDiagram(detailed);
+    const sampleTasksText = sampleTaskLinesForValidStatuses(statusSettings);
     return `# ${buttonName}
 
 ## ${i18n.t('reports.statusRegistry.about.title')}
@@ -46,5 +47,12 @@ ${settingsTable}
 <!-- ${i18n.t('reports.statusRegistry.loadedSettings.switchToLivePreview')} -->
 
 ${i18n.t('reports.statusRegistry.loadedSettings.settingsActuallyUsed')}
-${mermaidText}`;
+${mermaidText}
+
+## Sample Tasks
+
+Here is one example task line for each of the statuses actually used by tasks, for you to experiment with.
+
+${sampleTasksText.join('\n')}
+`;
 }

tests/Statuses/StatusRegistryReport.test.StatusRegistryReport_should_create_a_report.approved.md

@@ -61,3 +61,15 @@ classDef NON_TASK    stroke:#99e,stroke-width:3px;
 
 linkStyle default stroke:gray
 ```
+
+
+## Sample Tasks
+
+Here is one example task line for each of the statuses actually used by tasks, for you to experiment with.
+
+- [ ] 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='In Progress'
+- [-] Sample task 4: status symbol=`-` status name='Cancelled'
+- [Q] Sample task 5: status symbol=`Q` status name='Question'
+- [A] Sample task 6: status symbol=`A` status name='Answer'