Add relative date feature #908

alyip98 · 2019-06-27T07:13:32Z

What is the purpose of this pull request? (put "X" next to an item, remove the rest)
• [x] New feature

Addresses #901

What is the rationale for this request?
Adds the ability to insert relative dates

What changes did you make? (Give an overview)
Add a new markdown-it plugin that looks for @date Week#day@ tokens and replaces them with
dates relative to a specified base date.

Changed to a Nunjucks filter extension:
{{ baseDate | date(format, dayOffset) }}

Provide some example code that this change will affect:

Is there anything you'd like reviewers to focus on?
Is the proposed syntax suitable, or should we implement it as a tag e.g. <date>

Testing instructions:
Netlify preview

Proposed commit message: (wrap lines at 72 characters)
Add a new nunjucks filter to allow dynamic date calculation given
a base date and day offset and customizable formatting of the output.

alyip98 · 2019-06-27T07:14:49Z

This is still an early WIP, but I want to get some opinions on where the base date should be defined, and whether the syntax is suitable/user friendly

damithc · 2019-06-27T07:35:19Z

Note that the date may need to be embedded in other text. e.g., Remember to submit by the deadline (Jan 12, 2019) in the right format ...

It would be nice if a site can support multiple timelines too. The current approach seems to be limited to one timeline per site (because the reference date is fixed to the base variable)

openorclose · 2019-06-28T03:03:42Z

src/lib/markbind/src/lib/markdown-it/markdown-it-date.js

+ */
+function parseInput(match) {
+  // Parse week number
+  if (isNaN(match[1])) {


Will this ever be true, since the regex only matches digits? Also can change the regex for this to \d\d? since week should only be 2 digits.

openorclose · 2019-06-28T03:07:31Z

src/lib/markbind/src/lib/markdown-it/markdown-it-date.js

+
+  // Parse day
+  let day = match[2].toLowerCase();
+  if (isNaN(day)) {


Should check the length instead, 3 character / 1 character. \w{3} also matches 3 digits. which may not be intended.

If day is 001 it'll still be correct and interpreted as 1. Is this intended? Probably not a big deal either way

damithc · 2020-02-20T14:27:13Z

Shall we revive this PR @alyip98

openorclose

Nice error handling. What about printing the error message and the file location too, in case authors publish without checking?

openorclose · 2020-02-23T17:15:19Z

src/lib/markbind/src/lib/markdown-it/markdown-it-date.js

+
+  // Parse day
+  let day = match[2].toLowerCase();
+  if (isNaN(day)) {


If day is 001 it'll still be correct and interpreted as 1. Is this intended? Probably not a big deal either way

openorclose · 2020-02-23T17:15:23Z

src/lib/markbind/src/lib/markdown-it/markdown-it-date.js

+      return formatError(DAY_INVALID, raw);
+    }
+  } else {
+    day = parseInt(day);


Still recommended to have the base (and i think we do include the base in other code)

Suggested change

day = parseInt(day);

day = parseInt(day, 10);

It defaults to 10, and in this case it's impossible to have 0x in the string so it seems unnecessary

openorclose · 2020-02-23T17:15:26Z

src/lib/markbind/src/lib/markdown-it/markdown-it-date.js

+  }
+
+  let formatPattern = match[4] || DEFAULT_FORMAT;
+  formatPattern = formatPattern === '' ? DEFAULT_FORMAT : formatPattern;


Should be able to reduce to

Suggested change

formatPattern = formatPattern === '' ? DEFAULT_FORMAT : formatPattern;

const formatPattern = match[4] === '' ? DEFAULT_FORMAT : formatPattern;

?

match[4] could be empty string or undefined

alyip98 · 2020-02-26T08:48:12Z

Ready for review!

openorclose · 2020-03-02T05:14:45Z

docs/userGuide/syntax/dates.mbdf

+
+The semester starts on @date:{{ sem_start }} W1#1@
+
+Lab 1 is due on @date:{{ sem_start }} W3#5@


Need to find a way to escape the mustache syntax.

alyip98 · 2020-03-12T11:35:49Z

Updated the PR with details regarding the new implemenation, i.e. syntax is now {{ baseDate | date(format, dayOffset) }} and it leverages nunjucks rather than adding a new "tag" symbol.

Please let me know if there are any concerns or improvements

yamgent

This new syntax is definitely much cleaner, nice job. 👍

test/functional/test_site/testDates.md

docs/userGuide/syntax/dates.mbdf

openorclose · 2020-03-16T05:16:05Z

src/lib/markbind/src/lib/nunjucks-extensions/nunjucks-date.js

+  return Moment(base).add(days, 'days');
+}
+
+function filter(baseDate, format = DEFAULT_FORMAT, day = 0) {


Is it possible to allow the user to set a DEFAULT_FORMAT? Maybe somewhere in site.json.

Then we can change the arguments to filter to filter(baseDate, day = 0, format = DEFAULT_FORMAT).

This is assuming that the most frequent use case would be the author having only 1 format they want to use, so being able to do {{ base | date(7*2 + 1) }} and avoid typing the format all the time might be easier syntax.

Fair point, I suppose if there really was a need we could also split the filter into 2 separate filters in a future PR, like {{ baseDate | addDays(7 * 2 + 1) | formatDate(format) }}.

Configuring a custom DEFAULT_FORMAT isn't too hard but I'm not sure if it will be very useful, since an extra argument isn't a hassle. An alternative is to define a nunjucks macro (customFormat defined in variables.md)

{% macro customDate(baseDate, days) %} {{ baseDate | date(customFormat, days) }} {% endmacro %} Usage: {{ customDate(baseDate, 5) }}

Could we still allow this, but without the configuration? :o
( swapping the day and format in format = DEFAULT_FORMAT, day = 0) { )

damithc · 2020-03-16T11:59:25Z

ang-zeyu

LGTM in general 👍; The require('nunjucks').configure() could be restructured to apply to all three files.
Just some small nits otherwise:

docs/userGuide/syntax/dates.mbdf

ang-zeyu · 2020-03-17T17:22:01Z

src/lib/markbind/src/lib/nunjucks-extensions/nunjucks-date.js

+  return Moment(base).add(days, 'days');
+}
+
+function filter(baseDate, format = DEFAULT_FORMAT, day = 0) {


Could we still allow this, but without the configuration? :o
( swapping the day and format in format = DEFAULT_FORMAT, day = 0) { )

src/lib/markbind/src/parser.js

test/unit/parser.test.js

src/lib/markbind/src/lib/nunjucks-extensions/nunjucks-date.js

docs/userGuide/syntax/dates.mbdf

test/functional/test_site/testDates.md

openorclose

The {{ base | date(format, 7*2 + 1) }} method should be quite clear for now.

My concerns about the format param not being used too often may be unfounded after users test it out, and we can create another issue to swap the params if the format parameter is left mostly to some default.

src/Page.js

ang-zeyu

Just one last nit, could resolve the conflicts as well!

test/functional/test_site/testDates.md

src/lib/markbind/src/parser.js

docs/userGuide/syntax/dates.mbdf

test/functional/test_site/_markbind/variables.md

src/lib/markbind/src/utils/nunjuckUtils.js

src/Site.js

ang-zeyu · 2020-04-04T15:39:04Z

test/functional/test_site/testDates.md

+
+{{ base2 | date(format2, 10) }} should be Fri 11/01
+
+{{ formatted_date }} should be Tue 1 Jan


Fri 11 Jan

LGTM otherwise, nice work on the njutil refactor 👍

damithc · 2020-04-04T17:37:10Z

docs/userGuide/syntax/dates.mbdf

+
+The baseDate follows the format: `YYYY-MM-DD`
+
+It can be supplied using [page variables](../reusingContents.html#variables) for convenience.


Can elaborate on this?

The format portion or the page variables portion?

page variable portion. May be give an example?

ang-zeyu

Noticed a few more doc nits, could polish it up here or in a separate PR

could standardise with the level of subheadings used elsewhere in the page h2 -> h4 -> h5
#### Custom formatting seems to be a repeat of ### Advanced formatting
Could combine page variables into using variables

alyip98 · 2020-04-05T11:44:01Z

Noticed a few more doc nits, could polish it up here or in a separate PR

could standardise with the level of subheadings used elsewhere in the page h2 -> h4 -> h5

#### Custom formatting seems to be a repeat of ### Advanced formatting

Could combine page variables into using variables

Let's do this in a separate PR, it can be a good first issue

ang-zeyu · 2020-04-05T12:22:32Z

Let's do this in a separate PR, it can be a good first issue

👍, seems good to be merged in that case. Do open up an issue!

* 'master' of https://github.com/MarkBind/markbind: (41 commits) Document adding new site content in DG (MarkBind#1153) Add relative date feature (MarkBind#908) Use <br> to separate lines of code block (MarkBind#1176) Parse popovers for footnotes (MarkBind#1155) Resolve comments Expand test extensions and fix whitespace checks (MarkBind#1156) Address comments Upgrade js-beautify and provide option to turn it off (MarkBind#1116) Normalize inline puml line ending before hashing (MarkBind#1174) Update tests (MarkBind#1178) Remove fixed bugs from test\functional\test_site\bugs\index.md` (MarkBind#1148) Fix bug in Search for UG and DG (MarkBind#1147) Add inline puml support (MarkBind#1100) Fix hrefs for headings with angular brackets (MarkBind#1089) Update tests for 2.13.1 (MarkBind#1169) 2.13.1 Update vue-strap version to v2.0.1-markbind.39 Fix fontawsome icons don't show underlines to indicate modal/tooltip (MarkBind#1133) 2.13.0 Update test files ...

Add a new nunjucks filter to allow dynamic date calculation given a base date and day offset and customizable formatting of the output.

damithc · 2020-04-18T14:33:52Z

Seems to be working in production. Good work @alyip98 and reviewers. It will be very useful for the module websites next semester.

openorclose reviewed Jun 28, 2019

View reviewed changes

openorclose marked this pull request as ready for review August 2, 2019 04:25

alyip98 force-pushed the 901-rel-dates branch from c809035 to 8a17530 Compare February 21, 2020 04:51

alyip98 changed the title ~~[WIP] Add relative date feature~~ Add relative date feature Feb 21, 2020

alyip98 force-pushed the 901-rel-dates branch 4 times, most recently from 79e7c22 to db1e095 Compare February 23, 2020 08:57

alyip98 requested a review from openorclose February 23, 2020 09:18

openorclose requested changes Feb 23, 2020

View reviewed changes

alyip98 force-pushed the 901-rel-dates branch 2 times, most recently from 5442e5e to ec25bba Compare February 26, 2020 08:44

alyip98 requested a review from openorclose February 26, 2020 08:48

openorclose reviewed Mar 2, 2020

View reviewed changes

alyip98 force-pushed the 901-rel-dates branch from ec25bba to 286d8e3 Compare March 5, 2020 13:11

alyip98 force-pushed the 901-rel-dates branch from 6ed76b0 to b2bf644 Compare March 13, 2020 03:26

yamgent reviewed Mar 15, 2020

View reviewed changes

test/functional/test_site/testDates.md Outdated Show resolved Hide resolved

docs/userGuide/syntax/dates.mbdf Outdated Show resolved Hide resolved

docs/userGuide/syntax/dates.mbdf Show resolved Hide resolved

docs/userGuide/syntax/dates.mbdf Show resolved Hide resolved

damithc reviewed Mar 15, 2020

View reviewed changes

docs/userGuide/syntax/dates.mbdf Outdated Show resolved Hide resolved

openorclose reviewed Mar 16, 2020

View reviewed changes

alyip98 requested a review from openorclose March 16, 2020 06:18

ang-zeyu reviewed Mar 17, 2020

View reviewed changes

openorclose approved these changes Mar 18, 2020

View reviewed changes

crphang reviewed Mar 18, 2020

View reviewed changes

src/Page.js Outdated Show resolved Hide resolved

alyip98 force-pushed the 901-rel-dates branch from 6075b4d to 3883b32 Compare March 21, 2020 07:27

ang-zeyu requested changes Mar 21, 2020

View reviewed changes

test/functional/test_site/testDates.md Show resolved Hide resolved

src/lib/markbind/src/parser.js Outdated Show resolved Hide resolved

alyip98 force-pushed the 901-rel-dates branch from 3883b32 to 76066d7 Compare March 26, 2020 13:38

ang-zeyu reviewed Mar 27, 2020

View reviewed changes

src/Site.js Outdated Show resolved Hide resolved

alyip98 force-pushed the 901-rel-dates branch 2 times, most recently from 9f5eb2d to b23fe59 Compare April 4, 2020 12:45

Add date filter feature

49c91d6

alyip98 force-pushed the 901-rel-dates branch 2 times, most recently from 5145603 to 21e68fa Compare April 4, 2020 13:12

ang-zeyu approved these changes Apr 4, 2020

View reviewed changes

alyip98 requested a review from ang-zeyu April 4, 2020 17:16

alyip98 force-pushed the 901-rel-dates branch from 21e68fa to ea4d4ca Compare April 4, 2020 17:18

ang-zeyu approved these changes Apr 4, 2020

View reviewed changes

ang-zeyu added this to the v2.13.2 milestone Apr 4, 2020

damithc reviewed Apr 4, 2020

View reviewed changes

alyip98 added 2 commits April 5, 2020 03:39

Doc: Add documentation for date filter

42be9b8

Test: Add tests for date filter

50508bd

alyip98 force-pushed the 901-rel-dates branch from ea4d4ca to 50508bd Compare April 4, 2020 19:39

ang-zeyu reviewed Apr 5, 2020

View reviewed changes

alyip98 merged commit b20f421 into MarkBind:master Apr 8, 2020

marvinchin pushed a commit that referenced this pull request Apr 10, 2020

Add relative date feature (#908)

a0ef39f

Add a new nunjucks filter to allow dynamic date calculation given a base date and day offset and customizable formatting of the output.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add relative date feature #908

Add relative date feature #908

alyip98 commented Jun 27, 2019 •

edited

Loading

alyip98 commented Jun 27, 2019

damithc commented Jun 27, 2019

openorclose Jun 28, 2019

openorclose Jun 28, 2019

openorclose Feb 23, 2020

damithc commented Feb 20, 2020

openorclose left a comment

openorclose Feb 23, 2020

openorclose Feb 23, 2020

alyip98 Feb 26, 2020

openorclose Feb 23, 2020

alyip98 Feb 26, 2020

alyip98 commented Feb 26, 2020

openorclose Mar 2, 2020

alyip98 commented Mar 12, 2020

yamgent left a comment

openorclose Mar 16, 2020

alyip98 Mar 16, 2020 •

edited

Loading

ang-zeyu Mar 17, 2020

damithc commented Mar 16, 2020

ang-zeyu left a comment

ang-zeyu Mar 17, 2020

openorclose left a comment

ang-zeyu left a comment •

edited

Loading

ang-zeyu Apr 4, 2020

damithc Apr 4, 2020

alyip98 Apr 4, 2020

damithc Apr 4, 2020

ang-zeyu left a comment

alyip98 commented Apr 5, 2020

ang-zeyu commented Apr 5, 2020

damithc commented Apr 18, 2020

	formatPattern = formatPattern === '' ? DEFAULT_FORMAT : formatPattern;
	const formatPattern = match[4] === '' ? DEFAULT_FORMAT : formatPattern;


		The semester starts on @date:{{ sem_start }} W1#1@

		Lab 1 is due on @date:{{ sem_start }} W3#5@


		{{ base2 \| date(format2, 10) }} should be Fri 11/01

		{{ formatted_date }} should be Tue 1 Jan


		The baseDate follows the format: `YYYY-MM-DD`

		It can be supplied using [page variables](../reusingContents.html#variables) for convenience.

Add relative date feature #908

Add relative date feature #908

Conversation

alyip98 commented Jun 27, 2019 • edited Loading

alyip98 commented Jun 27, 2019

damithc commented Jun 27, 2019

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

damithc commented Feb 20, 2020

openorclose left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

alyip98 commented Feb 26, 2020

Choose a reason for hiding this comment

alyip98 commented Mar 12, 2020

yamgent left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

alyip98 Mar 16, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

damithc commented Mar 16, 2020

ang-zeyu left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

openorclose left a comment

Choose a reason for hiding this comment

ang-zeyu left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ang-zeyu left a comment

Choose a reason for hiding this comment

alyip98 commented Apr 5, 2020

ang-zeyu commented Apr 5, 2020

damithc commented Apr 18, 2020

alyip98 commented Jun 27, 2019 •

edited

Loading

alyip98 Mar 16, 2020 •

edited

Loading

ang-zeyu left a comment •

edited

Loading