@sfirew/minecraft-motd-parser 1.1.4 → 1.1.5

package/eslint.config.mjs

@@ -0,0 +1,82 @@
+import js from "@eslint/js";
+import globals from "globals";
+import tseslint from "typescript-eslint";
+
+export default [
+  // Ignore patterns
+  {
+    ignores: ["dist/**", "node_modules/**", "*.min.js", "build/**"],
+  },
+  
+  // Base JavaScript configuration
+  {
+    files: ["**/*.{js,mjs,cjs}"],
+    ...js.configs.recommended,
+    languageOptions: {
+      ecmaVersion: "latest",
+      sourceType: "module",
+      globals: {
+        ...globals.browser,
+        ...globals.node,
+        ...globals.es2021,
+      },
+    },
+  },
+  
+  // TypeScript configuration - use the recommended config directly
+  ...tseslint.configs.recommended.map(config => ({
+    ...config,
+    files: ["**/*.{ts,mts,cts}"],
+    languageOptions: {
+      ...config.languageOptions,
+      ecmaVersion: "latest",
+      sourceType: "module",
+      globals: {
+        ...globals.browser,
+        ...globals.node,
+        ...globals.es2021,
+      },
+    },
+  })),
+  
+  // Custom rules and relaxed settings
+  {
+    files: ["**/*.{js,mjs,cjs,ts,mts,cts}"],
+    rules: {
+      quotes: [
+        "error",
+        "double",
+        { avoidEscape: true },
+      ],
+      // Relax some strict rules for better development experience
+      "no-useless-escape": "warn",
+      
+      // Keep these as errors for important issues
+      "no-redeclare": "error",
+      "no-undef": "error",
+      "no-constant-binary-expression": "error",
+      
+    },
+  },
+  
+  // TypeScript specific rules
+  {
+    files: ["**/*.{ts,mts,cts}"],
+    rules: {
+      "@typescript-eslint/no-explicit-any": "warn", // Change to warning instead of error
+      "@typescript-eslint/no-unused-vars": "warn",
+      "@typescript-eslint/no-require-imports": "warn",
+    },
+  },
+  
+  // Test files - even more relaxed rules
+  {
+    files: ["test/**/*.{ts,js}", "**/*.test.{ts,js}", "**/*.spec.{ts,js}"],
+    rules: {
+      "@typescript-eslint/no-explicit-any": "off",
+      "@typescript-eslint/no-unused-vars": "off",
+      "@typescript-eslint/no-require-imports": "off",
+      "no-useless-escape": "off",
+    },
+  },
+];

package/jest.config.ts

@@ -0,0 +1,32 @@
+/** @type {import('ts-jest').JestConfigWithTsJest} */
+export default {
+  preset: "ts-jest",
+  testEnvironment: "node",
+  collectCoverage: true,
+  collectCoverageFrom: [
+    "src/**/*.{ts,tsx}",
+    "!src/**/*.d.ts",
+    "!src/test.ts", // 排除自測試文件
+  ],
+  coverageDirectory: "coverage",
+  coverageReporters: [
+    "text",
+    "lcov",
+    "html",
+    "json-summary"
+  ],
+  coverageThreshold: {
+    global: {
+      branches: 80,
+      functions: 85,
+      lines: 85,
+      statements: 85
+    }
+  },
+  testMatch: [
+    "**/test/**/*.test.ts"
+  ],
+  // 效能測試配置
+  testTimeout: 30000, // 30 秒超時
+  maxWorkers: "50%", // 使用 50% 的 CPU 核心
+};

package/package.json

@@ -1,18 +1,23 @@
 {
   "name": "@sfirew/minecraft-motd-parser",
   "description": "Minecraft Server MOTD Parser, can convert to html, json, text.",
-  "version": "1.1.4",
+  "version": "1.1.5",
   "main": "dist/index.js",
   "module": "dist/index.mjs",
   "types": "types/index.d.ts",
   "license": "MIT",
   "scripts": {
     "test": "jest",
+    "test:coverage": "jest --coverage",
+    "test:watch": "jest --watch",
+    "test:performance": "jest --testNamePattern=\"Performance test|Stress test\"",
+    "test:security": "jest --testNamePattern=\"Security Tests\"",
+    "test:all": "jest --coverage --verbose",
     "test-self": "ts-node ./src/test.ts",
     "build": "yarn build:dist && yarn build:declarations",
     "build:dist": "tsup --format cjs,esm",
     "build:declarations": "tsc --emitDeclarationOnly --declaration --outDir types",
-    "format": "prettier --write \"**/*.+(ts)\""
+    "lint": "eslint \"**/*.ts\""
   },
   "tsup": {
     "entry": [
@@ -24,17 +29,19 @@
     "minify": true
   },
   "devDependencies": {
+    "@eslint/js": "^9.28.0",
     "@jest/globals": "^29.7.0",
-    "@types/node": "^20.14.10",
-    "@typescript-eslint/eslint-plugin": "^5.41.0",
-    "@typescript-eslint/parser": "^5.41.0",
-    "eslint": "^8.26.0",
+    "@types/node": "^20.17.57",
+    "@typescript-eslint/eslint-plugin": "^5.62.0",
+    "@typescript-eslint/parser": "^5.62.0",
+    "eslint": "^8.57.1",
+    "globals": "^16.2.0",
     "jest": "^29.7.0",
-    "prettier": "^2.7.1",
-    "ts-jest": "^29.2.2",
+    "ts-jest": "^29.3.4",
     "ts-node": "^10.9.2",
-    "tsup": "^8.4.0",
-    "typescript": "^5.5.3"
+    "tsup": "^8.5.0",
+    "typescript": "^5.8.3",
+    "typescript-eslint": "^8.33.0"
   },
   "repository": "https://github.com/SnowFireWolf/minecraft-motd-parser.git",
   "author": "SnowFireWolf",

package/types/index.d.ts

@@ -1,6 +1,6 @@
 import { htmlStringFormatting, cleanCodes, cleanHtmlTags } from "./utils";
 import { JSONToHTML, JSONToCleanedText, textToHTML, textToJSON, JSONRender, autoToHTML, autoCleanToText } from "./parser";
-export * from './utils';
+export * from "./utils";
 export * from "./parser";
 declare const motdParser: {
     textToHTML: typeof textToHTML;

package/types/utils.d.ts

@@ -1,24 +1,31 @@
 import { motdJsonType } from "./types";
-export declare function isMotdJSONType(object: object): object is motdJsonType;
 /**
- *
- * replace all html tags to &...
+ * Base color code regex
+ */
+export declare const baseColorCodeRegex: RegExp;
+export declare function isMotdJSONType(object: unknown): object is motdJsonType;
+/**
+ * Replace all HTML special characters with HTML entities
+ * Prevents HTML injection by safely encoding special characters
  */
 export declare function htmlStringFormatting(text: string): string;
 /**
- * clean html tags
+ * Clean HTML tags safely
+ *
+ * Safely removes HTML tags and prevents HTML injection vulnerabilities.
  *
- * @param text
- * example: `<span>hello world</span>`
+ * @param text - Input text that may contain HTML tags
+ * @example `<span>hello world</span>` → `hello world`
  *
- * result: `hello world`
+ * @returns Clean text without HTML tags
  */
 export declare function cleanHtmlTags(text: string): string;
 /**
- * clean motd codes
+ * Clean MOTD color codes
  *
- * Clean all codes from motd source string.
+ * Clean all formatting codes from MOTD source string.
  *
- * @param {string} text - motd string include tag § will remove
+ * @param {string} text - MOTD string with § formatting codes to be removed
+ * @returns {string} Text without MOTD formatting codes
  */
 export declare function cleanCodes(text: string): string;

package/.eslintrc.ts

@@ -1,23 +0,0 @@
-module.exports = {
-    "env": {
-        "browser": true,
-        "es2021": true,
-        "node": true
-    },
-    "extends": [
-        "eslint:recommended",
-        "plugin:@typescript-eslint/recommended"
-    ],
-    "overrides": [
-    ],
-    "parser": "@typescript-eslint/parser",
-    "parserOptions": {
-        "ecmaVersion": "latest",
-        "sourceType": "module"
-    },
-    "plugins": [
-        "@typescript-eslint"
-    ],
-    "rules": {
-    }
-}

package/jest.config.js

@@ -1,5 +0,0 @@
-/** @type {import('ts-jest').JestConfigWithTsJest} */
-module.exports = {
-  preset: 'ts-jest',
-  testEnvironment: 'node',
-};