create-rolldown 0.0.5 → 0.0.6

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 (12) hide show
  1. package/README.md +52 -39
  2. package/package.json +1 -1
  3. package/template-react/package.json +2 -2
  4. package/template-solid/package.json +2 -2
  5. package/template-svelte/package.json +2 -2
  6. package/template-vanilla/package.json +2 -2
  7. package/template-vue/package.json +2 -2
  8. /package/template-react/{rolldown.config.js → rolldown.config.ts} +0 -0
  9. /package/template-solid/{rolldown.config.js → rolldown.config.ts} +0 -0
  10. /package/template-svelte/{rolldown.config.js → rolldown.config.ts} +0 -0
  11. /package/template-vanilla/{rolldown.config.js → rolldown.config.ts} +0 -0
  12. /package/template-vue/{rolldown.config.js → rolldown.config.ts} +0 -0
package/README.md CHANGED
@@ -1,13 +1,22 @@
1
- # create-rolldown
2
-
3
- [![npm version](https://img.shields.io/npm/v/create-rolldown.svg)](https://www.npmjs.com/package/create-rolldown)
4
- [![license](https://img.shields.io/npm/l/create-rolldown.svg)](https://github.com/rolldown/create-rolldown/blob/main/LICENSE)
1
+ <h1 align='center'>
2
+ <samp>create-rolldown <img src="https://img.shields.io/npm/v/create-rolldown?color=333&labelColor=555&style=flat-square" ></samp>
3
+ </h1>
4
+
5
+ <p align='center'>
6
+ <samp>⚡️ Scaffolding tool for Rolldown library projects - a fast JavaScript bundler written in Rust, with TypeScript support and multiple framework templates</samp>
7
+ <br>
8
+ <br>
9
+ </p>
10
+ [![npm version][npm-version-src]][npm-version-href]
11
+ [![npm downloads][npm-downloads-src]][npm-downloads-href]
12
+ [![bundle][bundle-src]][bundle-href]
13
+ [![License][license-src]][license-href]
5
14
  [![test](https://img.shields.io/badge/tests-77%20passed-brightgreen.svg)](https://github.com/sunny-117/create-rolldown)
6
15
  [![coverage](https://img.shields.io/badge/coverage-60.87%25-yellow.svg)](https://github.com/sunny-117/create-rolldown)
7
16
 
8
- Scaffolding tool for [Rolldown](https://rolldown.rs) library projects - a fast JavaScript bundler written in Rust.
17
+ ## Introduction
9
18
 
10
- ## Features
19
+ **Core Features:**
11
20
 
12
21
  - 🚀 **Fast Setup** - Create a new Rolldown project in seconds
13
22
  - 🎨 **TypeScript First** - All templates use TypeScript by default
@@ -17,35 +26,35 @@ Scaffolding tool for [Rolldown](https://rolldown.rs) library projects - a fast J
17
26
  - 📦 **Smart Package Manager Detection** - Automatically detects and uses your preferred package manager (npm, pnpm, yarn, bun)
18
27
  - ⚡ **Immediate Start** - Optional flag to install dependencies and start playground immediately
19
28
 
20
- ## Usage
21
-
22
- ### Interactive Mode (Recommended)
23
-
24
- Simply run one of the following commands and follow the prompts:
29
+ ## Installation
25
30
 
26
31
  ```bash
27
- # npm
28
32
  npm create rolldown@latest
29
-
30
- # pnpm
33
+ # or
31
34
  pnpm create rolldown
32
-
33
- # yarn
35
+ # or
34
36
  yarn create rolldown
35
-
36
- # bun
37
+ # or
37
38
  bun create rolldown
38
39
  ```
39
40
 
41
+ ## Quick Start
42
+
43
+ ### Method 1: Interactive Mode (Recommended)
44
+
45
+ Simply run the command and follow the prompts:
46
+
47
+ ```bash
48
+ npm create rolldown@latest
49
+ ```
50
+
40
51
  You'll be prompted to:
41
52
 
42
53
  1. Enter a project name
43
54
  2. Choose a framework (Vanilla, React, Vue, Solid, or Svelte)
44
55
  3. Optionally install dependencies and start the playground immediately
45
56
 
46
- > **Note**: All templates use TypeScript and are designed for library development (utility libraries, component libraries, tools, etc.).
47
-
48
- ### Non-Interactive Mode
57
+ ### Method 2: Non-Interactive Mode
49
58
 
50
59
  For automated workflows or CI/CD pipelines:
51
60
 
@@ -60,6 +69,16 @@ npm create rolldown@latest my-lib -- --template vue --immediate --no-interactive
60
69
  npm create rolldown@latest my-lib -- --template solid --overwrite --no-interactive
61
70
  ```
62
71
 
72
+ ## Supported Templates
73
+
74
+ | Template | Description | Use Cases | Playground |
75
+ | --------- | -------------------------------- | ---------------------------------- | ---------- |
76
+ | `vanilla` | Vanilla TypeScript library | Utility libraries, tools, helpers | ❌ |
77
+ | `react` | React library with TypeScript | React components, hooks, utilities | ✅ Vite |
78
+ | `vue` | Vue 3 library with TypeScript | Vue components, composables | ✅ Vite |
79
+ | `solid` | SolidJS library with TypeScript | Solid components, primitives | ✅ Vite |
80
+ | `svelte` | Svelte 5 library with TypeScript | Svelte components, actions | ✅ Vite |
81
+
63
82
  ## Command Line Options
64
83
 
65
84
  ```
@@ -72,25 +91,8 @@ Options:
72
91
  --interactive Force interactive mode (default in TTY)
73
92
  --no-interactive Force non-interactive mode (default in non-TTY)
74
93
  -h, --help Display this help message
75
-
76
- Available templates:
77
- vanilla Vanilla TypeScript library
78
- react React component library
79
- vue Vue component library
80
- solid SolidJS component library
81
- svelte Svelte component library
82
94
  ```
83
95
 
84
- ## Supported Templates
85
-
86
- | Template | Description | Use Cases | Playground |
87
- | --------- | -------------------------------- | ---------------------------------- | ---------- |
88
- | `vanilla` | Vanilla TypeScript library | Utility libraries, tools, helpers | ❌ |
89
- | `react` | React library with TypeScript | React components, hooks, utilities | ✅ Vite |
90
- | `vue` | Vue 3 library with TypeScript | Vue components, composables | ✅ Vite |
91
- | `solid` | SolidJS library with TypeScript | Solid components, primitives | ✅ Vite |
92
- | `svelte` | Svelte 5 library with TypeScript | Svelte components, actions | ✅ Vite |
93
-
94
96
  ## Development
95
97
 
96
98
  ### Prerequisites
@@ -168,10 +170,21 @@ Contributions are welcome! Please feel free to submit a Pull Request.
168
170
 
169
171
  ## License
170
172
 
171
- MIT - see [LICENSE](./LICENSE) file for details
173
+ 💛 [MIT](./LICENSE) License © [Sunny-117](https://github.com/Sunny-117)
172
174
 
173
175
  ## Related Projects
174
176
 
175
177
  - [Rolldown](https://rolldown.rs) - Fast JavaScript bundler written in Rust
176
178
  - [tsdown](https://tsdown.dev) - TypeScript bundler built on Rolldown
177
179
  - [create-vite](https://github.com/vitejs/vite/tree/main/packages/create-vite) - Inspiration for this project
180
+
181
+ <!-- Badges -->
182
+
183
+ [npm-version-src]: https://img.shields.io/npm/v/create-rolldown?style=flat&colorA=080f12&colorB=1fa669
184
+ [npm-version-href]: https://npmjs.com/package/create-rolldown
185
+ [npm-downloads-src]: https://img.shields.io/npm/dm/create-rolldown?style=flat&colorA=080f12&colorB=1fa669
186
+ [npm-downloads-href]: https://npmjs.com/package/create-rolldown
187
+ [bundle-src]: https://img.shields.io/bundlephobia/minzip/create-rolldown?style=flat&colorA=080f12&colorB=1fa669&label=minzip
188
+ [bundle-href]: https://bundlephobia.com/result?p=create-rolldown
189
+ [license-src]: https://img.shields.io/github/license/Sunny-117/create-rolldown.svg?style=flat&colorA=080f12&colorB=1fa669
190
+ [license-href]: https://github.com/Sunny-117/create-rolldown/blob/main/LICENSE
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "create-rolldown",
3
- "version": "0.0.5",
3
+ "version": "0.0.6",
4
4
  "description": "Scaffolding tool for Rolldown projects",
5
5
  "keywords": [
6
6
  "bundler",
package/template-react/package.json CHANGED
@@ -35,8 +35,8 @@
35
35
  "access": "public"
36
36
  },
37
37
  "scripts": {
38
- "build": "rolldown -c rolldown.config.js",
39
- "dev": "rolldown -c rolldown.config.js --watch",
38
+ "build": "rolldown -c rolldown.config.ts",
39
+ "dev": "rolldown -c rolldown.config.ts --watch",
40
40
  "play": "vite",
41
41
  "typecheck": "tsc --noEmit",
42
42
  "prepublishOnly": "pnpm run build"
package/template-solid/package.json CHANGED
@@ -40,8 +40,8 @@
40
40
  "access": "public"
41
41
  },
42
42
  "scripts": {
43
- "build": "rolldown -c rolldown.config.js",
44
- "dev": "rolldown -c rolldown.config.js --watch",
43
+ "build": "rolldown -c rolldown.config.ts",
44
+ "dev": "rolldown -c rolldown.config.ts --watch",
45
45
  "play": "vite",
46
46
  "typecheck": "tsc --noEmit",
47
47
  "prepublishOnly": "pnpm run build"
package/template-svelte/package.json CHANGED
@@ -36,8 +36,8 @@
36
36
  "access": "public"
37
37
  },
38
38
  "scripts": {
39
- "build": "rolldown -c rolldown.config.js",
40
- "dev": "rolldown -c rolldown.config.js --watch",
39
+ "build": "rolldown -c rolldown.config.ts",
40
+ "dev": "rolldown -c rolldown.config.ts --watch",
41
41
  "play": "vite",
42
42
  "typecheck": "svelte-check --tsconfig ./tsconfig.json",
43
43
  "prepublishOnly": "pnpm run build"
package/template-vanilla/package.json CHANGED
@@ -34,8 +34,8 @@
34
34
  "access": "public"
35
35
  },
36
36
  "scripts": {
37
- "build": "rolldown -c rolldown.config.js",
38
- "dev": "rolldown -c rolldown.config.js --watch",
37
+ "build": "rolldown -c rolldown.config.ts",
38
+ "dev": "rolldown -c rolldown.config.ts --watch",
39
39
  "typecheck": "tsc --noEmit",
40
40
  "prepublishOnly": "pnpm run build"
41
41
  },
package/template-vue/package.json CHANGED
@@ -36,8 +36,8 @@
36
36
  "access": "public"
37
37
  },
38
38
  "scripts": {
39
- "build": "rolldown -c rolldown.config.js",
40
- "dev": "rolldown -c rolldown.config.js --watch",
39
+ "build": "rolldown -c rolldown.config.ts",
40
+ "dev": "rolldown -c rolldown.config.ts --watch",
41
41
  "play": "vite",
42
42
  "typecheck": "vue-tsc --noEmit",
43
43
  "prepublishOnly": "pnpm run build"