@razorwind/shadcn 0.0.90 → 0.0.91

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 +16 -9
  2. package/package.json +4 -4
package/README.md CHANGED
@@ -53,6 +53,14 @@
53
53
 
54
54
  **Razorwind - Shadcn** is a package that can create Shadcn UI registry files from design tokens/components or read a Shadcn UI registry file and return the design tokens/components.
55
55
 
56
+ ## Quick Features
57
+
58
+ - Generate a Shadcn UI `registry.json` from tokens and components.
59
+ - Read tokens back from registry files with the extract plugin.
60
+ - Set registry `name` and `homepage` fields.
61
+ - Change the output file with `configFile` (default `"registry.json"`).
62
+ - Get wiring steps from the generated `INSTALL.md`.
63
+
56
64
  ## Installing
57
65
 
58
66
  Using [pnpm](http://pnpm.io):
@@ -83,22 +91,21 @@ yarn add -D @razorwind/shadcn
83
91
 
84
92
  ```ts
85
93
  import { defineConfig } from "@razorwind/core";
86
- import shadcn from "@razorwind/shadcn";
94
+ import shadcn from "@razorwind/shadcn/generate";
87
95
 
88
96
  export default defineConfig({
89
- plugins: [shadcn]
97
+ plugins: [shadcn({ name: "acme", homepage: "https://acme.com" })]
90
98
  });
91
99
  ```
92
100
 
93
101
  ### Options
94
102
 
95
- | Option | Default | Description |
96
- | ------------- | --------------------------- | -------------------------------------------------------- |
97
- | `outputPath` | `"DESIGN.md"` | Output file path (relative to the execution cwd) |
98
- | `name` | `"Razorwind Design System"` | Design system name written to the YAML front matter |
99
- | `description` | — | Short description written to the YAML front matter |
100
- | `version` | `"alpha"` | DESIGN.md spec version written to the YAML front matter |
101
- | `overview` | Generated summary | Prose for the `## Overview` section |
103
+ | Option | Default | Description |
104
+ | -------------- | ----------------- | -------------------------------------------------------- |
105
+ | `configFile` | `"registry.json"` | Output path for the generated `registry.json` file |
106
+ | `name` | — | Registry `name` field written into `registry.json` |
107
+ | `homepage` | — | Registry `homepage` field written into `registry.json` |
108
+ | `installGuide` | Generated steps | Override body for the generated `INSTALL.md` |
102
109
 
103
110
  ## Development
104
111
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@razorwind/shadcn",
3
- "version": "0.0.90",
3
+ "version": "0.0.91",
4
4
  "type": "module",
5
5
  "description": "Razorwind Shadcn plugin that can create Shadcn UI registry files from design tokens/components or read a Shadcn UI registry file and return the design tokens/components.",
6
6
  "repository": {
@@ -80,7 +80,7 @@
80
80
  "dependencies": {
81
81
  "@power-plant/core": "^0.0.94",
82
82
  "@power-plant/dtcg-schema": "^0.0.1",
83
- "@razorwind/core": "^0.0.94",
83
+ "@razorwind/core": "^0.0.95",
84
84
  "@stryke/fs": "^0.33.118",
85
85
  "@stryke/path": "^0.29.43",
86
86
  "@stryke/types": "^0.12.44",
@@ -90,7 +90,7 @@
90
90
  "shadcn": "^4.21.4",
91
91
  "tsconfig-paths": "^4.2.0",
92
92
  "yaml": "^2.9.1",
93
- "zod": "^4.6.5"
93
+ "zod": "^4.6.7"
94
94
  },
95
95
  "devDependencies": {
96
96
  "@powerlines/plugin-tsdown": "^0.1.615",
@@ -98,5 +98,5 @@
98
98
  "typescript": "^6.0.3"
99
99
  },
100
100
  "publishConfig": { "access": "public" },
101
- "gitHead": "6267c5244ff3006f9be7d61078352dc47e614da9"
101
+ "gitHead": "e3238339533d365e75dca30f9e3ec129bd565f2f"
102
102
  }