@contractspec/lib.ui-kit-core 3.7.6 → 3.7.9

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +46 -20
  2. package/package.json +6 -6
package/README.md CHANGED
@@ -1,33 +1,59 @@
1
1
  # @contractspec/lib.ui-kit-core
2
2
 
3
- Website: https://contractspec.io/
3
+ Website: https://contractspec.io
4
4
 
5
5
  **Core UI primitives and utilities.**
6
6
 
7
- Provides the foundational `cn()` utility for merging Tailwind CSS classes, built on `clsx` and `tailwind-merge`. Used as the base layer for all ContractSpec UI packages.
7
+ ## What It Provides
8
+
9
+ - **Layer**: lib.
10
+ - **Consumers**: ui-kit, ui-kit-web, ui-link.
11
+ - Related ContractSpec packages include `@contractspec/tool.bun`, `@contractspec/tool.typescript`.
12
+ - Related ContractSpec packages include `@contractspec/tool.bun`, `@contractspec/tool.typescript`.
8
13
 
9
14
  ## Installation
10
15
 
11
- ```bash
12
- bun add @contractspec/lib.ui-kit-core
13
- ```
16
+ `npm install @contractspec/lib.ui-kit-core`
14
17
 
15
- ## Exports
18
+ or
16
19
 
17
- - `.` -- Re-exports `./utils`
18
- - `./utils` -- `cn()` class merging utility
20
+ `bun add @contractspec/lib.ui-kit-core`
19
21
 
20
22
  ## Usage
21
23
 
22
- ```tsx
23
- import { cn } from "@contractspec/lib.ui-kit-core/utils";
24
-
25
- function Button({ className, ...props }: React.ButtonHTMLAttributes<HTMLButtonElement>) {
26
- return (
27
- <button
28
- className={cn("rounded-md bg-blue-600 px-4 py-2 text-white", className)}
29
- {...props}
30
- />
31
- );
32
- }
33
- ```
24
+ Import the root entrypoint from `@contractspec/lib.ui-kit-core`, or choose a documented subpath when you only need one part of the package surface.
25
+
26
+ ## Architecture
27
+
28
+ - `src/index.ts` is the root public barrel and package entrypoint.
29
+ - `src/utils.ts` is part of the package's public or composition surface.
30
+
31
+ ## Public Entry Points
32
+
33
+ - Export `.` resolves through `./src/index.ts`.
34
+ - Export `./utils` resolves through `./src/utils.ts`.
35
+
36
+ ## Local Commands
37
+
38
+ - `bun run dev` — contractspec-bun-build dev
39
+ - `bun run build` — bun run prebuild && bun run build:bundle && bun run build:types
40
+ - `bun run lint` — bun run lint:fix
41
+ - `bun run lint:check` — biome check .
42
+ - `bun run lint:fix` — biome check --write --unsafe --only=nursery/useSortedClasses . && biome check --write .
43
+ - `bun run typecheck` — tsc --noEmit
44
+ - `bun run publish:pkg` — bun publish --tolerate-republish --ignore-scripts --verbose
45
+ - `bun run publish:pkg:canary` — bun publish:pkg --tag canary
46
+ - `bun run clean` — rm -rf dist
47
+ - `bun run build:bundle` — contractspec-bun-build transpile
48
+ - `bun run build:types` — contractspec-bun-build types
49
+ - `bun run prebuild` — contractspec-bun-build prebuild
50
+
51
+ ## Recent Updates
52
+
53
+ - Replace eslint+prettier by biomejs to optimize speed.
54
+
55
+ ## Notes
56
+
57
+ - `cn()` utility is used by every UI package — changes here affect all UI components.
58
+ - This is a foundational package — keep it minimal and zero-surprise.
59
+ - Test thoroughly before changing any export signature.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@contractspec/lib.ui-kit-core",
3
- "version": "3.7.6",
3
+ "version": "3.7.9",
4
4
  "description": "Core UI primitives and utilities",
5
5
  "keywords": [
6
6
  "contractspec",
@@ -22,8 +22,8 @@
22
22
  "dev": "contractspec-bun-build dev",
23
23
  "clean": "rm -rf dist",
24
24
  "lint": "bun run lint:fix",
25
- "lint:fix": "eslint src --fix",
26
- "lint:check": "eslint src",
25
+ "lint:fix": "biome check --write --unsafe --only=nursery/useSortedClasses . && biome check --write .",
26
+ "lint:check": "biome check .",
27
27
  "prebuild": "contractspec-bun-build prebuild",
28
28
  "typecheck": "tsc --noEmit"
29
29
  },
@@ -33,13 +33,13 @@
33
33
  "react": "19.2.0",
34
34
  "react-dom": "19.2.0",
35
35
  "tailwind-merge": "^3.5.0",
36
- "tailwindcss": "4.2.1",
36
+ "tailwindcss": "4.2.2",
37
37
  "tailwindcss-animate": "^1.0.7"
38
38
  },
39
39
  "devDependencies": {
40
- "@contractspec/tool.typescript": "3.7.6",
40
+ "@contractspec/tool.typescript": "3.7.9",
41
41
  "typescript": "^5.9.3",
42
- "@contractspec/tool.bun": "3.7.6"
42
+ "@contractspec/tool.bun": "3.7.9"
43
43
  },
44
44
  "exports": {
45
45
  ".": {