@lightsound/cn 0.1.0 → 1.1.0

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2024 lightsound
+Copyright (c) 2025 lightsound
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -19,4 +19,3 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.
-

package/README.md

@@ -3,27 +3,42 @@
 A tiny, **blazing fast** utility for constructing `className` strings conditionally.
 
 [![npm version](https://img.shields.io/npm/v/@lightsound/cn.svg)](https://www.npmjs.com/package/@lightsound/cn)
-[![gzip size](https://img.shields.io/badge/gzip-139B-brightgreen.svg)](https://bundlephobia.com/package/@lightsound/cn)
+[![CI](https://github.com/lightsound/cn/actions/workflows/ci.yml/badge.svg)](https://github.com/lightsound/cn/actions/workflows/ci.yml)
+[![gzip size](https://img.shields.io/badge/gzip-130B-brightgreen.svg)](https://bundlephobia.com/package/@lightsound/cn)
 [![license](https://img.shields.io/npm/l/@lightsound/cn.svg)](./LICENSE)
 
 ## Features
 
-- **Blazing Fast**: Up to 48% faster than `clsx/lite`
-- **Tiny**: ~139B gzipped (smaller than clsx/lite!)
+- **Blazing Fast**: Up to 26% faster than `clsx/lite`
+- **Tiny**: ~130B gzipped (smaller than clsx/lite!)
 - **TypeScript**: Full type support out of the box
 - **Simple API**: Strings only - no objects, no arrays, maximum performance
 - **Zero Dependencies**: No external dependencies
 
+## Why @lightsound/cn?
+
+| Feature         | @lightsound/cn | clsx/lite | clsx  |
+| --------------- | -------------- | --------- | ----- |
+| Strings only    | ✅             | ✅        | ❌    |
+| Objects support | ❌             | ❌        | ✅    |
+| Arrays support  | ❌             | ❌        | ✅    |
+| Size (gzip)     | ~130B          | ~139B     | ~239B |
+| Performance     | ⚡⚡⚡         | ⚡⚡      | ⚡    |
+
+If you only use string-based class composition (the most common pattern with Tailwind CSS), `@lightsound/cn` provides the best performance.
+
 ## Benchmarks
 
-Benchmarked on Apple M2 with Bun 1.3.4:
+> Benchmarks are run on every CI build. See the [latest CI run](https://github.com/lightsound/cn/actions/workflows/ci.yml) for up-to-date results.
 
-| Test Case  | @lightsound/cn | clsx/lite | Improvement    |
-| ---------- | -------------- | --------- | -------------- |
-| 2 strings  | 21.17 ns       | 33.23 ns  | **36% faster** |
-| 3 strings  | 25.74 ns       | 46.05 ns  | **44% faster** |
-| 5 strings  | 37.84 ns       | 70.59 ns  | **46% faster** |
-| 10 strings | 63.60 ns       | 121.75 ns | **48% faster** |
+<!-- BENCHMARK_START -->
+| Test Case | @lightsound/cn | clsx/lite | Improvement |
+| --------- | -------------- | --------- | ----------- |
+| 2 strings | 52.31 ns | 67.05 ns | **22% faster** |
+| 3 strings | 52.07 ns | 70.71 ns | **26% faster** |
+| 5 strings | 68.33 ns | 87.32 ns | **22% faster** |
+| 10 strings | 104.29 ns | 139.06 ns | **25% faster** |
+<!-- BENCHMARK_END -->
 
 ## Installation
 
@@ -65,46 +80,6 @@ cn("foo", false, null, undefined, 0, "", "bar");
 // => 'foo bar'
 ```
 
-## Real-world Example (Tailwind CSS)
-
-```typescript
-import { cn } from "@lightsound/cn";
-
-interface ButtonProps {
-  variant?: "primary" | "secondary";
-  size?: "sm" | "md" | "lg";
-  disabled?: boolean;
-  className?: string;
-}
-
-function Button({
-  variant = "primary",
-  size = "md",
-  disabled,
-  className,
-}: ButtonProps) {
-  return (
-    <button
-      className={cn(
-        "inline-flex items-center justify-center rounded-md font-medium",
-        "transition-colors focus-visible:outline-none focus-visible:ring-2",
-        variant === "primary" && "bg-blue-500 text-white hover:bg-blue-600",
-        variant === "secondary" &&
-          "bg-gray-200 text-gray-900 hover:bg-gray-300",
-        size === "sm" && "h-8 px-3 text-sm",
-        size === "md" && "h-10 px-4 text-base",
-        size === "lg" && "h-12 px-6 text-lg",
-        disabled && "pointer-events-none opacity-50",
-        className
-      )}
-      disabled={disabled}
-    >
-      Click me
-    </button>
-  );
-}
-```
-
 ## API
 
 ### `cn(...classes)`
@@ -119,21 +94,9 @@ Combines class names into a single string. Only accepts strings - non-string val
 
 - `string` - The combined class names separated by spaces
 
-## Why @lightsound/cn?
-
-| Feature         | @lightsound/cn | clsx  | clsx/lite |
-| --------------- | -------------- | ----- | --------- |
-| Strings only    | ✅             | ❌    | ✅        |
-| Objects support | ❌             | ✅    | ❌        |
-| Arrays support  | ❌             | ✅    | ❌        |
-| Size (gzip)     | ~139B          | ~239B | ~149B     |
-| Performance     | ⚡⚡⚡         | ⚡⚡  | ⚡⚡      |
-
-If you only use string-based class composition (the most common pattern with Tailwind CSS), `@lightsound/cn` provides the best performance.
-
 ## Compatibility with clsx/lite
 
-`@lightsound/cn` is designed as a faster, drop-in replacement for `clsx/lite` in typical usage:
+`@lightsound/cn` is designed as a faster, drop-in replacement for `clsx/lite`:
 
 ```typescript
 // Before

package/dist/index.js

@@ -1 +1 @@
-function e(){let s="",a,l=arguments.length;for(let n=0;n<l;n++)if(a=arguments[n])s=s?s+" "+a:a;return s}export{e as default,e as cn};
+function e(){var a=0,l=arguments.length,s="",n;for(;a<l;a++)if(n=arguments[a])s=s?s+" "+n:n;return s}export{e as default,e as cn};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lightsound/cn",
-  "version": "0.1.0",
+  "version": "1.1.0",
   "description": "A tiny, blazing fast utility for constructing className strings conditionally",
   "type": "module",
   "main": "./dist/index.js",
@@ -23,7 +23,11 @@
     "test": "bun test",
     "test:watch": "bun test --watch",
     "bench": "bun run bench/index.ts",
-    "prepublishOnly": "bun run build && bun run test"
+    "bench:ci": "bun run bench/ci.ts",
+    "check-size": "bun run scripts/check-size.ts",
+    "update-readme": "bun run scripts/update-readme.ts",
+    "prepublishOnly": "bun run build && bun run test",
+    "prepare": "husky"
   },
   "keywords": [
     "classnames",
@@ -46,9 +50,12 @@
   },
   "homepage": "https://github.com/lightsound/cn#readme",
   "devDependencies": {
+    "@commitlint/cli": "^20.2.0",
+    "@commitlint/config-conventional": "^20.2.0",
     "@types/bun": "^1.3.4",
     "@typescript/native-preview": "^7.0.0-dev.20251213.1",
-    "clsx": "^2.1.1",
+    "clsx": "*",
+    "husky": "^9.1.7",
     "mitata": "^1.0.34"
   }
 }