Circulars: Convert emails to hyperlinks

[tylerbarna]

Description

We currently have functionality that automatically inserts hyperlinks for URLs, DOIs, TNSs, and GCN Circulars when they're referenced in Circulars. It may be beneficial to automatically hyperlink email addresses, both in the body of Circulars and in the submitter information.

The submitter email will be a more straightforward regular expression, as it can simply be a regular expression that matches any string enclosed by <>, but the regular expression to link to emails in a Circular may be less straightforward.

Acceptance criteria

• Implement a regular expression (or regular expressions) that match any strings that contain an email [email protected] and convert them to a hyperlink in the format mailto:[email protected]
• Ensure arbitrary strings that contain the @ symbol are not matched by the regular expression
• Apply this regular expression to both the submitter email and any potential emails in the body of Circulars
• The function that evaluates the regular expression should be able to handle instances where the submitter does not contain an email without raising an error

[lpsinger]

It already works for Markdown-formatted Circulars because this is done by the autolink literals plugin.

[lpsinger]

Here's where the code lives: https://github.com/nasa-gcn/gcn.nasa.gov/blob/main/app/routes/circulars.%24circularId.(%24version)/rehypeAutolinkLiteral.ts

[tylerbarna]

It already works for Markdown-formatted Circulars because this is done by the autolink literals plugin.

does this include the submitter email in the header?

[lpsinger]

It already works for Markdown-formatted Circulars because this is done by the autolink literals plugin.

does this include the submitter email in the header?

No, but you could easily process that using remark/rehype.

[tylerbarna]

@lpsinger that's what I was thinking, should this issue be migrated to remark-rehype-astro?

[lpsinger]

No. As I said, this code is in https://github.com/nasa-gcn/gcn.nasa.gov/blob/main/app/routes/circulars.%24circularId.(%24version)/rehypeAutolinkLiteral.ts.