Skip to content
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

Localize time pattern trigger in automation editor #19173

Merged
merged 5 commits into from
Jan 8, 2024
Merged

Localize time pattern trigger in automation editor #19173

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
33b1b26
Implement Time Trigger Pattern
silamon Dec 25, 2023
80c6fd9
Ordinal suffix
silamon Dec 28, 2023
53c58ba
formatting
silamon Dec 28, 2023
fa3195f
Fix incorrect month choice
silamon Dec 28, 2023
d14703b
Merge branch 'dev' into time_trigger_loc
silamon Jan 5, 2024
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
136 changes: 93 additions & 43 deletions src/data/automation_i18n.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,23 +64,6 @@ const localizeTimeString = (
}
};

const ordinalSuffix = (n: number) => {
n %= 100;
if ([11, 12, 13].includes(n)) {
return "th";
}
if (n % 10 === 1) {
return "st";
}
if (n % 10 === 2) {
return "nd";
}
if (n % 10 === 3) {
return "rd";
}
return "th";
};

export const describeTrigger = (
trigger: Trigger,
hass: HomeAssistant,
Expand Down Expand Up @@ -401,14 +384,37 @@ const tryDescribeTrigger = (
// Time Pattern Trigger
if (trigger.platform === "time_pattern") {
if (!trigger.seconds && !trigger.minutes && !trigger.hours) {
return "When a time pattern matches";
return hass.localize(
`${triggerTranslationBaseKey}.time_pattern.description.initial`
);
}
let result = "Trigger ";

const invalidParts: Array<"seconds" | "minutes" | "hours"> = [];

let secondsChoice: "every" | "every_interval" | "on_the_xth" | "other" =
"other";
let minutesChoice:
| "every"
| "every_interval"
| "on_the_xth"
| "other"
| "has_seconds" = "other";
let hoursChoice:
| "every"
| "every_interval"
| "on_the_xth"
| "other"
| "has_seconds_or_minutes" = "other";

let seconds = 0;
let minutes = 0;
let hours = 0;

if (trigger.seconds !== undefined) {
const seconds_all = trigger.seconds === "*";
const seconds_interval =
typeof trigger.seconds === "string" && trigger.seconds.startsWith("/");
const seconds = seconds_all
seconds = seconds_all
? 0
: typeof trigger.seconds === "number"
? trigger.seconds
Expand All @@ -422,22 +428,22 @@ const tryDescribeTrigger = (
seconds < 0 ||
(seconds_interval && seconds === 0)
) {
return "Invalid Time Pattern Seconds";
invalidParts.push("seconds");
}

if (seconds_all || (seconds_interval && seconds === 1)) {
result += "every second of ";
secondsChoice = "every";
} else if (seconds_interval) {
result += `every ${seconds} seconds of `;
secondsChoice = "every_interval";
} else {
result += `on the ${seconds}${ordinalSuffix(seconds)} second of `;
secondsChoice = "on_the_xth";
}
}
if (trigger.minutes !== undefined) {
const minutes_all = trigger.minutes === "*";
const minutes_interval =
typeof trigger.minutes === "string" && trigger.minutes.startsWith("/");
const minutes = minutes_all
minutes = minutes_all
? 0
: typeof trigger.minutes === "number"
? trigger.minutes
Expand All @@ -451,30 +457,30 @@ const tryDescribeTrigger = (
minutes < 0 ||
(minutes_interval && minutes === 0)
) {
return "Invalid Time Pattern Minutes";
invalidParts.push("minutes");
}

if (minutes_all || (minutes_interval && minutes === 1)) {
result += "every minute of ";
minutesChoice = "every";
} else if (minutes_interval) {
result += `every ${minutes} minutes of `;
minutesChoice = "every_interval";
} else {
result += `${
trigger.seconds !== undefined ? "" : "on"
} the ${minutes}${ordinalSuffix(minutes)} minute of `;
minutesChoice =
trigger.seconds !== undefined ? "has_seconds" : "on_the_xth";
}
} else if (trigger.seconds !== undefined) {
if (trigger.hours !== undefined) {
result += `the 0${ordinalSuffix(0)} minute of `;
minutes = 0;
minutesChoice = "has_seconds";
} else {
result += "every minute of ";
minutesChoice = "every";
}
}
if (trigger.hours !== undefined) {
const hours_all = trigger.hours === "*";
const hours_interval =
typeof trigger.hours === "string" && trigger.hours.startsWith("/");
const hours = hours_all
hours = hours_all
? 0
: typeof trigger.hours === "number"
? trigger.hours
Expand All @@ -488,24 +494,68 @@ const tryDescribeTrigger = (
hours < 0 ||
(hours_interval && hours === 0)
) {
return "Invalid Time Pattern Hours";
invalidParts.push("hours");
}

if (hours_all || (hours_interval && hours === 1)) {
result += "every hour";
hoursChoice = "every";
} else if (hours_interval) {
result += `every ${hours} hours`;
hoursChoice = "every_interval";
} else {
result += `${
hoursChoice =
trigger.seconds !== undefined || trigger.minutes !== undefined
? ""
: "on"
} the ${hours}${ordinalSuffix(hours)} hour`;
? "has_seconds_or_minutes"
: "on_the_xth";
}
} else {
result += "every hour";
hoursChoice = "every";
}
return result;

if (invalidParts.length !== 0) {
return hass.localize(
`${triggerTranslationBaseKey}.time_pattern.description.invalid`,
{
parts: formatListWithAnds(
hass.locale,
invalidParts.map((invalidPart) =>
hass.localize(
`${triggerTranslationBaseKey}.time_pattern.${invalidPart}`
)
)
),
}
);
}

return hass.localize(
`${triggerTranslationBaseKey}.time_pattern.description.full`,
{
secondsChoice: secondsChoice,
minutesChoice: minutesChoice,
hoursChoice: hoursChoice,
seconds: seconds,
minutes: minutes,
hours: hours,
secondsWithOrdinal: hass.localize(
`${triggerTranslationBaseKey}.time_pattern.description.ordinal`,
{
part: seconds,
}
),
minutesWithOrdinal: hass.localize(
`${triggerTranslationBaseKey}.time_pattern.description.ordinal`,
{
part: minutes,
}
),
hoursWithOrdinal: hass.localize(
`${triggerTranslationBaseKey}.time_pattern.description.ordinal`,
{
part: hours,
}
),
}
);
}

// Zone Trigger
Expand Down
6 changes: 5 additions & 1 deletion src/translations/en.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2669,7 +2669,11 @@
"minutes": "Minutes",
"seconds": "Seconds",
"description": {
"picker": "Periodically, at a defined interval."
"picker": "Periodically, at a defined interval.",
"initial": "When a time pattern matches",
"invalid": "Invalid Time Pattern for {parts}",
"full": "Trigger {secondsChoice, select, \n every {every second of }\n every_interval {every {seconds} seconds of }\n on_the_xth {on the {secondsWithOrdinal} second of }\n other {}\n} {minutesChoice, select, \n every {every minute of }\n every_interval {every {minutes} minutes of }\n has_seconds {the {minutesWithOrdinal} minute of }\n on_the_xth {on the {minutesWithOrdinal} minute of }\n other {}\n} {hoursChoice, select, \n every {every hour}\n every_interval {every {hours} hours}\n has_seconds_or_minutes {the {hoursWithOrdinal} hour}\n on_the_xth {on the {hoursWithOrdinal} hour}\n other {}\n}",
"ordinal": "{part, selectordinal, \none {#st}\ntwo {#nd}\nfew {#rd}\nother {#th}\n}"
}
},
"webhook": {
Expand Down
Loading