The communications platform that puts data protection first.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
Rocket.Chat/packages/message-parser
Shreyas 2affa1798a
test(message-parser): decouple parser tests from production helpers (#39086)
1 day ago
..
benchmarks chore: add fullOptions to Emoji benchmark fixtures (#39035) 2 days ago
loaders refactor(message-parser): update benchmark suite to use ts-node and add custom .pegjs loader 3 days ago
src fix(message-parser): decimal numbers and underscore-wrapped text render as italic (#38981) 2 days ago
tests test(message-parser): decouple parser tests from production helpers (#39086) 1 day ago
.eslintrc.json chore: Reformat package manifest files (#37639) 3 months ago
.gitignore chore: move message-parser and peggy-loader to main repo (#31796) 2 years ago
CHANGELOG.md Release 8.1.0 3 weeks ago
README.md feat(message-parser): add timestamps pattern (#31810) 2 years ago
jest.config.ts test(message-parser): add benchmark suite for parser performance baseline (#38905) 3 days ago
package.json refactor(message-parser): update benchmark suite to use ts-node and add custom .pegjs loader 3 days ago
tsconfig.build.json chore(message-parser): Review build configuration (#37737) 2 months ago
tsconfig.json chore(message-parser): Review build configuration (#37737) 2 months ago
webpack.config.ts chore(message-parser): Review build configuration (#37737) 2 months ago

README.md

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 )