Skip to content

Commit 19b1cfd

Browse files
committed
test: Generate block of help text for embedding in docs
1 parent 47ac1b2 commit 19b1cfd

File tree

2 files changed

+25
-1
lines changed

2 files changed

+25
-1
lines changed
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
<!-- placeholder to force blank line before included text -->
2+
3+
```text
4+
Cannot find preset "xxxx" in the Tasks settings
5+
The following presets are defined in the Tasks settings:
6+
hide_date_fields : # Hide any values for all date fields...
7+
hide_everything : # Hide everything except description and any tags...
8+
hide_non_date_fields: # Hide all the non-date fields, but not tags...
9+
hide_query_elements : # Hide postpone, edit and backinks...
10+
this_file : path includes {{query.file.path}}
11+
this_folder : folder includes {{query.file.folder}}
12+
this_folder_only : filter by function task.file.folder === query.file...
13+
this_root : root includes {{query.file.root}}
14+
```
15+
16+
<!-- placeholder to force blank line after included text -->

tests/Query/Presets/DocsForPresets.test.ts

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
import { MarkdownTable } from '../../../src/lib/MarkdownTable';
2-
import { defaultPresets } from '../../../src/Query/Presets/Presets';
2+
import { defaultPresets, unknownPresetErrorMessage } from '../../../src/Query/Presets/Presets';
33
import { addBackticks } from '../../Scripting/ScriptingTestHelpers';
44
import { verifyMarkdownForDocs } from '../../TestingTools/VerifyMarkdown';
5+
import { getSettings } from '../../../src/Config/Settings';
56

67
function verifyPresetsMarkdownTable(entries: [string, string][]) {
78
const table = new MarkdownTable(['Name', 'Instruction(s)']);
@@ -33,3 +34,10 @@ it('daily-note-presets', () => {
3334

3435
verifyPresetsMarkdownTable(Object.entries(dailyNotePresets));
3536
});
37+
38+
it('presets help message', () => {
39+
const { presets } = getSettings();
40+
const help = unknownPresetErrorMessage('xxxx', presets);
41+
const markdown = ['```text', help, '```'].join('\n');
42+
verifyMarkdownForDocs(markdown);
43+
});

0 commit comments

Comments
 (0)