next-configure 0.1.4 → 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 +17 -91
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -4,33 +4,24 @@ Minimal CLI tool to configure Next.js projects quickly and cleanly.
|
|
|
4
4
|
|
|
5
5
|
## Install
|
|
6
6
|
|
|
7
|
-
Run directly with `npx` from your Next.js project root:
|
|
8
|
-
|
|
9
7
|
```bash
|
|
10
8
|
npx next-configure
|
|
11
9
|
```
|
|
12
10
|
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
---
|
|
16
|
-
|
|
17
|
-
## Overview
|
|
18
|
-
|
|
19
|
-
`next-configure` automates common setup tasks you usually repeat after running `create-next-app`:
|
|
11
|
+
Run from your Next.js App Router project root.
|
|
20
12
|
|
|
21
|
-
|
|
22
|
-
- Optionally installs and wires up `shadcn/ui`.
|
|
23
|
-
- Creates standard development folders.
|
|
24
|
-
- Generates a Tailwind v4–compatible theme in `globals.css` from your brand colors.
|
|
13
|
+
## Features
|
|
25
14
|
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
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
|
|
29
22
|
|
|
30
23
|
## CLI Demo
|
|
31
24
|
|
|
32
|
-
Example interaction:
|
|
33
|
-
|
|
34
25
|
```bash
|
|
35
26
|
$ npx next-configure
|
|
36
27
|
|
|
@@ -51,88 +42,23 @@ $ npx next-configure
|
|
|
51
42
|
✔ Setup complete
|
|
52
43
|
```
|
|
53
44
|
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
## What It Configures
|
|
57
|
-
|
|
58
|
-
### Folders
|
|
59
|
-
|
|
60
|
-
If you opt in:
|
|
61
|
-
|
|
62
|
-
- When `src/` exists:
|
|
63
|
-
- `src/components`
|
|
64
|
-
- `src/hooks`
|
|
65
|
-
- `src/utils`
|
|
66
|
-
- Otherwise:
|
|
67
|
-
- `components`
|
|
68
|
-
- `hooks`
|
|
69
|
-
- `utils`
|
|
70
|
-
|
|
71
|
-
Existing folders are left as-is; missing ones are created.
|
|
72
|
-
|
|
73
|
-
### Theme in `globals.css`
|
|
74
|
-
|
|
75
|
-
If you choose to set a color theme:
|
|
45
|
+
## What It Generates
|
|
76
46
|
|
|
77
|
-
|
|
78
|
-
- `src/app/globals.css`
|
|
79
|
-
- `app/globals.css`
|
|
80
|
-
- Overwrites it with:
|
|
81
|
-
- Tailwind v4–style imports:
|
|
82
|
-
- `@import "tailwindcss";`
|
|
83
|
-
- `@import "tw-animate-css";`
|
|
84
|
-
- A theme based on CSS variables:
|
|
85
|
-
- Primary and secondary colors (from your input).
|
|
86
|
-
- Automatically generated light and dark variants.
|
|
87
|
-
- Utility classes, for example:
|
|
88
|
-
- `bg-primary`, `bg-secondary`
|
|
89
|
-
- `text-primary`, `text-secondary`
|
|
47
|
+
Creates folders: `components`, `hooks`, `utils` (inside `src/` if it exists, otherwise at root).
|
|
90
48
|
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
---
|
|
94
|
-
|
|
95
|
-
## Design Principles
|
|
96
|
-
|
|
97
|
-
- Minimal surface area.
|
|
98
|
-
- No enforced application architecture.
|
|
99
|
-
- Does not touch layout or routing files.
|
|
100
|
-
- Uses a small, focused dependency set.
|
|
101
|
-
- All major actions are opt-in via prompts.
|
|
102
|
-
|
|
103
|
-
---
|
|
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`.
|
|
104
50
|
|
|
105
51
|
## Requirements
|
|
106
52
|
|
|
107
|
-
- Node.js
|
|
108
|
-
- Next.js
|
|
109
|
-
-
|
|
110
|
-
|
|
111
|
-
---
|
|
53
|
+
- Node.js 18+
|
|
54
|
+
- Next.js 13+ with App Router
|
|
55
|
+
- `globals.css` in `app/` or `src/app/`
|
|
112
56
|
|
|
113
57
|
## Contributing
|
|
114
58
|
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
- For substantial changes, please open an issue first to discuss the direction.
|
|
118
|
-
- For small fixes or improvements, submit a pull request with a clear description.
|
|
119
|
-
|
|
120
|
-
Please keep changes aligned with the goals of being minimal, predictable, and Next.js App Router–focused.
|
|
121
|
-
|
|
122
|
-
---
|
|
123
|
-
|
|
124
|
-
## Issues
|
|
125
|
-
|
|
126
|
-
If you run into a bug or want to request a feature:
|
|
127
|
-
|
|
128
|
-
- Open an issue on GitHub with:
|
|
129
|
-
- Steps to reproduce (if applicable).
|
|
130
|
-
- Your Node.js and Next.js versions.
|
|
131
|
-
- Any relevant CLI output.
|
|
132
|
-
|
|
133
|
-
Source code and issue tracker: https://github.com/bilal-dev02/next-configure
|
|
59
|
+
Contributions welcome. For major changes, open an issue first.
|
|
134
60
|
|
|
135
|
-
|
|
61
|
+
Source code: https://github.com/bilal-dev02/next-configure
|
|
136
62
|
|
|
137
63
|
## License
|
|
138
64
|
|