src/__tests__/string.test.ts (1)

1-976: ⚠️ Potential issue

Run Prettier to fix code style issues.

The test pipeline indicates code style issues. Please run Prettier on the test file to ensure consistent formatting.

🧰 Tools

🪛 GitHub Actions: test

[warning] 1-1: Code style issues found. Forgot to run Prettier?

src/__tests__/string.test.ts (1)

942-976: Consider enhancing the MAC validation test suite.

While the test cases are comprehensive, consider these improvements:

1. Add case-insensitive validation tests
2. Add comments explaining the test cases
3. Include additional edge cases:
   • Mixed case (e.g., "00:1a:2B:3c:4D:5e")
   • Leading/trailing whitespace
   • Invalid separators (e.g., "00/1A/2B/3C/4D/5E")

Here's a suggested enhancement:

 test("MAC validation", () => {
   const mac = z.string().mac();
+  // Basic validation
   expect(mac.safeParse("00:1A:2B:3C:4D:5E").success).toBe(true);
   expect(() => mac.parse("00:1A-2B:3C:4D:5E")).toThrow();

+  // Test cases for valid MAC addresses
   const validMacs = [
+    // Standard uppercase format with colons
     "00:1A:2B:3C:4D:5E",
     "FF:FF:FF:FF:FF:FF",
+    // Standard uppercase format with hyphens
     "01-23-45-67-89-AB",
+    // Mixed case format
+    "00:1a:2B:3c:4D:5e",
+    // Lowercase format
     "0a:1b:2c:3d:4e:5f",
+    // With whitespace (if supported)
+    " 00:1A:2B:3C:4D:5E ",
     // ... rest of the valid cases
   ];

+  // Test cases for invalid MAC addresses
   const invalidMacs = [
+    // Mixed separators
     "00:1A-2B:3C-4D:5E",
+    // No separators
     "001A2B3C4D5E",
+    // Too short
     "00:1A:2B:3C:4D",
+    // Too long
     "00:1A:2B:3C:4D:5E:FF",
+    // Invalid characters
     "00:1A:2B:3C:4D:GZ",
+    // Invalid separators
+    "00/1A/2B/3C/4D/5E",
     // ... rest of the invalid cases
   ];

   const macSchema = z.string().mac();
   expect(validMacs.every((mac) => macSchema.safeParse(mac).success)).toBe(true);
   expect(invalidMacs.every((mac) => macSchema.safeParse(mac).success)).toBe(false);
 });

src/types.ts (2)

699-702: Improve MAC address regex readability and case-insensitivity.

The MAC address regex pattern could be improved in the following ways:

1. Add comments to explain the components
2. Add case-insensitive flag
3. Fix typo in comment ("seperators" → "separators")

Apply this diff to improve the regex pattern:

-// no support for mac without seperators
-// enforces all seperators should be either ':' or '-'
-const macRegex=/^([0-9A-Fa-f]{2}(:)){5}[0-9A-Fa-f]{2}$|^([0-9A-Fa-f]{2}(-)){5}[0-9A-Fa-f]{2}$/;
+// No support for MAC addresses without separators
+// Enforces all separators must be either ':' or '-'
+const macRegex = /^([0-9A-Fa-f]{2}(:)){5}[0-9A-Fa-f]{2}$|^([0-9A-Fa-f]{2}(-)){5}[0-9A-Fa-f]{2}$/i;
+// Explanation:
+// ^                     Start of string
+// [0-9A-Fa-f]{2}       Two hex digits
+// (:)                   Colon separator (captured)
+// {5}                   Repeat 5 times
+// [0-9A-Fa-f]{2}       Final two hex digits
+// $                     End of string
+// |                     OR
+// Same pattern but with hyphen separators

---

779-785: Simplify the MAC address validation function.

The validation function can be simplified by directly returning the test result.

Apply this diff to simplify the function:

-function isValidMac(mac:string) {
-  if (macRegex.test(mac)){
-    return true;
-  }
-
-  return false;
-}
+function isValidMac(mac: string): boolean {
+  return macRegex.test(mac);
+}

README.md (2)

813-813: MAC Address Validation Example Added
The example z.string().mac(); // Validate 48-bit MAC clearly illustrates the basic usage of the new MAC address validation method. Consider adding a brief note mentioning that the validator supports both colon-separated and dash-separated formats and that it applies case-insensitive matching to accommodate lower- and uppercase letters.

---

977-988: Detailed MAC Addresses Section
The new "MAC addresses" section provides clear examples of how to validate standard 48-bit MAC addresses. The examples include:

• Valid cases with both colon ("00:1A:2B:3C:4D:5E") and dash ("98-76-54-32-10-FF") separations.
• Invalid cases, including the case with an extra segment ("00:1A:2B:3C:4D:5E:FF") and a mixed separator format ("00:1A:2B-3C:4D:5E").

For improved clarity, consider including a comment (or a link to the implementation) explaining the underlying regex—for example, highlighting that the regex is designed to be case-insensitive and only allows one consistent separator throughout the string. Also, ensure that the heading starts at the beginning of the line as required by markdown lint rules.

🧰 Tools

🪛 markdownlint-cli2 (0.17.2)

977-977: Headings must start at the beginning of the line
null

(MD023, heading-start-left)

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

README.md (1)

1002-1002: Markdown Heading Alignment

The heading “### MAC addresses” on line 1002 appears to have leading whitespace. Please remove any extra spaces so that the heading starts at the beginning of the line in order to comply with markdownlint MD023.

🧰 Tools

🪛 markdownlint-cli2 (0.17.2)

1002-1002: Headings must start at the beginning of the line
null

(MD023, heading-start-left)

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro