1. 1
2. 2
3. 3
4. 4
5. 5
6. 6
7. 7
8. 8
9. 9
10. 10
11. 11
12. 12
13. 13
14. 14
15. 15
16. 16
17. 17
18. 18
19. 19
20. 20
21. 21
22. 22
23. 23
24. 24
25. 25
26. 26
27. 27
28. 28
29. 29
30. 30
31. 31
32. 32
33. 33
34. 34
35. 35
36. 36
37. 37
38. 38
39. 39
40. 40
41. 41
42. 42
43. 43
44. 44
45. 45
46. 46
47. 47
48. 48
49. 49
50. 50
51. 51
52. 52
53. 53
54. 54
55. 55
56. 56
57. 57
58. 58
59. 59
60. 60
61. 61
62. 62
63. 63
64. 64
65. 65
66. 66
67. 67
68. 68
69. 69
70. 70
71. 71
72. 72
73. 73
74. 74
75. 75
76. 76
77. 77
78. 78
79. 79
80. 80
81. 81
82. 82
83. 83
84. 84
85. 85
86. 86
87. 87
88. 88
89. 89
90. 90
91. 91
92. 92
93. 93
94. 94
95. 95
96. 96
97. 97
98. 98
99. 99
100. 100
101. 101

# Introduction

slack-message-parser is a JavaScript library to parse a message returned by Slack API then give you an AST-like tree object.
You can use the result tree to create a message viewer (HTML, React component, etc...) or whatever you want.

## Important note

There are some cases it's impossible to correctly parse a message composed by [Slack's WYSIWYG message editor][slack-wyswig], especially when an inline code block is involved (see [#26]).
Please consider traversing Blocks (`blocks` property) first.
This library is suitable for fallback purpose or for when Blocks are not available.

[slack-wyswig]: https://api.slack.com/changelog/2019-09-what-they-see-is-what-you-get-and-more-and-less
[#26]: https://github.com/pocka/slack-message-parser/issues/26

## Quick glance

```ts
import slackMessageParser from "slack-message-parser";

const tree = slackMessageParser("Slack *message* ~to~ _parse_");

console.dir(tree);
```

<details>
  <summary>Output</summary>

```js
({
  type: NodeType.Root,
  children: [
    {
      type: NodeType.Text,
      text: "Slack ",
      source: "Slack ",
    },
    {
      type: NodeType.Bold,
      children: [
        {
          type: NodeType.Text,
          text: "message",
          source: "message",
        },
      ],
      source: "*message*",
    },
    {
      type: NodeType.Text,
      text: " ",
      source: " ",
    },
    {
      type: NodeType.Strike,
      children: [
        {
          type: NodeType.Text,
          text: "to",
          source: "to",
        },
      ],
      source: "~to~",
    },
    {
      type: NodeType.Text,
      text: " ",
      source: " ",
    },
    {
      type: NodeType.Italic,
      children: [
        {
          type: NodeType.Text,
          text: "parse",
          source: "parse",
        },
      ],
      source: "_parse_",
    },
  ],
  source: "Slack *message* ~to~ _parse_",
});
```

</details>

## Available Syntax

- Plain text
- Links
  - Channels (`#channel`)
  - User (`@someone`)
  - URL (`https://foo.bar`, `mailto:foo@bar`)
  - Commands (Represented as `<!foo>`, more details [here](https://api.slack.com/docs/message-formatting))
- Emojis 😍
- Code block
- Inline code (<code>\`foo\`</code>)
- Italic (`_foo_`)
- Bold (`*foo*`)
- Strikethrough (`~foo~`)
- Quotes (`> foo`)