feat: add useCurrentYearIfMissing option to support dates without year #14
Conversation
There was a problem hiding this comment.
Pull Request Overview
This pull request introduces the new option useCurrentYearIfMissing, allowing the rule to supplement the current year for date strings missing a year so that weekday validation works correctly. Key changes include:
- Adding new logic in the rule to re-parse date strings with the current year when needed.
- Updating tests to cover both valid and invalid scenarios using the new option.
- Enhancing documentation in README.md to describe the useCurrentYearIfMissing option.
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| test/textlint-rule-date-weekday-mismatch-test.js | Added tests to verify behavior when the useCurrentYearIfMissing option is enabled |
| src/textlint-rule-date-weekday-mismatch.js | Introduced addYearToDateText and updated reporter logic for re-parsing dates |
| README.md | Documented the new useCurrentYearIfMissing option |
|
I realized that these tests will fail next year because the expected results depend on the current year... |
|
@azu |
| // Mock: fix current date to 2025-04-23 to test `useCurrentYearIfMissing` option | ||
| let clock; | ||
| before(() => { | ||
| clock = sinon.useFakeTimers(new Date(2025, 4, 23).getTime()); | ||
| }); | ||
| after(() => { | ||
| clock.restore(); | ||
| }); | ||
|
|
There was a problem hiding this comment.
I think that add currentYear option instead of using mocking.
{
"useCurrentYearIfMissing": true,
"currentYear": 2025, // default: new Date()).getFullYear()
}
As a result, you do not need mocking, just pass currentYear option.
Also, currentYear will be useful in some use-case.
There was a problem hiding this comment.
Thank you for your suggestion. You are absolutely right!
I’ve added the currentYear option as you recommended, so mocking is no longer necessary.
I appreciate your helpful feedback!✨
| const chronoDates = chrono.parse(text); | ||
| let chronoDates = chrono.parse(text); | ||
| // Add current year if missing and option is enabled | ||
| if (useCurrentYearIfMissing) { | ||
| const currentYear = (new Date()).getFullYear(); | ||
| chronoDates.forEach(chronoDate => { | ||
| // If year is not specified in the parsed result | ||
| if ( | ||
| chronoDate.start && | ||
| chronoDate.start.knownValues.year === undefined | ||
| ) { | ||
| // Detect language for the date string | ||
| const lang = detectLang(Object.keys(chronoDate.tags), preferLang); | ||
| if (!lang) { | ||
| return; | ||
| } | ||
| // Re-parse the text with the year added | ||
| const newText = addYearToDateText(chronoDate.text, currentYear, lang); | ||
| const reparsed = chrono.parse(newText, undefined, {forwardDate: true}); | ||
| // If reparsed successfully, update knownValues with year/month/day | ||
| if (reparsed && reparsed[0] && reparsed[0].start && reparsed[0].start.knownValues) { | ||
| Object.assign(chronoDate.start.knownValues, reparsed[0].start.knownValues); | ||
| } | ||
| } | ||
| }); | ||
| } |
There was a problem hiding this comment.
We want to avoid to use let and re-assign.
I think the scope of the let can be reduced by cutting it out to a function like createChronoDates.
const createChronoDates = (dateText:string, options: {
preferLang: string;
useCurrentYearIfMissing: boolean;
currentYear: number
}) => {
let chronoDates = chrono.parse(text);
if(!option.useCurrentYearIfMissing) {
return chronoDates;
}
...
}
...
const chronoDates = createChronoDates(text, {
preferLang,
useCurrentYearIfMissing,
currentYear
});
2 participants
Summary
This pull request adds a new option,
useCurrentYearIfMissing, to the rule.When enabled, this option automatically supplements the current year for date strings that do not explicitly include a year (e.g.,
4月23日(水)or4/23(Wed)), allowing weekday validation to work as expected.Details
useCurrentYearIfMissingoption (default: false)4-23(金)becausechrono-nodeparses them as times, not dates.Example
When
useCurrentYearIfMissingis enabled in 2025,🟢 4月23日(水)
🟢 4/23(Wed)
❌ 4月23日(月) → 4月23日(水)
❌ 4/23(Mon) → 4/23(Wed)
Motivation
In many Japanese and multilingual documents, dates are often written without the year.
This option makes the rule more practical for such use cases, while keeping the default behavior unchanged for backward compatibility.
Notes
The new logic only affects cases where the year is missing in the original text and the option is enabled.
🦺 Existing behavior and options are not affected.
Thanks in advance!