lovdacn 0.0.2 → 0.1.1

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.
package/LICENSE CHANGED
@@ -1,21 +1,21 @@
1
- MIT License
2
-
3
- Copyright (c) 2024-present Entangle Labs
4
-
5
- Permission is hereby granted, free of charge, to any person obtaining a copy
6
- of this software and associated documentation files (the "Software"), to deal
7
- in the Software without restriction, including without limitation the rights
8
- to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
- copies of the Software, and to permit persons to whom the Software is
10
- furnished to do so, subject to the following conditions:
11
-
12
- The above copyright notice and this permission notice shall be included in all
13
- copies or substantial portions of the Software.
14
-
15
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
- FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
- AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
- LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
- OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
1
+ MIT License
2
+
3
+ Copyright (c) 2026 lovdaCN
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
21
  SOFTWARE.
package/README.md CHANGED
@@ -1,106 +1,72 @@
1
- # LavdaCN CLI
2
-
3
- A command-line toolkit to streamline the integration, setup, and maintenance of reusable React Native components in your projects.
4
-
5
- ## Features
6
-
7
- - **Add**: Quickly add reusable React Native components to your project, with style and path options.
8
- - **Doctor**: Diagnose your project for missing files, misconfigurations, and required dependencies. Optionally auto-install missing dependencies.
9
- - **Init**: Bootstrap a new React Native project pre-configured for lavdacn, or inspect/repair an existing setup.
10
-
11
- ## Getting Started
12
-
13
- ### Installation
14
-
15
- You can run the CLI directly with your favorite package manager:
16
-
17
- ```sh
18
- npx lavdacn@latest <command>
19
- pnpm dlx lavdacn@latest <command>
20
- yarn dlx lavdacn@latest <command>
21
- bunx --bun lavdacn@latest <command>
22
- ```
23
-
24
- Or use the shorthand `lvcn`:
25
-
26
- ```sh
27
- npx lvcn@latest <command>
28
- pnpm dlx lvcn@latest <command>
29
- yarn dlx lvcn@latest <command>
30
- bunx --bun lvcn@latest <command>
31
- ```
32
-
33
- ## Commands
34
-
35
- ---
36
-
37
- ### `lavdacn add [options] [components...]` / `lvcn add [options] [components...]`
38
-
39
- Add one or more React Native components to your project.
40
-
41
- | Argument | Description |
42
- | ---------- | ----------------------------------------------------------------------------- |
43
- | components | Name of component(s) to add. (e.g. `button`, `input`, `card`, `avatar`, etc.) |
44
-
45
- | Option | Description | Default |
46
- | ------------------- | ------------------------------------ | --------------- |
47
- | `-y, --yes` | Skip confirmation prompts. | false |
48
- | `-o, --overwrite` | Overwrite existing files. | false |
49
- | `-c, --cwd <cwd>` | The working directory. | . (current dir) |
50
- | `-a, --all` | Add all available components. | false |
51
- | `-p, --path <path>` | The path to add the component(s) to. | |
52
- | `--styling-library <styling-library>` | Override detected styling library (`nativewind` or `uniwind`). | auto-detect |
53
- | `-h, --help` | Display help for command. | |
54
-
55
- ---
56
-
57
- ### `lavdacn doctor [options]` / `lvcn doctor [options]`
58
-
59
- Check your project setup and diagnose issues.
60
-
61
- | Option | Description | Default |
62
- | ----------------- | ------------------------------------------------------ | --------------- |
63
- | `-y, --yes` | Skip confirmation prompts for installing dependencies. | false |
64
- | `-c, --cwd <cwd>` | The working directory. | . (current dir) |
65
- | `--summary` | Output a summary only. | false |
66
- | `-h, --help` | Display help for command. | |
67
-
68
- ---
69
-
70
- ### `lavdacn init [options]` / `lvcn init [options]`
71
-
72
- Initialize a new React Native project with lavdacn.
73
-
74
- | Option | Description | Default |
75
- | ----------------- | ------------------------- | --------------- |
76
- | `-c, --cwd <cwd>` | The working directory. | . (current dir) |
77
- | `-h, --help` | Display help for command. | |
78
-
79
- ---
80
-
81
- ## Development
82
-
83
- ### Scripts
84
-
85
- - `pnpm build` – Build the CLI for production.
86
- - `pnpm dev` – Run the CLI in development mode.
87
-
88
- > **Note:** If you are developing locally and want to use the `add` command in development mode, you must have the `apps/docs` app running. Start it from the root with:
89
- >
90
- > ```sh
91
- > pnpm dev:docs
92
- > ```
93
- >
94
- > This serves the component registry required for local development.
95
-
96
- ### Structure
97
-
98
- - `src/cli.ts` – Main CLI entrypoint and command definitions.
99
- - `src/bin.ts` – Node boot-strapper.
100
- - `src/services/commands/` – Command implementations (`add`, `doctor`, `init`).
101
- - `src/contexts/` – CLI option/context definitions.
102
- - `src/utils/` – Utility functions.
103
-
104
- ## Contributing
105
-
106
- See the [main repo README](../../README.md) for guidelines.
1
+ # lovdacn
2
+
3
+ > ⚠️ **Beta.** The CLI is under active development. APIs and components may change.
4
+
5
+ `lovdacn` is the CLI for **lovdaCN** — premium, responsive, customizable UI components for
6
+ **Expo & React Native**, built for Tailwind-based styling systems (**NativeWind** and **Uniwind**).
7
+
8
+ Inspired by `shadcn/ui`: components are copied into your codebase, so you own the code and can
9
+ customize everything.
10
+
11
+ ## Usage
12
+
13
+ You don't need to install anything — run it with your package manager's runner.
14
+
15
+ ### Initialize a project
16
+
17
+ Sets up configuration (`lvcn.json`), theme, and the required files.
18
+
19
+ ```sh
20
+ npx lovdacn@latest init
21
+ # pnpm
22
+ pnpm dlx lovdacn@latest init
23
+ # bun
24
+ bunx lovdacn@latest init
25
+ ```
26
+
27
+ During beta you can also pin the beta tag explicitly:
28
+
29
+ ```sh
30
+ npx lovdacn@beta init
31
+ ```
32
+
33
+ > `lvcn` is a shorthand alias for the same CLI, e.g. `npx lvcn@latest init`.
34
+
35
+ ### Add components
36
+
37
+ ```sh
38
+ # a single component
39
+ npx lovdacn@latest add button
40
+
41
+ # multiple components
42
+ npx lovdacn@latest add input select checkbox
43
+ ```
44
+
45
+ Running `add` with no arguments opens an interactive multi-select of all available components.
46
+
47
+ ## What it does
48
+
49
+ - **`init`** scaffolds/configures an Expo + NativeWind or Uniwind project (theme, `lvcn.json`,
50
+ metro/tailwind config, global CSS, portal host for overlays, etc.).
51
+ - **`add`** resolves a component and its dependencies from the registry, rewrites import
52
+ aliases to match your project, installs npm dependencies (via `expo install` for Expo
53
+ projects), and writes the files into your components directory.
54
+ - **`preset`** — manage theme/color presets.
55
+
56
+ ## Configuration
57
+
58
+ Components are resolved from the registry at `https://lovdacn.vercel.app/r`. You can point the CLI at a
59
+ different registry (a URL, or a local folder for development) with:
60
+
61
+ ```sh
62
+ LOVDA_REGISTRY_URL=https://your-registry/r npx lovdacn@latest add button
63
+ ```
64
+
65
+ ## Links
66
+
67
+ - Documentation: https://lovdacn.vercel.app
68
+ - Repository: https://github.com/lovdacn-ui/ui
69
+
70
+ ## License
71
+
72
+ MIT
@@ -0,0 +1 @@
1
+ #!/usr/bin/env node