next-configure 0.1.3 → 0.1.5
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/README.md +43 -29
- package/package.json +10 -2
package/README.md
CHANGED
|
@@ -1,51 +1,65 @@
|
|
|
1
1
|
# next-configure
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Minimal CLI tool to configure Next.js projects quickly and cleanly.
|
|
4
4
|
|
|
5
5
|
## Install
|
|
6
6
|
|
|
7
|
-
Use directly with `npx`:
|
|
8
|
-
|
|
9
7
|
```bash
|
|
10
8
|
npx next-configure
|
|
11
9
|
```
|
|
12
10
|
|
|
13
|
-
|
|
11
|
+
Run from your Next.js App Router project root.
|
|
14
12
|
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
13
|
+
## Features
|
|
14
|
+
|
|
15
|
+
- Detects Next.js App Router project automatically
|
|
16
|
+
- Optional shadcn/ui installation
|
|
17
|
+
- Creates standard folders: `components`, `hooks`, `utils`
|
|
18
|
+
- Detects `src` directory and places folders accordingly
|
|
19
|
+
- Generates Tailwind v4 theme from primary and secondary colors
|
|
20
|
+
- Automatically creates light and dark color variants
|
|
21
|
+
- Overwrites `globals.css` with complete theme system
|
|
18
22
|
|
|
19
|
-
|
|
23
|
+
## CLI Demo
|
|
20
24
|
|
|
21
25
|
```bash
|
|
22
|
-
npx next-configure
|
|
26
|
+
$ npx next-configure
|
|
27
|
+
|
|
28
|
+
✔ Detected Next.js project
|
|
29
|
+
? Do you want to install shadcn/ui? › yes
|
|
30
|
+
✔ Installing shadcn/ui
|
|
31
|
+
|
|
32
|
+
? Do you want to generate standard development folders? › yes
|
|
33
|
+
✔ Created components
|
|
34
|
+
✔ Created hooks
|
|
35
|
+
✔ Created utils
|
|
36
|
+
|
|
37
|
+
? Do you want to set color theme? › yes
|
|
38
|
+
? Enter primary color (hex without #) › 2563eb
|
|
39
|
+
? Enter secondary color (hex without #) › f97316
|
|
40
|
+
|
|
41
|
+
✔ globals.css overwritten successfully
|
|
42
|
+
✔ Setup complete
|
|
23
43
|
```
|
|
24
44
|
|
|
25
|
-
## What
|
|
45
|
+
## What It Generates
|
|
26
46
|
|
|
27
|
-
|
|
28
|
-
- Detects `src/` and creates `components`, `hooks`, `utils` in `src/` or project root.
|
|
29
|
-
- Optionally runs `shadcn init` and installs the `button` component.
|
|
30
|
-
- Locates `src/app/globals.css` or `app/globals.css` and overwrites it with:
|
|
31
|
-
- Tailwind v4 imports (`@import "tailwindcss";`, `@import "tw-animate-css";`)
|
|
32
|
-
- `@theme inline` mapping Tailwind tokens to CSS variables
|
|
33
|
-
- `:root` variables for primary/secondary (with auto light/dark variants) and core UI colors
|
|
34
|
-
- A minimal `@layer base` for body and border styles
|
|
47
|
+
Creates folders: `components`, `hooks`, `utils` (inside `src/` if it exists, otherwise at root).
|
|
35
48
|
|
|
36
|
-
|
|
49
|
+
Generates theme in `globals.css` with Tailwind v4 imports, CSS variables for primary and secondary colors, light and dark variants, and utility classes like `bg-primary`, `text-primary`, `bg-secondary`, `text-secondary`.
|
|
37
50
|
|
|
38
|
-
|
|
51
|
+
## Requirements
|
|
39
52
|
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
53
|
+
- Node.js 18+
|
|
54
|
+
- Next.js 13+ with App Router
|
|
55
|
+
- `globals.css` in `app/` or `src/app/`
|
|
56
|
+
|
|
57
|
+
## Contributing
|
|
58
|
+
|
|
59
|
+
Contributions welcome. For major changes, open an issue first.
|
|
43
60
|
|
|
44
|
-
|
|
61
|
+
Source code: https://github.com/bilal-dev02/next-configure
|
|
45
62
|
|
|
46
|
-
|
|
47
|
-
2. Whether to create `components`, `hooks`, `utils` folders.
|
|
48
|
-
3. Whether to set a color theme.
|
|
49
|
-
- If yes, enter primary and secondary hex colors (without `#`).
|
|
63
|
+
## License
|
|
50
64
|
|
|
51
|
-
|
|
65
|
+
MIT
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "next-configure",
|
|
3
|
-
"version": "0.1.
|
|
4
|
-
"description": "Zero-config CLI to
|
|
3
|
+
"version": "0.1.5",
|
|
4
|
+
"description": "Zero-config CLI to wire up Tailwind v4 + shadcn/ui and structure in a Next.js App Router project.",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"type": "module",
|
|
7
7
|
"bin": {
|
|
@@ -39,6 +39,14 @@
|
|
|
39
39
|
"theme",
|
|
40
40
|
"design system"
|
|
41
41
|
],
|
|
42
|
+
"repository": {
|
|
43
|
+
"type": "git",
|
|
44
|
+
"url": "https://github.com/bilal-dev02/next-configure.git"
|
|
45
|
+
},
|
|
46
|
+
"homepage": "https://github.com/bilal-dev02/next-configure",
|
|
47
|
+
"bugs": {
|
|
48
|
+
"url": "https://github.com/bilal-dev02/next-configure/issues"
|
|
49
|
+
},
|
|
42
50
|
"files": [
|
|
43
51
|
"dist",
|
|
44
52
|
"README.md"
|