# Pull Request Template ## Description This PR introduces a custom, lightweight natural-language date parser (dependency-free except for date-fns) to power snooze actions via the command bar (e.g., “Remind me tomorrow at 6am”). It also adds support for multi-language searches. <details> <summary>Supported Formats</summary> ## Snooze Date Parser — Supported Input Formats ## 1. Durations Specify an amount of time from now. ### Basic - `5 minutes` · `2 hours` · `3 days` · `1 week` · `6 months` · `ten year` - `in 2 hours` · `in 30 minutes` · `in a week` · `in a month` - `5 minutes from now` · `a week from now` · `two weeks from now` ### Half / fractional - `half hour` · `half day` · `half week` · `half month` - `in half a day` · `in half an hour` · `in half a week` - `one and a half hours` · `in one and a half hours` - `1.5 hours` · `2.5 days` ### Compound - `1 hour and 30 minutes` · `2 hours and 15 minutes` - `2 days at 3pm` · `1 week at 9am` ### Shorthand (no spaces) - `2h` · `30m` · `1h30m` · `2h15m` - `1h30minutes` · `2hr15min` · `1hour30min` ### Informal quantities - `couple hours` · `a couple of days` · `in a couple hours` - `a few minutes` · `in a few hours` · `in a few days` - `fortnight` · `in a fortnight` _(= 2 weeks)_ ### Trailing "later" - `2 days later` · `a week later` · `month later` ### Prefix words (`after` / `within`) - `after 2 hours` · `after 3 days` · `after ten year` - `within a week` · `within 2 hours` ### Recognised word-numbers `a` (1) · `an` (1) · `one` – `twenty` · `thirty` · `forty` · `fifty` · `sixty` · `ninety` · `half` (0.5) · `couple` (2) · `few` (3) --- ## 2. Relative Days - `today` · `tonight` · `tomorrow` - `tomorrow morning` · `tomorrow afternoon` · `tomorrow evening` · `tomorrow night` - `tomorrow at 3pm` · `tomorrow 9` · `tonight at 8` · `tonight at 10pm` - `tomorrow same time` · `same time tomorrow` - `day after tomorrow` · `the day after tomorrow` · `day after tomorrow at 2pm` - `later today` · `later this afternoon` · `later this evening` --- ## 3. Weekdays - `monday` · `friday` · `wed` · `thu` - `friday at 3pm` · `monday 9am` · `wednesday 14:30` - `monday morning` · `friday afternoon` · `wednesday evening` - `monday morning 6` · `friday evening 7` - `this friday` · `upcoming monday` · `coming friday` - `same time friday` · `same time wednesday` --- ## 4. "Next" Patterns - `next hour` · `next week` · `next month` · `next year` - `next week at 2pm` · `next month at 9am` - `next monday` · `next friday` · `next friday at 3pm` - `next monday morning` · `next friday evening` - `monday of next week` · `next week monday` - `next january` · `next december` - `next business day` · `next working day` --- ## 5. Time of Day - `morning` · `afternoon` · `evening` · `night` · `noon` · `midnight` - `this morning` · `this afternoon` · `this evening` - `early morning` · `late evening` · `late night` - `morning at 8am` · `evening 6pm` · `afternoon 2pm` - `eod` · `end of day` · `end of the day` --- ## 6. Standalone Time - **12-hour:** `3pm` · `9am` · `at 3pm` · `at 9:30am` - **24-hour:** `14:30` · `at 14:30` --- ## 7. Named Dates (Month + Day) - `jan 15` · `january 15` · `march 20` · `dec 25` - `jan 1st` · `march 3rd` · `april 2nd` · `december 31st` - `15 march` · `25 dec` _(reversed order)_ - `jan 15 2025` · `dec 25 2025` · `march 20 next year` - `jan 15 at 2pm` · `march 5 at 2pm` - `december 2025` · `january 2024` _(month + year only)_ --- ## 8. Month + Ordinal Patterns Target a specific week or day within a month. ### Week of month - `april first week` · `july 2nd week` · `feb 3rd week` - `first week of april` · `2nd week of july` ### Day of month - `april first day` · `march second day` · `march 5th day` - `third day of march` · `5th day of jan at 2pm` ### Supported ordinals - **Digit:** `1st` `2nd` `3rd` `4th` `5th` … (up to 31 for days, 5 for weeks) - **Word:** `first` `second` `third` `fourth` `fifth` `sixth` `seventh` `eighth` `ninth` `tenth` --- ## 9. Formal / Numeric Dates - **ISO:** `2025-01-15` - **Slash (M/D/Y):** `01/15/2025` - **Dash (D-M-Y):** `15-01-2025` - **Dot (D.M.Y):** `15.01.2025` - Any of the above **+ time:** `2025-01-15 at 3pm` --- ## 10. Special Phrases - `this weekend` · `weekend` · `next weekend` - `end of week` · `end of month` - `end of next week` · `end of next month` - `beginning of next week` · `start of next week` - `beginning of next month` --- ## 11. Noise / Filler Stripping The parser silently removes conversational prefixes so all of these work exactly the same as the bare expression: ``` snooze for 2 hours → 2 hours remind me tomorrow → tomorrow please snooze until friday → friday can you set a reminder for next week → next week schedule this for jan 15 → jan 15 postpone to next monday → next monday defer for 2 days → 2 days delay it by 1 hour → 1 hour ``` ### Recognised filler verbs / prefixes `snooze` · `remind` · `remind me` · `set a reminder` · `add a reminder` · `schedule` · `postpone` · `defer` · `delay` · `push` ### Recognised prepositions (stripped) `on` · `to` · `for` · `at` · `until` · `till` · `by` · `from` · `after` · `within` ### Typo corrections `tommorow` / `tommorrow` → `tomorrow` · `nxt` → `next` --- ## 12. Multi-Language Support The parser supports localised input via translations in `snooze.json`. ### Translatable token categories - **Units:** minute, hour, day, week, month, year _(singular + plural)_ - **Relative days:** tomorrow, day after tomorrow, next week / month, this / next weekend - **Time of day:** morning, afternoon, evening, night, noon, midnight - **Word numbers:** one through ten, twelve, fifteen, twenty, thirty - **Ordinals:** first through fifth - **Structural words:** at, in, of, after, week, day, from now, next year - **Meridiem:** am, pm ### Auto-detected from locale Weekday names and month names are resolved automatically via `Intl.DateTimeFormat` for the user's locale — no manual translation needed. </details> ## Type of change - [x] New feature (non-breaking change which adds functionality) ## How Has This Been Tested? **Screenshots** <img width="974" height="530" alt="image" src="https://github.com/user-attachments/assets/c690d328-a0df-41d2-b531-2b4e6ce6b5fd" /> <img width="974" height="530" alt="image" src="https://github.com/user-attachments/assets/fa881acc-4fed-4ba3-9166-58bd953bcb26" /> <img width="974" height="530" alt="image" src="https://github.com/user-attachments/assets/4d9a224b-641c-409c-a7ce-3dec2b5355e2" /> <img width="974" height="530" alt="image" src="https://github.com/user-attachments/assets/465b9835-d82c-4bc7-a2ae-94976ada2d3b" /> <img width="974" height="530" alt="image" src="https://github.com/user-attachments/assets/839fe8fc-8943-4b66-83ca-5c61c95f24d8" /> <img width="974" height="530" alt="image" src="https://github.com/user-attachments/assets/3a9a54f2-7669-40f2-b098-a3f5c183526d" /> <img width="974" height="530" alt="image" src="https://github.com/user-attachments/assets/7791ab2b-c763-49a9-90a0-e91b0d8f0a26" /> <img width="974" height="530" alt="image" src="https://github.com/user-attachments/assets/4689390c-0e7f-48ae-acc7-d8e28695452f" /> <img width="974" height="530" alt="image" src="https://github.com/user-attachments/assets/d0aa5217-d0e1-4f41-b663-72888d028a3a" /> <img width="974" height="530" alt="image" src="https://github.com/user-attachments/assets/4fa9ff5b-a874-43d5-812f-6abe1a95a5ac" /> <img width="974" height="530" alt="image" src="https://github.com/user-attachments/assets/2c8199a6-f872-46af-986f-bdf8597248f5" /> <img width="974" height="530" alt="image" src="https://github.com/user-attachments/assets/5bd9effc-7518-4f96-b2f2-7c547f32f500" /> ## Checklist: - [x] My code follows the style guidelines of this project - [x] I have performed a self-review of my code - [x] I have commented on my code, particularly in hard-to-understand areas - [ ] I have made corresponding changes to the documentation - [x] My changes generate no new warnings - [x] I have added tests that prove my fix is effective or that my feature works - [x] New and existing unit tests pass locally with my changes - [ ] Any dependent changes have been merged and published in downstream modules
221 lines
7.8 KiB
JavaScript
221 lines
7.8 KiB
JavaScript
import {
|
|
findSnoozeTime,
|
|
snoozedReopenTime,
|
|
findStartOfNextWeek,
|
|
findStartOfNextMonth,
|
|
findNextDay,
|
|
setHoursToNine,
|
|
snoozedReopenTimeToTimestamp,
|
|
shortenSnoozeTime,
|
|
generateSnoozeSuggestions,
|
|
} from '../snoozeHelpers';
|
|
|
|
describe('#Snooze Helpers', () => {
|
|
describe('findStartOfNextWeek', () => {
|
|
it('should return first working day of next week if a date is passed', () => {
|
|
const today = new Date('06/16/2023');
|
|
const startOfNextWeek = new Date('06/19/2023');
|
|
expect(findStartOfNextWeek(today)).toEqual(startOfNextWeek);
|
|
});
|
|
it('should return first working day of next week if a date is passed', () => {
|
|
const today = new Date('06/03/2023');
|
|
const startOfNextWeek = new Date('06/05/2023');
|
|
expect(findStartOfNextWeek(today)).toEqual(startOfNextWeek);
|
|
});
|
|
});
|
|
|
|
describe('findStartOfNextMonth', () => {
|
|
it('should return first working day of next month if a valid date is passed', () => {
|
|
const today = new Date('06/21/2023');
|
|
const startOfNextMonth = new Date('07/03/2023');
|
|
expect(findStartOfNextMonth(today)).toEqual(startOfNextMonth);
|
|
});
|
|
it('should return first working day of next month if a valid date is passed', () => {
|
|
const today = new Date('02/28/2023');
|
|
const startOfNextMonth = new Date('03/06/2023');
|
|
expect(findStartOfNextMonth(today)).toEqual(startOfNextMonth);
|
|
});
|
|
});
|
|
|
|
describe('setHoursToNine', () => {
|
|
it('should return date with 9.00AM time', () => {
|
|
const nextDay = new Date('06/17/2023');
|
|
nextDay.setHours(9, 0, 0, 0);
|
|
expect(setHoursToNine(nextDay)).toEqual(nextDay);
|
|
});
|
|
it('should return date with 9.00AM time if date with 10am is passes', () => {
|
|
const nextDay = new Date('06/17/2023 10:00:00');
|
|
nextDay.setHours(9, 0, 0, 0);
|
|
expect(setHoursToNine(nextDay)).toEqual(nextDay);
|
|
});
|
|
});
|
|
|
|
describe('findSnoozeTime', () => {
|
|
it('should return nil if until_next_reply is passed', () => {
|
|
expect(findSnoozeTime('until_next_reply')).toEqual(null);
|
|
});
|
|
|
|
it('should return next hour time stamp if an_hour_from_now is passed', () => {
|
|
const nextHour = new Date();
|
|
nextHour.setHours(nextHour.getHours() + 1);
|
|
expect(findSnoozeTime('an_hour_from_now')).toBeCloseTo(
|
|
Math.floor(nextHour.getTime() / 1000)
|
|
);
|
|
});
|
|
|
|
it('should return next day 9.00AM time stamp until_tomorrow is passed', () => {
|
|
const today = new Date('06/16/2023');
|
|
const nextDay = new Date('06/17/2023');
|
|
nextDay.setHours(9, 0, 0, 0);
|
|
expect(findSnoozeTime('until_tomorrow', today)).toBeCloseTo(
|
|
nextDay.getTime() / 1000
|
|
);
|
|
});
|
|
|
|
it('should return next week monday 9.00AM time stamp if until_next_week is passed', () => {
|
|
const today = new Date('06/16/2023');
|
|
const startOfNextWeek = new Date('06/19/2023');
|
|
startOfNextWeek.setHours(9, 0, 0, 0);
|
|
expect(findSnoozeTime('until_next_week', today)).toBeCloseTo(
|
|
startOfNextWeek.getTime() / 1000
|
|
);
|
|
});
|
|
|
|
it('should return next month 9.00AM time stamp if until_next_month is passed', () => {
|
|
const today = new Date('06/21/2023');
|
|
const startOfNextMonth = new Date('07/03/2023');
|
|
startOfNextMonth.setHours(9, 0, 0, 0);
|
|
expect(findSnoozeTime('until_next_month', today)).toBeCloseTo(
|
|
startOfNextMonth.getTime() / 1000
|
|
);
|
|
});
|
|
});
|
|
|
|
describe('snoozedReopenTime', () => {
|
|
beforeEach(() => {
|
|
vi.useFakeTimers();
|
|
vi.setSystemTime(new Date('2024-01-01T12:00:00Z'));
|
|
});
|
|
|
|
afterEach(() => {
|
|
vi.useRealTimers();
|
|
});
|
|
|
|
it('should return formatted date with year if snoozedUntil is not in current year', () => {
|
|
// Input is 09:00 UTC.
|
|
// If your environment is UTC, this will be 9.00am.
|
|
expect(snoozedReopenTime('2023-06-07T09:00:00.000Z')).toEqual(
|
|
'7 Jun 2023, 9.00am'
|
|
);
|
|
});
|
|
|
|
it('should return formatted date without year if snoozedUntil is in current year', () => {
|
|
// This uses 2024 because we mocked the system time above
|
|
expect(snoozedReopenTime('2024-06-07T09:00:00.000Z')).toEqual(
|
|
'7 Jun, 9.00am'
|
|
);
|
|
});
|
|
});
|
|
|
|
describe('findNextDay', () => {
|
|
it('should return next day', () => {
|
|
const today = new Date('06/16/2023');
|
|
const nextDay = new Date('06/17/2023');
|
|
expect(findNextDay(today)).toEqual(nextDay);
|
|
});
|
|
});
|
|
|
|
describe('snoozedReopenTimeToTimestamp', () => {
|
|
it('should return timestamp if snoozedUntil is not nil', () => {
|
|
expect(snoozedReopenTimeToTimestamp('2023-06-07T09:00:00.000Z')).toEqual(
|
|
1686128400
|
|
);
|
|
});
|
|
it('should return nil if snoozedUntil is nil', () => {
|
|
expect(snoozedReopenTimeToTimestamp(null)).toEqual(null);
|
|
});
|
|
});
|
|
|
|
describe('shortenSnoozeTime', () => {
|
|
it('should return shortened time if snoozedUntil is not nil and day is passed', () => {
|
|
expect(shortenSnoozeTime('1 day')).toEqual('1d');
|
|
});
|
|
|
|
it('should return shortened time if snoozedUntil is not nil and month is passed', () => {
|
|
expect(shortenSnoozeTime('1 month')).toEqual('1mo');
|
|
});
|
|
|
|
it('should return shortened time if snoozedUntil is not nil and year is passed', () => {
|
|
expect(shortenSnoozeTime('1 year')).toEqual('1y');
|
|
});
|
|
|
|
it('should return shortened time if snoozedUntil is not nil and hour is passed', () => {
|
|
expect(shortenSnoozeTime('1 hour')).toEqual('1h');
|
|
});
|
|
|
|
it('should return shortened time if snoozedUntil is not nil and minutes is passed', () => {
|
|
expect(shortenSnoozeTime('1 minutes')).toEqual('1m');
|
|
});
|
|
|
|
it('should return shortened time if snoozedUntil is not nil and in is passed', () => {
|
|
expect(shortenSnoozeTime('in 1 hour')).toEqual('1h');
|
|
});
|
|
|
|
it('should return nil if snoozedUntil is nil', () => {
|
|
expect(shortenSnoozeTime(null)).toEqual(null);
|
|
});
|
|
});
|
|
|
|
describe('generateSnoozeSuggestions label expansion', () => {
|
|
const now = new Date('2023-06-16T10:00:00');
|
|
|
|
it('expands abbreviated units: "1d" → "1 Day"', () => {
|
|
const results = generateSnoozeSuggestions('1d', now);
|
|
expect(results.length).toBeGreaterThan(0);
|
|
expect(results[0].label).toBe('1 day');
|
|
});
|
|
|
|
it('expands abbreviated units: "2 d" → "2 Days"', () => {
|
|
const results = generateSnoozeSuggestions('2 d', now);
|
|
expect(results.length).toBeGreaterThan(0);
|
|
expect(results[0].label).toBe('2 days');
|
|
});
|
|
|
|
it('expands abbreviated units: "1h" → "1 Hour"', () => {
|
|
const results = generateSnoozeSuggestions('1h', now);
|
|
expect(results.length).toBeGreaterThan(0);
|
|
expect(results[0].label).toBe('1 hour');
|
|
});
|
|
|
|
it('expands abbreviated units: "2min" → "2 Minutes"', () => {
|
|
const results = generateSnoozeSuggestions('2min', now);
|
|
expect(results.length).toBeGreaterThan(0);
|
|
expect(results[0].label).toBe('2 minutes');
|
|
});
|
|
|
|
it('handles singular: "1 hours" → "1 Hour"', () => {
|
|
const results = generateSnoozeSuggestions('1 hours', now);
|
|
expect(results.length).toBeGreaterThan(0);
|
|
expect(results[0].label).toBe('1 hour');
|
|
});
|
|
|
|
it('handles singular: "1 minutes" → "1 Minute"', () => {
|
|
const results = generateSnoozeSuggestions('1 minutes', now);
|
|
expect(results.length).toBeGreaterThan(0);
|
|
expect(results[0].label).toBe('1 minute');
|
|
});
|
|
|
|
it('keeps plural for non-1: "2 days" → "2 Days"', () => {
|
|
const results = generateSnoozeSuggestions('2 days', now);
|
|
expect(results.length).toBeGreaterThan(0);
|
|
expect(results[0].label).toBe('2 days');
|
|
});
|
|
|
|
it('expands compound: "1h30m" → "1 Hour 30 Minutes"', () => {
|
|
const results = generateSnoozeSuggestions('1h30m', now);
|
|
expect(results.length).toBeGreaterThan(0);
|
|
expect(results[0].label).toBe('1 hour 30 minutes');
|
|
});
|
|
});
|
|
});
|