Skip to content

feat: Add i18n support & French translation (Settings, Builders, Macros) #1072

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Amato21 wants to merge 27 commits into
base: master
Choose a base branch
from
Open

feat: Add i18n support & French translation (Settings, Builders, Macros) #1072

Show file tree
Hide file tree
Changes from 22 commits
Commits
Show all changes
27 commits
Select commit Hold shift + click to select a range
c3edc3c
Create i18n.ts
Amato21 Dec 29, 2025
d0e267d
Create en.json
Amato21 Dec 29, 2025
cd79889
Create fr.json
Amato21 Dec 29, 2025
68670b9
Update main.ts
Amato21 Dec 29, 2025
9d74da8
Update quickAddSettingsTab.ts
Amato21 Dec 29, 2025
7057755
Update choiceBuilder.ts
Amato21 Dec 29, 2025
46d9fa1
Update en.json
Amato21 Dec 29, 2025
574ab2f
Update fr.json
Amato21 Dec 29, 2025
472a09b
Update quickAddSettingsTab.ts
Amato21 Dec 29, 2025
2726430
Update choiceBuilder.ts
Amato21 Dec 29, 2025
1219866
Update fr.json
Amato21 Dec 29, 2025
3daf652
Update en.json
Amato21 Dec 29, 2025
11540d6
Update quickAddSettingsTab.ts
Amato21 Dec 29, 2025
ff6221d
Update choiceBuilder.ts
Amato21 Dec 29, 2025
c9529c4
Update fr.json
Amato21 Dec 29, 2025
4abcadc
Update en.json
Amato21 Dec 29, 2025
9e6dc44
Update templateChoiceBuilder.ts
Amato21 Dec 29, 2025
36b61ce
Update captureChoiceBuilder.ts
Amato21 Dec 29, 2025
9ff7cfc
Update tsconfig.json
Amato21 Dec 29, 2025
90199ad
Update fr.json
Amato21 Dec 29, 2025
4ede40f
Update en.json
Amato21 Dec 29, 2025
6ca0f37
Update MacroBuilder.ts
Amato21 Dec 29, 2025
fd937b8
Update en.json
Amato21 Dec 29, 2025
80c4773
Update fr.json
Amato21 Dec 29, 2025
746360f
Update captureChoiceBuilder.ts
Amato21 Dec 29, 2025
f8d1451
Update main.ts
Amato21 Dec 29, 2025
c90d015
Update quickAddSettingsTab.ts
Amato21 Dec 29, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
129 changes: 58 additions & 71 deletions src/gui/ChoiceBuilder/captureChoiceBuilder.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ import {
import { createValidatedInput } from "../components/validatedInput";
import { FormatSyntaxSuggester } from "../suggesters/formatSyntaxSuggester";
import { ChoiceBuilder } from "./choiceBuilder";
import { t } from "../../i18n/i18n";

export class CaptureChoiceBuilder extends ChoiceBuilder {
choice: ICaptureChoice;
Expand All @@ -40,7 +41,7 @@ export class CaptureChoiceBuilder extends ChoiceBuilder {
this.addCenteredChoiceNameHeader(this.choice);

// Location
new Setting(this.contentEl).setName("Location").setHeading();
new Setting(this.contentEl).setName(t("builder.common.location")).setHeading();
this.addCapturedToSetting();
if (!this.choice?.captureToActiveFile) {
this.addCreateIfNotExistsSetting();
Expand All @@ -49,20 +50,20 @@ export class CaptureChoiceBuilder extends ChoiceBuilder {
}

// Position
new Setting(this.contentEl).setName("Position").setHeading();
new Setting(this.contentEl).setName(t("builder.common.position")).setHeading();
this.addWritePositionSetting();

// Linking
new Setting(this.contentEl).setName("Linking").setHeading();
new Setting(this.contentEl).setName(t("builder.common.linking")).setHeading();
this.addAppendLinkSetting();

// Content
new Setting(this.contentEl).setName("Content").setHeading();
new Setting(this.contentEl).setName(t("builder.common.content")).setHeading();
this.addTaskSetting();
this.addFormatSetting();

// Behavior
new Setting(this.contentEl).setName("Behavior").setHeading();
new Setting(this.contentEl).setName(t("builder.common.behavior")).setHeading();
if (!this.choice.captureToActiveFile) {
this.addOpenFileSetting("Open the captured file.");

Expand Down Expand Up @@ -94,13 +95,11 @@ export class CaptureChoiceBuilder extends ChoiceBuilder {

private addSelectionAsValueSetting() {
new Setting(this.contentEl)
.setName("Use editor selection as default value")
.setDesc(
"Controls whether this Capture uses the current editor selection as {{VALUE}}. Does not affect {{SELECTED}}.",
)
.setName(t("settings.selection_capture.name"))
.setDesc(t("settings.selection_capture.desc"))
.addDropdown((dropdown) => {
dropdown.addOptions({
"": "Follow global setting",
"": t("builder.one_page_override.follow"),
enabled: "Use selection",
disabled: "Ignore selection",
});
Expand All @@ -124,8 +123,8 @@ export class CaptureChoiceBuilder extends ChoiceBuilder {

private addCapturedToSetting() {
new Setting(this.contentEl)
.setName("Capture to")
.setDesc("Target file path. Supports format syntax.");
.setName(t("builder.capture.to"))
.setDesc(t("builder.capture.to_desc"));

const captureToContainer: HTMLDivElement =
this.contentEl.createDiv("captureToContainer");
Expand All @@ -134,7 +133,7 @@ export class CaptureChoiceBuilder extends ChoiceBuilder {
captureToContainer.createDiv("captureToActiveFileContainer");
const captureToActiveFileText: HTMLSpanElement =
captureToActiveFileContainer.createEl("span");
captureToActiveFileText.textContent = "Capture to active file";
captureToActiveFileText.textContent = t("builder.capture.active_file");
const captureToActiveFileToggle: ToggleComponent = new ToggleComponent(
captureToActiveFileContainer,
);
Expand All @@ -143,7 +142,6 @@ export class CaptureChoiceBuilder extends ChoiceBuilder {
this.choice.captureToActiveFile = value;

// Reset new line capture settings when switching away from active file
// since those options are only available for active file capture
if (!value && this.choice.newLineCapture?.enabled) {
this.choice.newLineCapture.enabled = false;
}
Expand All @@ -163,10 +161,10 @@ export class CaptureChoiceBuilder extends ChoiceBuilder {
new FileNameDisplayFormatter(this.app, this.plugin);

const previewRow = captureToFileContainer.createDiv({ cls: "qa-preview-row" });
previewRow.createEl("span", { text: "Preview: ", cls: "qa-preview-label" });
previewRow.createEl("span", { text: t("builder.common.preview"), cls: "qa-preview-label" });
const formatDisplay = previewRow.createEl("span");
formatDisplay.setAttr("aria-live", "polite");
formatDisplay.textContent = "Loading preview…";
formatDisplay.textContent = t("builder.common.loading");

const markdownFilesAndFormatSyntax = [
...this.app.vault.getMarkdownFiles().map((f) => f.path),
Expand All @@ -188,7 +186,7 @@ export class CaptureChoiceBuilder extends ChoiceBuilder {
try {
formatDisplay.textContent = await displayFormatter.format(value);
} catch {
formatDisplay.textContent = "Preview unavailable";
formatDisplay.textContent = t("builder.common.unavailable");
}
},
});
Expand All @@ -199,7 +197,7 @@ export class CaptureChoiceBuilder extends ChoiceBuilder {
this.choice.captureTo,
);
} catch {
formatDisplay.textContent = "Preview unavailable";
formatDisplay.textContent = t("builder.common.unavailable");
}
})();
}
Expand All @@ -208,8 +206,8 @@ export class CaptureChoiceBuilder extends ChoiceBuilder {
private addTaskSetting() {
const taskSetting: Setting = new Setting(this.contentEl);
taskSetting
.setName("Task")
.setDesc("Formats the value as a task.")
.setName(t("builder.capture.task"))
.setDesc(t("builder.capture.task_desc"))
.addToggle((toggle) => {
toggle.setValue(this.choice.task);
toggle.onChange((value) => (this.choice.task = value));
Expand All @@ -232,12 +230,12 @@ export class CaptureChoiceBuilder extends ChoiceBuilder {

const appendLinkSetting: Setting = new Setting(this.contentEl);
appendLinkSetting
.setName("Link to captured file")
.setDesc("Choose how QuickAdd should insert a link to the captured file in the current note.")
.setName(t("builder.append_link.name"))
.setDesc(t("builder.append_link.desc"))
.addDropdown((dropdown) => {
dropdown.addOption("required", "Enabled (requires active file)");
dropdown.addOption("optional", "Enabled (skip if no active file)");
dropdown.addOption("disabled", "Disabled");
dropdown.addOption("required", t("builder.append_link.options.required"));
dropdown.addOption("optional", t("builder.append_link.options.optional"));
dropdown.addOption("disabled", t("builder.append_link.options.disabled"));

dropdown.setValue(currentMode);
dropdown.onChange((value: AppendLinkMode) => {
Expand Down Expand Up @@ -270,13 +268,13 @@ export class CaptureChoiceBuilder extends ChoiceBuilder {
if (currentMode !== "disabled") {
const placementSetting: Setting = new Setting(this.contentEl);
placementSetting
.setName("Link placement")
.setName(t("builder.append_link.placement"))
.setDesc("Where to place the link when appending")
.addDropdown((dropdown) => {
Comment thread
coderabbitai[bot] marked this conversation as resolved.
dropdown.addOption("replaceSelection", "Replace selection");
dropdown.addOption("afterSelection", "After selection");
dropdown.addOption("endOfLine", "End of line");
dropdown.addOption("newLine", "New line");
dropdown.addOption("replaceSelection", t("builder.append_link.options.replace"));
dropdown.addOption("afterSelection", t("builder.append_link.options.after"));
dropdown.addOption("endOfLine", t("builder.append_link.options.eol"));
dropdown.addOption("newLine", t("builder.append_link.options.newline"));

dropdown.setValue(normalizedOptions.placement);
dropdown.onChange((value: LinkPlacement) => {
Expand Down Expand Up @@ -307,11 +305,11 @@ export class CaptureChoiceBuilder extends ChoiceBuilder {
if (placementSupportsEmbed(normalizedOptions.placement)) {
const linkTypeSetting: Setting = new Setting(this.contentEl);
linkTypeSetting
.setName("Link type")
.setName(t("builder.append_link.type"))
.setDesc("Choose whether to insert a regular link or an embed when replacing the selection.")
.addDropdown((dropdown) => {
Comment thread
coderabbitai[bot] marked this conversation as resolved.
dropdown.addOption("link", "Link");
dropdown.addOption("embed", "Embed");
dropdown.addOption("link", t("builder.append_link.options.link"));
dropdown.addOption("embed", t("builder.append_link.options.embed"));
dropdown.setValue(normalizedLinkType);
dropdown.onChange((value: LinkType) => {
const currentValue = this.choice.appendLink;
Expand Down Expand Up @@ -345,12 +343,8 @@ export class CaptureChoiceBuilder extends ChoiceBuilder {
}

positionSetting
.setName("Write position")
.setDesc(
isActiveFile
? "Where to place the capture in the current file."
: "Where to place the capture in the target file.",
)
.setName(t("builder.capture.write_pos"))
.setDesc(t("builder.capture.write_pos_desc"))
.addDropdown((dropdown) => {
const current =
this.choice.insertAfter?.enabled
Expand All @@ -365,16 +359,16 @@ export class CaptureChoiceBuilder extends ChoiceBuilder {
? "activeTop"
: "top";

dropdown.addOption("top", isActiveFile ? "At cursor" : "Top of file");
dropdown.addOption("top", isActiveFile ? t("builder.capture.pos_options.cursor") : t("builder.capture.pos_options.top"));

if (isActiveFile) {
dropdown.addOption("activeTop", "Top of file (after frontmatter)");
dropdown.addOption("newLineAbove", "New line above cursor");
dropdown.addOption("newLineBelow", "New line below cursor");
dropdown.addOption("activeTop", t("builder.capture.pos_options.active_top"));
dropdown.addOption("newLineAbove", t("builder.capture.pos_options.newline_above"));
dropdown.addOption("newLineBelow", t("builder.capture.pos_options.newline_below"));
}

dropdown.addOption("after", "After line…");
dropdown.addOption("bottom", "Bottom of file");
dropdown.addOption("after", t("builder.capture.pos_options.after"));
dropdown.addOption("bottom", t("builder.capture.pos_options.bottom"));
dropdown.setValue(current);
dropdown.onChange((value: string) => {
const v = value as
Expand Down Expand Up @@ -438,25 +432,20 @@ export class CaptureChoiceBuilder extends ChoiceBuilder {
}

private addInsertAfterFields() {
const descText =
"Insert capture after specified text. Accepts format syntax. " +
"Tip: use a heading (starts with #) to target a section. " +
"Blank line handling is configurable below.";

new Setting(this.contentEl)
.setName("Insert after")
.setDesc(descText);
.setName(t("builder.capture.insert_after"))
.setDesc(t("builder.capture.insert_after_desc"));

const displayFormatter: FormatDisplayFormatter = new FormatDisplayFormatter(
this.app,
this.plugin,
);

const previewRow = this.contentEl.createDiv({ cls: "qa-preview-row" });
previewRow.createEl("span", { text: "Preview: ", cls: "qa-preview-label" });
previewRow.createEl("span", { text: t("builder.common.preview"), cls: "qa-preview-label" });
const previewValue = previewRow.createEl("span");
previewValue.setAttribute("aria-live", "polite");
previewValue.innerText = "Loading preview…";
previewValue.innerText = t("builder.common.loading");

createValidatedInput({
app: this.app,
Expand All @@ -473,7 +462,7 @@ export class CaptureChoiceBuilder extends ChoiceBuilder {
try {
previewValue.innerText = await displayFormatter.format(value);
} catch {
previewValue.innerText = "Preview unavailable";
previewValue.innerText = t("builder.common.unavailable");
}
},
});
Expand All @@ -484,7 +473,7 @@ export class CaptureChoiceBuilder extends ChoiceBuilder {
this.choice.insertAfter.after,
);
} catch {
previewValue.innerText = "Preview unavailable";
previewValue.innerText = t("builder.common.unavailable");
}
})();

Expand All @@ -497,10 +486,8 @@ export class CaptureChoiceBuilder extends ChoiceBuilder {
}

new Setting(this.contentEl)
.setName("Inline insertion")
.setDesc(
"Insert captured content on the same line, immediately after the matched text (no newline added).",
)
.setName(t("builder.capture.inline"))
.setDesc(t("builder.capture.inline_desc"))
.addToggle((toggle) =>
toggle
.setValue(!!this.choice.insertAfter?.inline)
Expand Down Expand Up @@ -528,7 +515,7 @@ export class CaptureChoiceBuilder extends ChoiceBuilder {
if (!inlineEnabled) {
const insertAtEndSetting: Setting = new Setting(this.contentEl);
insertAtEndSetting
.setName("Insert at end of section")
.setName(t("builder.capture.insert_end_section"))
.setDesc(
"Place the text at the end of the matched section instead of the top.",
)
Expand Down Expand Up @@ -575,9 +562,9 @@ export class CaptureChoiceBuilder extends ChoiceBuilder {
blankLineModeSetting.setDisabled(insertAtEndEnabled);

new Setting(this.contentEl)
.setName("Consider subsections")
.setName(t("builder.capture.consider_subsections"))
.setDesc(
"Also include the section’s subsections (requires target to be a heading starting with #). Subsections are headings inside the section.",
"Also include the section’s subsections (requires target to be a heading starting with #).",
)
.addToggle((toggle) =>
toggle
Expand Down Expand Up @@ -638,8 +625,8 @@ export class CaptureChoiceBuilder extends ChoiceBuilder {
private addFormatSetting() {
const enableSetting = new Setting(this.contentEl);
enableSetting
.setName("Capture format")
.setDesc("Set the format of the capture.")
.setName(t("builder.capture.format"))
.setDesc(t("builder.capture.format_desc"))
.addToggle((toggleComponent) => {
toggleComponent
.setValue(this.choice.format.enabled)
Expand All @@ -656,10 +643,10 @@ export class CaptureChoiceBuilder extends ChoiceBuilder {
);

const previewRow = this.contentEl.createDiv({ cls: "qa-preview-row" });
previewRow.createEl("span", { text: "Preview: ", cls: "qa-preview-label" });
previewRow.createEl("span", { text: t("builder.common.preview"), cls: "qa-preview-label" });
const formatDisplay = previewRow.createEl("span");
formatDisplay.setAttr("aria-live", "polite");
formatDisplay.innerText = "Loading preview…";
formatDisplay.innerText = t("builder.common.loading");

const formatHandle = createValidatedInput({
app: this.app,
Expand All @@ -677,7 +664,7 @@ export class CaptureChoiceBuilder extends ChoiceBuilder {
try {
formatDisplay.innerText = await displayFormatter.format(value);
} catch {
formatDisplay.innerText = "Preview unavailable";
formatDisplay.innerText = t("builder.common.unavailable");
}
},
});
Expand All @@ -690,7 +677,7 @@ export class CaptureChoiceBuilder extends ChoiceBuilder {
this.choice.format.format,
);
} catch {
formatDisplay.innerText = "Preview unavailable";
formatDisplay.innerText = t("builder.common.unavailable");
}
})();
}
Expand All @@ -705,7 +692,7 @@ export class CaptureChoiceBuilder extends ChoiceBuilder {

const createFileIfItDoesntExist: Setting = new Setting(this.contentEl);
createFileIfItDoesntExist
.setName("Create file if it doesn't exist")
.setName(t("builder.capture.create_if_missing"))
.addToggle((toggle) =>
toggle
.setValue(this.choice?.createFileIfItDoesntExist?.enabled)
Expand All @@ -721,7 +708,7 @@ export class CaptureChoiceBuilder extends ChoiceBuilder {
let templateSelector: TextComponent;
const createWithTemplateSetting = new Setting(this.contentEl);
createWithTemplateSetting
.setName("Create file with given template.")
.setName(t("builder.capture.create_with_template"))
.addToggle((toggle) =>
toggle
.setValue(this.choice.createFileIfItDoesntExist?.createWithTemplate)
Expand Down
Loading