feat(config): show default keybindings in generated example config (#64)

- Expand `keybindings` array in `config.example.jsonc` to list all built-in defaults instead of `[]`
- Inject `DEFAULT_KEYBINDINGS` into template when resolved config has an empty keybindings array
- Add regression tests for template parity, default binding compile/action mapping, overlay keyboard dispatch, and mpv plugin registration/dispatch
- Add fullscreen binding to docs shortcut tables and clarify keybindings can target mpv commands or session actions
This commit is contained in:
2026-05-12 23:11:51 -07:00
committed by GitHub
parent 7c9b65db8b
commit d48d880ba3
12 changed files with 665 additions and 40 deletions
+16 -1
View File
@@ -4,7 +4,13 @@ import * as fs from 'fs';
import * as os from 'os';
import * as path from 'path';
import { ConfigService, ConfigStartupParseError } from './service';
import { DEFAULT_CONFIG, RUNTIME_OPTION_REGISTRY, deepMergeRawConfig } from './definitions';
import {
DEFAULT_CONFIG,
DEFAULT_KEYBINDINGS,
RUNTIME_OPTION_REGISTRY,
deepMergeRawConfig,
} from './definitions';
import { parseConfigContent } from './parse';
import { generateConfigTemplate } from './template';
function makeTempDir(): string {
@@ -2218,3 +2224,12 @@ test('template generator includes known keys', () => {
/"launchAtStartup": true,? \/\/ Launch texthooker server automatically when SubMiner starts\. Values: true \| false/,
);
});
test('template generator shows built-in default keybindings in the keybindings array', () => {
const output = generateConfigTemplate(DEFAULT_CONFIG);
const parsed = parseConfigContent('config.example.jsonc', output) as {
keybindings?: unknown;
};
assert.deepEqual(parsed.keybindings, DEFAULT_KEYBINDINGS);
});
+1 -1
View File
@@ -62,7 +62,7 @@ const CORE_TEMPLATE_SECTIONS: ConfigTemplateSection[] = [
{
title: 'Keybindings (MPV Commands)',
description: [
'Extra keybindings that are merged with built-in defaults.',
'Default and custom keybindings that are merged with built-in defaults.',
'Set command to null to disable a default keybinding.',
],
notes: [
+14 -1
View File
@@ -3,6 +3,7 @@ import {
CONFIG_OPTION_REGISTRY,
CONFIG_TEMPLATE_SECTIONS,
DEFAULT_CONFIG,
DEFAULT_KEYBINDINGS,
deepCloneConfig,
} from './definitions';
@@ -103,9 +104,21 @@ function renderSection(
return lines.join('\n');
}
function createTemplateConfig(config: ResolvedConfig): ResolvedConfig {
const templateConfig = deepCloneConfig(config);
if (templateConfig.keybindings.length === 0) {
templateConfig.keybindings = DEFAULT_KEYBINDINGS.map((binding) => ({
key: binding.key,
command: binding.command === null ? null : [...binding.command],
}));
}
return templateConfig;
}
export function generateConfigTemplate(
config: ResolvedConfig = deepCloneConfig(DEFAULT_CONFIG),
): string {
const templateConfig = createTemplateConfig(config);
const lines: string[] = [];
lines.push('/**');
lines.push(' * SubMiner Example Configuration File');
@@ -123,7 +136,7 @@ export function generateConfigTemplate(
lines.push(
renderSection(
section.key,
config[section.key],
templateConfig[section.key],
index === CONFIG_TEMPLATE_SECTIONS.length - 1,
comments,
),