refactor: Add any global filter to the status samples

Author: claremacrae

src/Statuses/StatusSettingsReport.ts

@@ -1,6 +1,7 @@
 import { StatusSettings } from '../Config/StatusSettings';
 import { MarkdownTable } from '../lib/MarkdownTable';
 import { i18n } from '../i18n/i18n';
+import { GlobalFilter } from '../Config/GlobalFilter';
 import { type StatusConfiguration, StatusType } from './StatusConfiguration';
 import { Status } from './Status';
 import { StatusRegistry } from './StatusRegistry';
@@ -123,16 +124,19 @@ export function tabulateStatusSettings(statusSettings: StatusSettings) {
  * @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.
+ * The Global Filter will be added, if it is non-empty.
  */
 export function sampleTaskLinesForValidStatuses(statusSettings: StatusSettings) {
     const statusRegistry = new StatusRegistry();
     StatusSettings.applyToStatusRegistry(statusSettings, statusRegistry);
     const registeredStatuses: StatusConfiguration[] = statusRegistry.registeredStatuses;
 
     return registeredStatuses.map((status, index) => {
+        const globalFilter = GlobalFilter.getInstance();
+        const globalFilterIfSet = globalFilter.isEmpty() ? '' : globalFilter.get() + ' ';
         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}`;
+        return `- [${status.symbol}] ${globalFilterIfSet}${intro}: ${symbol} ${name}`;
     });
 }

tests/Statuses/StatusSettingsReport.test.StatusSettingsReport_should_create_set_of_sample_task_lines_include_global_filter.approved.md

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

tests/Statuses/StatusSettingsReport.test.ts

@@ -4,11 +4,16 @@ import type { StatusCollection } from '../../src/Statuses/StatusCollection';
 import { verifyWithFileExtension } from '../TestingTools/ApprovalTestHelpers';
 import { coreStatusesData, createStatuses } from '../TestingTools/StatusesTestHelpers';
 import { initializeI18n } from '../../src/i18n/i18n';
+import { GlobalFilter } from '../../src/Config/GlobalFilter';
 
 beforeAll(async () => {
     await initializeI18n();
 });
 
+afterEach(() => {
+    GlobalFilter.getInstance().reset();
+});
+
 describe('StatusSettingsReport', () => {
     it('should tabulate StatusSettings', () => {
         const statusSettings = new StatusSettings();
@@ -50,4 +55,12 @@ describe('StatusSettingsReport', () => {
         const taskLines = sampleTaskLinesForValidStatuses(statusSettings);
         verifyWithFileExtension(taskLines.join('\n'), '.md');
     });
+
+    it('should create set of sample task lines include global filter', () => {
+        GlobalFilter.getInstance().set('#task');
+        const { statusSettings } = createStatuses(coreStatusesData, customStatusesDataForSampleLines);
+
+        const taskLines = sampleTaskLinesForValidStatuses(statusSettings);
+        verifyWithFileExtension(taskLines.join('\n'), '.md');
+    });
 });