vite-shadcn-ui-cli 1.0.0 → 1.0.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.
Files changed (2) hide show
  1. package/README.md +24 -43
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -1,52 +1,33 @@
1
- # React + TypeScript + Vite
1
+ # vite-shadcn-ui-cli
2
2
 
3
- This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
3
+ A CLI tool to bootstrap Vite projects with ShadCN UI components.
4
4
 
5
- Currently, two official plugins are available:
5
+ ## Installation
6
6
 
7
- - [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md) uses [Babel](https://babeljs.io/) for Fast Refresh
8
- - [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh
7
+ You can install the CLI globally using npm:
9
8
 
10
- ## Expanding the ESLint configuration
11
-
12
- If you are developing a production application, we recommend updating the configuration to enable type aware lint rules:
9
+ ```sh
10
+ npm install -g vite-shadcn-ui-cli
11
+ vite-shadcn-ui my-project
12
+ ```
13
13
 
14
- - Configure the top-level `parserOptions` property like this:
14
+ ## Example:
15
15
 
16
- ```js
17
- export default tseslint.config({
18
- languageOptions: {
19
- // other options...
20
- parserOptions: {
21
- project: ['./tsconfig.node.json', './tsconfig.app.json'],
22
- tsconfigRootDir: import.meta.dirname,
23
- },
24
- },
25
- })
16
+ ```sh
17
+ vite-shadcn-ui my-app
18
+ cd my-app
19
+ npm run dev
26
20
  ```
27
21
 
28
- - Replace `tseslint.configs.recommended` to `tseslint.configs.recommendedTypeChecked` or `tseslint.configs.strictTypeChecked`
29
- - Optionally add `...tseslint.configs.stylisticTypeChecked`
30
- - Install [eslint-plugin-react](https://github.com/jsx-eslint/eslint-plugin-react) and update the config:
31
-
32
- ```js
33
- // eslint.config.js
34
- import react from 'eslint-plugin-react'
35
-
36
- export default tseslint.config({
37
- // Set the react version
38
- settings: { react: { version: '18.3' } },
39
- plugins: {
40
- // Add the react plugin
41
- react,
42
- },
43
- rules: {
44
- // other rules...
45
- // Enable its recommended rules
46
- ...react.configs.recommended.rules,
47
- ...react.configs['jsx-runtime'].rules,
48
- },
49
- })
50
- ```
22
+ This will create a new Vite project with ShadCN UI components installed.
23
+
24
+ # Features
25
+
26
+ - Vite
27
+ - ShadCN UI
28
+ - TypeScript
29
+ - Tailwind CSS
30
+
31
+ # License
51
32
 
52
- - V0 [url](https://v0.dev/chat)
33
+ MIT © KYRIE668
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "vite-shadcn-ui-cli",
3
- "version": "1.0.0",
3
+ "version": "1.0.1",
4
4
  "description": "A CLI tool to bootstrap Vite projects with shadcn UI components",
5
5
  "type": "module",
6
6
  "main": "index.js",