@sfirew/minecraft-motd-parser 1.1.3 → 1.1.5-dev.1

package/README.md

@@ -1,307 +1,211 @@
 # Minecraft Server MOTD Parser
+
 ![Version](https://img.shields.io/github/languages/top/SnowFireWolf/minecraft-motd-parser?style=for-the-badge)
 [![npm version](https://img.shields.io/npm/v/@sfirew/minecraft-motd-parser?label=version&style=for-the-badge)](https://www.npmjs.com/package/@sfirew/minecraft-motd-parser?style=for-the-badge)
 [![License](https://img.shields.io/npm/l/minecraft-server-util?style=for-the-badge)](https://github.com/SnowFireWolf/minecraft-motd-parser/blob/master/LICENSE)
 ![npm weekly downloads](https://img.shields.io/npm/dw/@sfirew/minecraft-motd-parser?style=for-the-badge)
 
+A powerful and lightweight library to parse Minecraft server MOTD (Message of the Day) data into various formats.
+
+
+
+## Table of Contents
 
+- [Features](#features)
+- [Installation](#installation)
+- [Quick Start](#quick-start)
+- [API Reference](#api-reference)
+  - [Auto Detection](#auto-detection)
+  - [Text Parsing](#text-parsing)
+  - [JSON Parsing](#json-parsing)
+  - [Clean Text](#clean-text)
+- [Examples](#examples)
+- [Visual Examples](#visual-examples)
+- [Contributing](#contributing)
 
-## Introduction
-This package support **CommonJS**, **ES Module**, and **tree shaking**
 
-Can convert minecraft server MOTD data to text, json, html, and clean codes.
 
-Support **1.16** custom **hex color**, and auto check motd data type.
+## Features
 
-Don't have other dependencies.
+✨ **Zero Dependencies** - Lightweight and fast  
+🔄 **Auto Detection** - Automatically detects MOTD data type  
+🎨 **Multiple Formats** - Convert to HTML, JSON, or clean text  
+🌈 **Full Color Support** - Including Minecraft 1.16+ hex colors  
+📦 **Module Support** - CommonJS, ES Modules, and tree shaking  
+🎯 **TypeScript Ready** - Full TypeScript support
 
 
 
 ## Installation
-choose your favorite package manager
+
+Choose your favorite package manager:
+
 ```bash
 # npm
-$ npm install @sfirew/minecraft-motd-parser
+npm install @sfirew/minecraft-motd-parser
 
 # yarn
-$ yarn add @sfirew/minecraft-motd-parser
+yarn add @sfirew/minecraft-motd-parser
 
 # pnpm
-$ pnpm add @sfirew/minecraft-motd-parser
+pnpm add @sfirew/minecraft-motd-parser
 ```
 
 
 
-## Usage
-### CommonJS
-```typescript
-const { autoToHTML } = require('@sfirew/minecraft-motd-parser');
-```
+## Quick Start
 
 ### ES6 Modules
 ```typescript
 import { autoToHTML } from '@sfirew/minecraft-motd-parser'
+
+const motd = "§aHypixel Network §7§c1.8/1.9/1.10/1.11/1.12 §e§lNEW PTL GAME:§b§l THE BRIDGE";
+const html = autoToHTML(motd);
+console.log(html);
 ```
 
-### Simple use example
+### CommonJS
 ```typescript
-import { autoToHTML as motdParser } from '@sfirew/minecraft-motd-parser'
-// or 
-import motdParser from '@sfirew/minecraft-motd-parser'
-// motdParser.autoToHTML('motdString...');
-
-const hypixelMotdString = "§aHypixel Network §7§c1.8/1.9/1.10/1.11/1.12 §e§lNEW PTL GAME:§b§l THE BRIDGE";
-
-console.log(motdParser(hypixelMotdString));
-
-/* result
-<span style="color:#55FF55;">Hypixel Network </span><span style="color:#FF5555;">1.8/1.9/1.10/1.11/1.12 </span><span style="color:#FFFF55;font-weight: bold;">NEW PTL GAME:</span><span style="color:#55FFFF;font-weight: bold;"> THE BRIDGE</span>
-*/
+const { autoToHTML } = require('@sfirew/minecraft-motd-parser');
 ```
 
+### Default Import
+```typescript
+import motdParser from '@sfirew/minecraft-motd-parser'
+motdParser.autoToHTML('motdString...');
+```
 
-### Some good custom motd hex color servers
-The parser does not have the Minecraft font by default.
 
-#### Minecraft font example
-![Image_2022_01_2022d-2022h_58___002](https://user-images.githubusercontent.com/14024836/149810729-71909ca5-5705-43cf-ab3c-bdd66db00b78.png)
 
-![Image_2022_01_2022d-2022h_00___004](https://user-images.githubusercontent.com/14024836/149811040-5ddc35a0-38cf-4434-856a-968c94a4d6b4.png)
+## API Reference
 
-#### No Minecraft font
-![Image_2022_01_2022d-2022h_04___003](https://user-images.githubusercontent.com/14024836/149811501-d1376d90-d9ad-4092-912a-de1f78fa42eb.png)
+### Auto Detection
 
-![Image_2022_01_2022d-2022h_01___002](https://user-images.githubusercontent.com/14024836/149811151-d9270d63-aead-46f9-b496-c88eb3b00c72.png)
+#### `autoToHTML(data: string | object): string`
+Automatically detects the MOTD data type and converts it to HTML.
 
+```typescript
+import { autoToHTML } from '@sfirew/minecraft-motd-parser'
 
-You can try server status view in my created service
-[https://mcsv.top/server/mc.hypixel.net](https://mcsv.top/server/mc.hypixel.net)
+// Works with both text and JSON formats
+const textMOTD = "§aHypixel Network §c1.8-1.19";
+const jsonMOTD = { text: "", extra: [{ color: "green", text: "Hello World" }] };
 
+console.log(autoToHTML(textMOTD));
+console.log(autoToHTML(jsonMOTD));
+```
 
+#### `autoCleanToText(data: string | object): string`
+Automatically detects the MOTD data type and returns clean text without formatting codes.
 
-## Example and main formatter
-Some examples here, you can use **TypeScript** or **JavaScript**.
+```typescript
+import { autoCleanToText } from '@sfirew/minecraft-motd-parser'
 
+const motd = "§aHypixel Network §c1.8-1.19";
+console.log(autoCleanToText(motd)); // "Hypixel Network 1.8-1.19"
+```
 
+### Text Parsing
 
-### `autoToHTML(string | object)`
-auto check MOTD data type then return same html result.
+#### `textToHTML(text: string): string`
+Converts MOTD text format to HTML.
 
 ```typescript
-import motdParser from '@sfirew/minecraft-motd-parser'
+import { textToHTML } from '@sfirew/minecraft-motd-parser'
 
-let jsonExample = {
-  "extra": [
-    {
-      "bold": true,
-      "color": "gold",
-      "text": "Viper "
-    },
-    {
-      "color": "gray",
-      "text": "┃ "
-    },
-    {
-      "color": "yellow",
-      "text": "Summer Sale"
-    },
-    {
-      "color": "white",
-      "text": " at "
-    },
-    {
-      "color": "gold",
-      "text": "store.vipermc.net\n"
-    },
-    {
-      "color": "gray",
-      "text": "► "
-    },
-    {
-      "color": "yellow",
-      "text": "EOTW "
-    },
-    {
-      "color": "white",
-      "text": "on "
-    },
-    {
-      "color": "gold",
-      "text": "Infernal"
-    },
-    {
-      "color": "white",
-      "text": " is this Thursday at "
-    },
-    {
-      "color": "yellow",
-      "text": "5PM ET"
-    },
-    {
-      "color": "white",
-      "text": "."
-    }
-  ],
-  "text": ""
-};
-let autoJsonResult = motdParser.autoToHTML(jsonExample);
-console.log(autoJsonResult);
-
-/* auto JSON Result, callback HTML:
-<span style="color: #FFAA00;font-weight: bold;">Viper </span><span style="color: #AAAAAA;">┃ </span><span style="color: #FFFF55;">Summer Sale</span><span style="color: #FFFFFF;"> at </span><span style="color: #FFAA00;">store.vipermc.net<br/></span><span style="color: #AAAAAA;">► </span><span style="color: #FFFF55;">EOTW </span><span style="color: #FFFFFF;">on </span><span style="color: #FFAA00;">Infernal</span><span style="color: #FFFFFF;"> is this Thursday at </span><span style="color: #FFFF55;">5PM ET</span><span style="color: #FFFFFF;">.</span>
-*/
-
-let textExample = "§aHypixel Network §7§c1.8/1.9/1.10/1.11/1.12 §e§lNEW PTL GAME:§b§l THE BRIDGE";
-let autoTextResult = motdParser.autoToHTML(textExample);
-console.log(autoTextResult);
-
-/* auto Text Result, callback HTML:
-<span style="color: #55FF55;">Hypixel Network <span style="color: #AAAAAA;"><span style="color: #FF5555;">1.8/1.9/1.10/1.11/1.12 <span style="color: #FFFF55;"><span style="font-weight: bold;">NEW PTL GAME:<span style="color: acqua;"><span style="font-weight: bold;"> THE BRIDGE</span></span></span></span></span></span></span>
-*/
+const motd = "§aGreen §lBold §rReset §cRed";
+const html = textToHTML(motd);
+// Output: <span style="color:#55FF55;">Green <span style="font-weight:bold;">Bold </span></span><span style="color:#FF5555;">Red</span>
 ```
 
+#### `textToJSON(text: string): object`
+Converts MOTD text format to JSON structure.
 
+```typescript
+import { textToJSON } from '@sfirew/minecraft-motd-parser'
 
+const motd = "§aHello §bWorld";
+const json = textToJSON(motd);
+console.log(json);
+```
 
+### JSON Parsing
 
+#### `JSONToHTML(json: object): string`
+Converts MOTD JSON format to HTML.
 
-## clean codes formatter
-### `cleanCodes(string)`
-clean motd text color codes.
 ```typescript
-import motdParser from '@sfirew/minecraft-motd-parser' 
-import { cleanCodes } from '@sfirew/minecraft-motd-parser'
+import { JSONToHTML } from '@sfirew/minecraft-motd-parser'
 
-const motdText = "§aHypixel Network §7§c1.8/1.9/1.10/1.11/1.12 §e§lNEW PTL GAME:§b§l THE BRIDGE";
-const result = cleanCodes(motdText);
-console.log(result);
+const motdJson = {
+  text: "",
+  extra: [
+    { color: "green", text: "Hello " },
+    { color: "blue", text: "World", bold: true }
+  ]
+};
 
-/* result, callback Text:
- * Hypixel Network 1.8/1.9/1.10/1.11/1.12 NEW PTL GAME: THE BRIDGE
- */
+const html = JSONToHTML(motdJson);
 ```
 
+### Clean Text
 
+#### `cleanCodes(text: string): string`
+Removes all formatting codes from MOTD text.
 
-### `autoCleanToText(string | object)`
-auto check MOTD data type then return same cleaned text.
 ```typescript
-import motdParser from '@sfirew/minecraft-motd-parser' 
-import { autoCleanToText } from '@sfirew/minecraft-motd-parser'
-
-const motdText = "§aHypixel Network §7§c1.8/1.9/1.10/1.11/1.12 §e§lNEW PTL GAME:§b§l THE BRIDGE";
-const result = autoCleanToText(motdText);
-console.log(result);
+import { cleanCodes } from '@sfirew/minecraft-motd-parser'
 
-/* result, callback Text:
- * Hypixel Network 1.8/1.9/1.10/1.11/1.12 NEW PTL GAME: THE BRIDGE
- */
+const motd = "§aHypixel Network §c1.8-1.19";
+const clean = cleanCodes(motd);
+console.log(clean); // "Hypixel Network 1.8-1.19"
 ```
 
 
 
+## Examples
 
+### Complex MOTD with Multiple Formats
 
-
-## origin formatter
-### `textToHTML(string)`
-convert motd text to html.
 ```typescript
-let motdText = "§aHypixel Network §7§c1.8/1.9/1.10/1.11/1.12 §e§lNEW PTL GAME:§b§l THE BRIDGE";
-let result = motdParser.textToHTML(motdText);
-console.log(result);
+import motdParser from '@sfirew/minecraft-motd-parser'
 
-/* result, callback HTML:
- * <span style="color: #55FF55;">Hypixel Network <span style="color: #AAAAAA;"><span style="color: #FF5555;">1.8/1.9/1.10/1.11/1.12 <span style="color: #FFFF55;"><span style="font-weight: bold;">NEW PTL GAME:<span style="color: acqua;"><span style="font-weight: bold;"> THE BRIDGE</span></span></span></span></span></span></span>
- */
+// Text format example
+const textExample = "§aHypixel Network §7§c1.8/1.9/1.10/1.11/1.12 §e§lNEW PTL GAME:§b§l THE BRIDGE";
+console.log(motdParser.autoToHTML(textExample));
+
+// JSON format example
+const jsonExample = {
+  "text": "",
+  "extra": [
+    { "bold": true, "color": "gold", "text": "Viper " },
+    { "color": "gray", "text": "┃ " },
+    { "color": "yellow", "text": "Summer Sale" },
+    { "color": "white", "text": " at " },
+    { "color": "gold", "text": "store.vipermc.net\n" }
+  ]
+};
+console.log(motdParser.autoToHTML(jsonExample));
 ```
 
-![Image_2021_08_2021d-2021h_23___001](https://user-images.githubusercontent.com/14024836/129277576-e94914f3-35f7-45a6-8ba3-58163f71d5a1.png)
+## Visual Examples
 
+The parser supports rich formatting including colors, bold, italic, underline, and strikethrough text.
 
+### With Minecraft Font
+![Minecraft Font Example](https://user-images.githubusercontent.com/14024836/149810729-71909ca5-5705-43cf-ab3c-bdd66db00b78.png)
 
+### Standard Font
+![Standard Font Example](https://user-images.githubusercontent.com/14024836/149811501-d1376d90-d9ad-4092-912a-de1f78fa42eb.png)
 
-### `textToJSON(string)`
-convert motd json to html.
-```typescript
-let motdText = "§aHypixel Network §7§c1.8/1.9/1.10/1.11/1.12 §e§lNEW PTL GAME:§b§l THE BRIDGE";
-let result = motdParser.textToJSON(motdText);
-console.log(result);
+> **Try it live**: Check out the [Minecraft Server Status Viewer](https://mcsv.top/server/mc.hypixel.net) to see the parser in action.
 
-/* result, callback JSON:
-{
-  text: '',
-  extra: [
-    { text: '', extra: [] },
-    { text: 'Hypixel Network ', extra: [], color: '#55FF55' },
-    { text: '', extra: [], color: '#AAAAAA' },
-    { text: '1.8/1.9/1.10/1.11/1.12 ', extra: [], color: '#FF5555' },
-    { text: '', extra: [], color: '#FFFF55' },
-    { text: 'NEW PTL GAME:', extra: [], bold: true, color: '#FFFF55' },
-    { text: '', extra: [], bold: true, color: '#55FFFF' },
-    { text: ' THE BRIDGE', extra: [], bold: true, color: '#55FFFF' }
-  ]
-}
- */
-```
+## Contributing
 
+Contributions are welcome! Please feel free to submit a Pull Request.
 
-### `JSONToHTML(object)`
-convert text to motd json.
-```typescript
-let mcfalloutJson = {
-  "extra": [
-    {
-      "color": "gray",
-      "text": "  "
-    },
-    {
-      "color": "gold",
-      "text": "廢土伺服器  "
-    },
-    {
-      "color": "white",
-      "text": "mcFallout.net"
-    },
-    {
-      "color": "dark_gray",
-      "text": " - "
-    },
-    {
-      "color": "gray",
-      "text": "版本 1.17.1 "
-    },
-    {
-      "color": "gold",
-      "text": "洞穴"
-    },
-    {
-      "color": "light_purple",
-      "text": "與"
-    },
-    {
-      "color": "aqua",
-      "text": "山崖\n"
-    },
-    {
-      "color": "gray",
-      "text": "  "
-    },
-    {
-      "color": "dark_gray",
-      "text": "享受工廠、農場、建築與紅石"
-    }
-  ],
-  "text": ""
-}
-let result = motdParser.JSONToHTML(mcfalloutJson);
-console.log(result)
-
-/* result, callback HTML:
-<span style="color: #AAAAAA;">  </span><span style="color: #FFAA00;">廢土伺服器  </span><span style="color: #FFFFFF;">mcFallout.net</span><span style="color: #555555;"> - </span><span style="color: #AAAAAA;">版本 1.17.1 </span><span style="color: #FFAA00;">洞穴</span><span style="color: #FF55FF;">與</span><span style="color: #55FFFF;">山崖<br/></span><span style="color: #AAAAAA;">  </span><span style="color: #555555;">享受工廠、農場、建築與紅石</span>
-*/
-```
+## License
 
-![Image_2021_08_2021d-2021h_24___001](https://user-images.githubusercontent.com/14024836/129277638-fe8c5735-54fe-4ff1-afc5-4b5493706be9.png)
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
 
 

package/coverage/base.css

@@ -0,0 +1,224 @@
+body, html {
+  margin:0; padding: 0;
+  height: 100%;
+}
+body {
+    font-family: Helvetica Neue, Helvetica, Arial;
+    font-size: 14px;
+    color:#333;
+}
+.small { font-size: 12px; }
+*, *:after, *:before {
+  -webkit-box-sizing:border-box;
+     -moz-box-sizing:border-box;
+          box-sizing:border-box;
+  }
+h1 { font-size: 20px; margin: 0;}
+h2 { font-size: 14px; }
+pre {
+    font: 12px/1.4 Consolas, "Liberation Mono", Menlo, Courier, monospace;
+    margin: 0;
+    padding: 0;
+    -moz-tab-size: 2;
+    -o-tab-size:  2;
+    tab-size: 2;
+}
+a { color:#0074D9; text-decoration:none; }
+a:hover { text-decoration:underline; }
+.strong { font-weight: bold; }
+.space-top1 { padding: 10px 0 0 0; }
+.pad2y { padding: 20px 0; }
+.pad1y { padding: 10px 0; }
+.pad2x { padding: 0 20px; }
+.pad2 { padding: 20px; }
+.pad1 { padding: 10px; }
+.space-left2 { padding-left:55px; }
+.space-right2 { padding-right:20px; }
+.center { text-align:center; }
+.clearfix { display:block; }
+.clearfix:after {
+  content:'';
+  display:block;
+  height:0;
+  clear:both;
+  visibility:hidden;
+  }
+.fl { float: left; }
+@media only screen and (max-width:640px) {
+  .col3 { width:100%; max-width:100%; }
+  .hide-mobile { display:none!important; }
+}
+
+.quiet {
+  color: #7f7f7f;
+  color: rgba(0,0,0,0.5);
+}
+.quiet a { opacity: 0.7; }
+
+.fraction {
+  font-family: Consolas, 'Liberation Mono', Menlo, Courier, monospace;
+  font-size: 10px;
+  color: #555;
+  background: #E8E8E8;
+  padding: 4px 5px;
+  border-radius: 3px;
+  vertical-align: middle;
+}
+
+div.path a:link, div.path a:visited { color: #333; }
+table.coverage {
+  border-collapse: collapse;
+  margin: 10px 0 0 0;
+  padding: 0;
+}
+
+table.coverage td {
+  margin: 0;
+  padding: 0;
+  vertical-align: top;
+}
+table.coverage td.line-count {
+    text-align: right;
+    padding: 0 5px 0 20px;
+}
+table.coverage td.line-coverage {
+    text-align: right;
+    padding-right: 10px;
+    min-width:20px;
+}
+
+table.coverage td span.cline-any {
+    display: inline-block;
+    padding: 0 5px;
+    width: 100%;
+}
+.missing-if-branch {
+    display: inline-block;
+    margin-right: 5px;
+    border-radius: 3px;
+    position: relative;
+    padding: 0 4px;
+    background: #333;
+    color: yellow;
+}
+
+.skip-if-branch {
+    display: none;
+    margin-right: 10px;
+    position: relative;
+    padding: 0 4px;
+    background: #ccc;
+    color: white;
+}
+.missing-if-branch .typ, .skip-if-branch .typ {
+    color: inherit !important;
+}
+.coverage-summary {
+  border-collapse: collapse;
+  width: 100%;
+}
+.coverage-summary tr { border-bottom: 1px solid #bbb; }
+.keyline-all { border: 1px solid #ddd; }
+.coverage-summary td, .coverage-summary th { padding: 10px; }
+.coverage-summary tbody { border: 1px solid #bbb; }
+.coverage-summary td { border-right: 1px solid #bbb; }
+.coverage-summary td:last-child { border-right: none; }
+.coverage-summary th {
+  text-align: left;
+  font-weight: normal;
+  white-space: nowrap;
+}
+.coverage-summary th.file { border-right: none !important; }
+.coverage-summary th.pct { }
+.coverage-summary th.pic,
+.coverage-summary th.abs,
+.coverage-summary td.pct,
+.coverage-summary td.abs { text-align: right; }
+.coverage-summary td.file { white-space: nowrap;  }
+.coverage-summary td.pic { min-width: 120px !important;  }
+.coverage-summary tfoot td { }
+
+.coverage-summary .sorter {
+    height: 10px;
+    width: 7px;
+    display: inline-block;
+    margin-left: 0.5em;
+    background: url(sort-arrow-sprite.png) no-repeat scroll 0 0 transparent;
+}
+.coverage-summary .sorted .sorter {
+    background-position: 0 -20px;
+}
+.coverage-summary .sorted-desc .sorter {
+    background-position: 0 -10px;
+}
+.status-line {  height: 10px; }
+/* yellow */
+.cbranch-no { background: yellow !important; color: #111; }
+/* dark red */
+.red.solid, .status-line.low, .low .cover-fill { background:#C21F39 }
+.low .chart { border:1px solid #C21F39 }
+.highlighted,
+.highlighted .cstat-no, .highlighted .fstat-no, .highlighted .cbranch-no{
+  background: #C21F39 !important;
+}
+/* medium red */
+.cstat-no, .fstat-no, .cbranch-no, .cbranch-no { background:#F6C6CE }
+/* light red */
+.low, .cline-no { background:#FCE1E5 }
+/* light green */
+.high, .cline-yes { background:rgb(230,245,208) }
+/* medium green */
+.cstat-yes { background:rgb(161,215,106) }
+/* dark green */
+.status-line.high, .high .cover-fill { background:rgb(77,146,33) }
+.high .chart { border:1px solid rgb(77,146,33) }
+/* dark yellow (gold) */
+.status-line.medium, .medium .cover-fill { background: #f9cd0b; }
+.medium .chart { border:1px solid #f9cd0b; }
+/* light yellow */
+.medium { background: #fff4c2; }
+
+.cstat-skip { background: #ddd; color: #111; }
+.fstat-skip { background: #ddd; color: #111 !important; }
+.cbranch-skip { background: #ddd !important; color: #111; }
+
+span.cline-neutral { background: #eaeaea; }
+
+.coverage-summary td.empty {
+    opacity: .5;
+    padding-top: 4px;
+    padding-bottom: 4px;
+    line-height: 1;
+    color: #888;
+}
+
+.cover-fill, .cover-empty {
+  display:inline-block;
+  height: 12px;
+}
+.chart {
+  line-height: 0;
+}
+.cover-empty {
+    background: white;
+}
+.cover-full {
+    border-right: none !important;
+}
+pre.prettyprint {
+    border: none !important;
+    padding: 0 !important;
+    margin: 0 !important;
+}
+.com { color: #999 !important; }
+.ignore-none { color: #999; font-weight: normal; }
+
+.wrapper {
+  min-height: 100%;
+  height: auto !important;
+  height: 100%;
+  margin: 0 auto -48px;
+}
+.footer, .push {
+  height: 48px;
+}