@rocket.chat/message-parser
TypeScript icon, indicating that this package has built-in type declarations

0.31.29 • Public • Published

Rocket.Chat

@rocket.chat/message-parser

Rocket.Chat parser for messages


npm@latest npm@next npm downloads License: MIT

deps npm bundle size

Description

Rocket.Chat grammar with the purpose of parsing the messages of the rocket chat, converting text to an AST tree.

The grammar provides support for markdown, mentions and emojis.

Supported markup

  • quotes
  • bold/italic/strike
  • ordered lists
  • unordered lists
  • task lists
  • phone numbers
  • mentions
  • emoji
  • colors
  • URI's
  • mentions users/channels
  • timestamps

Timestamps

The timestamp tag is a special tag that allows you to convert a Unix timestamp to a human-readable date and time.

Timestamps are allowed inside strike elements.

Usage

Pattern: <t:{timestamp}:?{format}>

  • {timestamp} is a Unix timestamp
  • {format} is an optional parameter that can be used to customize the date and time format.

Formats

Format Description Example
t Short time 12:00 AM
T Long time 12:00:00 AM
d Short date 12/31/2020
D Long date Thursday, December 31, 2020
f Full date and time Thursday, December 31, 2020 12:00 AM
F Full date and time (long) Thursday, December 31, 2020 12:00:00 AM
R Relative time 1 year ago

Contributing

Contributions, issues, and feature requests are welcome!
Feel free to check the issues.

Whenever you find a grammar-related bug, start by inserting the test case.

We are open to other tags/markups, as long as they don't generate unexpected behavior.

Observations and known issues

  • Nested lists are unsupported
  • URL rule doesn't allow whitespace, (, or )

Versions

Current Tags

Version History

Package Sidebar

Install

npm i @rocket.chat/message-parser

Weekly Downloads

1,251

Version

0.31.29

License

MIT

Unpacked Size

1.17 MB

Total Files

16

Last publish

Collaborators

  • dougfabris
  • rocketchat-buildmaster
  • geekgonecrazy
  • rodrigok
  • sing.li
  • diegosampaio
  • gazzo
  • dgubert
  • tassoevan