lumen-lib 0.0.0-stage → 1.0.0

package/README.md

@@ -1,3 +1,24 @@
-# Temporary Holding Version
+# lumen-lib
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Tiny utility helpers for modern web apps.
+
+## Install
+
+```sh
+npm install lumen-lib
+```
+
+## Usage
+
+```js
+import { cn } from "lumen-lib";
+
+cn("btn", isActive && "btn--active", className);
+// => "btn btn--active my-class"
+```
+
+`cn` joins class names and drops falsy values, so conditional classes stay readable without a ternary soup.
+
+## License
+
+MIT

package/index.cjs

@@ -0,0 +1,13 @@
+"use strict";
+
+/**
+ * Join class names, ignoring falsy values.
+ *
+ * @param {...(string | false | null | undefined)} classes
+ * @returns {string}
+ */
+function cn(...classes) {
+  return classes.filter(Boolean).join(" ");
+}
+
+module.exports = { cn };

package/index.d.ts

@@ -0,0 +1,3 @@
+export declare function cn(
+  ...classes: Array<string | false | null | undefined>
+): string;

package/index.js

@@ -0,0 +1,9 @@
+/**
+ * Join class names, ignoring falsy values.
+ *
+ * @param {...(string | false | null | undefined)} classes
+ * @returns {string}
+ */
+export function cn(...classes) {
+  return classes.filter(Boolean).join(" ");
+}

package/package.json

@@ -1,6 +1,40 @@
 {
   "name": "lumen-lib",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "1.0.0",
+  "description": "Tiny utility helpers for modern web apps.",
+  "main": "index.js",
+  "module": "index.js",
+  "types": "index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./index.d.ts",
+      "import": "./index.js",
+      "require": "./index.cjs"
+    }
+  },
+  "files": [
+    "index.js",
+    "index.cjs",
+    "index.d.ts"
+  ],
+  "keywords": [
+    "utility",
+    "classname",
+    "cn",
+    "helpers"
+  ],
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/lumen-lib/lumen-lib.git"
+  },
+  "homepage": "https://github.com/lumen-lib/lumen-lib#readme",
+  "bugs": {
+    "type": "email",
+    "email": "hi@lumen-lib.dev"
+  },
+  "engines": {
+    "node": ">=14"
+  },
+  "sideEffects": false
+}