create-rolldown 0.0.4 → 0.0.6

package/README.md

@@ -1,11 +1,22 @@
-# create-rolldown
-
-[![npm version](https://img.shields.io/npm/v/create-rolldown.svg)](https://www.npmjs.com/package/create-rolldown)
-[![license](https://img.shields.io/npm/l/create-rolldown.svg)](https://github.com/rolldown/create-rolldown/blob/main/LICENSE)
-
-Scaffolding tool for [Rolldown](https://rolldown.rs) library projects - a fast JavaScript bundler written in Rust.
-
-## Features
+<h1 align='center'>
+<samp>create-rolldown <img src="https://img.shields.io/npm/v/create-rolldown?color=333&labelColor=555&style=flat-square" ></samp>
+</h1>
+
+<p align='center'>
+  <samp>⚡️ Scaffolding tool for Rolldown library projects - a fast JavaScript bundler written in Rust, with TypeScript support and multiple framework templates</samp>
+<br>
+<br>
+</p>
+[![npm version][npm-version-src]][npm-version-href]
+[![npm downloads][npm-downloads-src]][npm-downloads-href]
+[![bundle][bundle-src]][bundle-href]
+[![License][license-src]][license-href]
+[![test](https://img.shields.io/badge/tests-77%20passed-brightgreen.svg)](https://github.com/sunny-117/create-rolldown)
+[![coverage](https://img.shields.io/badge/coverage-60.87%25-yellow.svg)](https://github.com/sunny-117/create-rolldown)
+
+## Introduction
+
+**Core Features:**
 
 - 🚀 **Fast Setup** - Create a new Rolldown project in seconds
 - 🎨 **TypeScript First** - All templates use TypeScript by default
@@ -15,35 +26,35 @@ Scaffolding tool for [Rolldown](https://rolldown.rs) library projects - a fast J
 - 📦 **Smart Package Manager Detection** - Automatically detects and uses your preferred package manager (npm, pnpm, yarn, bun)
 - ⚡ **Immediate Start** - Optional flag to install dependencies and start playground immediately
 
-## Usage
-
-### Interactive Mode (Recommended)
-
-Simply run one of the following commands and follow the prompts:
+## Installation
 
 ```bash
-# npm
 npm create rolldown@latest
-
-# pnpm
+# or
 pnpm create rolldown
-
-# yarn
+# or
 yarn create rolldown
-
-# bun
+# or
 bun create rolldown
 ```
 
+## Quick Start
+
+### Method 1: Interactive Mode (Recommended)
+
+Simply run the command and follow the prompts:
+
+```bash
+npm create rolldown@latest
+```
+
 You'll be prompted to:
 
 1. Enter a project name
 2. Choose a framework (Vanilla, React, Vue, Solid, or Svelte)
 3. Optionally install dependencies and start the playground immediately
 
-> **Note**: All templates use TypeScript and are designed for library development (utility libraries, component libraries, tools, etc.).
-
-### Non-Interactive Mode
+### Method 2: Non-Interactive Mode
 
 For automated workflows or CI/CD pipelines:
 
@@ -58,48 +69,6 @@ npm create rolldown@latest my-lib -- --template vue --immediate --no-interactive
 npm create rolldown@latest my-lib -- --template solid --overwrite --no-interactive
 ```
 
-## Command Line Options
-
-```
-Usage: create-rolldown [project-name] [options]
-
-Options:
-  -t, --template <template>    Specify a template (vanilla, react, vue, solid, svelte)
-  --overwrite                  Overwrite existing files in target directory
-  -i, --immediate              Install dependencies and start playground immediately
-  --interactive                Force interactive mode (default in TTY)
-  --no-interactive             Force non-interactive mode (default in non-TTY)
-  -h, --help                   Display this help message
-
-Available templates:
-  vanilla                      Vanilla TypeScript library
-  react                        React component library
-  vue                          Vue component library
-  solid                        SolidJS component library
-  svelte                       Svelte component library
-```
-
-## Examples
-
-### Create a React library (components, hooks, utilities)
-
-```bash
-npm create rolldown@latest my-react-lib
-# Select "react"
-```
-
-### Create a utility library and start immediately
-
-```bash
-npm create rolldown@latest my-utils -- --template vanilla --immediate
-```
-
-### Create a Vue composables library in CI/CD
-
-```bash
-npm create rolldown@latest my-vue-composables -- --template vue --no-interactive
-```
-
 ## Supported Templates
 
 | Template  | Description                      | Use Cases                          | Playground |
@@ -110,64 +79,32 @@ npm create rolldown@latest my-vue-composables -- --template vue --no-interactive
 | `solid`   | SolidJS library with TypeScript  | Solid components, primitives       | ✅ Vite    |
 | `svelte`  | Svelte 5 library with TypeScript | Svelte components, actions         | ✅ Vite    |
 
-### Template Architecture
-
-**Vanilla Template** - For pure TypeScript/JavaScript libraries:
+## Command Line Options
 
 ```
-your-library/
-├── src/
-│   └── index.ts           # Main entry point
-├── dist/                  # Build output (generated)
-├── rolldown.config.ts
-├── tsconfig.json
-└── package.json
-```
-
-**Framework Templates** (React, Vue, Solid, Svelte) - For framework-specific libraries:
+Usage: create-rolldown [project-name] [options]
 
+Options:
+  -t, --template <template>    Specify a template (vanilla, react, vue, solid, svelte)
+  --overwrite                  Overwrite existing files in target directory
+  -i, --immediate              Install dependencies and start playground immediately
+  --interactive                Force interactive mode (default in TTY)
+  --no-interactive             Force non-interactive mode (default in non-TTY)
+  -h, --help                   Display this help message
 ```
-your-library/
-├── src/                    # Component library source code
-│   ├── index.ts           # Main entry point (exports)
-│   └── MyButton.*         # Example component
-├── playground/            # Development playground (Vite)
-│   ├── src/
-│   │   ├── App.*         # Playground app
-│   │   ├── index.*       # Playground entry
-│   │   └── style.css     # Playground styles
-│   ├── index.html
-│   └── public/
-├── dist/                  # Build output (generated)
-├── rolldown.config.js     # Rolldown configuration
-├── vite.config.ts         # Vite configuration (for playground)
-├── tsconfig.json
-├── package.json
-└── README.md
-```
-
-**Key Features:**
-
-- `src/` - Your library source code (built with Rolldown)
-- `playground/` - Development environment (powered by Vite with HMR)
-- `npm run build` - Build library with Rolldown
-- `npm run dev` - Watch mode for library development
-- `npm run play` - Start Vite playground for testing your library
-- Ready for npm publishing with proper exports configuration
-- Perfect for component libraries, utility libraries, hooks, composables, and more
 
 ## Development
 
 ### Prerequisites
 
 - Node.js 20.19.0+ or 22.12.0+
-- pnpm (recommended) or npm
+- pnpm (recommended)
 
 ### Setup
 
 ```bash
 # Clone the repository
-git clone https://github.com/rolldown/create-rolldown.git
+git clone https://github.com/Sunny-117/create-rolldown.git
 cd create-rolldown
 
 # Install dependencies
@@ -185,6 +122,9 @@ pnpm test
 # Run tests in watch mode
 pnpm test:watch
 
+# Generate test coverage report
+pnpm test:coverage
+
 # Type checking
 pnpm typecheck
 
@@ -198,51 +138,6 @@ pnpm format
 pnpm format:check
 ```
 
-### Project Structure
-
-```
-create-rolldown/
-├── src/
-│   ├── cli.ts             # Main CLI entry point
-│   └── utils/             # Utility modules
-│       ├── args.ts        # Argument parsing
-│       ├── command.ts     # Command execution
-│       ├── constants.ts   # Framework definitions
-│       ├── file.ts        # File operations
-│       ├── package-manager.ts  # Package manager detection
-│       ├── prompts.ts     # Interactive prompts
-│       ├── types.ts       # TypeScript types
-│       └── validation.ts  # Input validation
-├── __tests__/
-│   └── cli.spec.ts        # Integration tests
-├── template-vanilla/      # Vanilla TS template
-├── template-react/        # React template
-├── template-vue/          # Vue template
-├── template-solid/        # Solid template
-├── template-svelte/       # Svelte template
-├── index.js               # CLI entry point
-├── package.json
-└── tsconfig.json
-```
-
-### Testing
-
-The project uses a comprehensive testing strategy:
-
-- **Unit Tests**: Test specific functions and edge cases
-- **Property-Based Tests**: Test universal properties across many inputs using [fast-check](https://github.com/dubzzz/fast-check)
-- **Integration Tests**: Test complete CLI workflows
-
-Run tests:
-
-```bash
-# Run all tests once
-pnpm test
-
-# Run tests in watch mode
-pnpm test:watch
-```
-
 ### Adding a New Template
 
 1. Create a new directory: `template-{framework}` (e.g., `template-preact`)
@@ -269,20 +164,27 @@ pnpm test:watch
 6. **Update files** (package.json name, metadata)
 7. **Optionally install dependencies** and start playground
 
-## Requirements
-
-- Node.js ^20.19.0 || >=22.12.0
-
 ## Contributing
 
 Contributions are welcome! Please feel free to submit a Pull Request.
 
 ## License
 
-MIT - see [LICENSE](./LICENSE) file for details
+💛 [MIT](./LICENSE) License © [Sunny-117](https://github.com/Sunny-117)
 
 ## Related Projects
 
 - [Rolldown](https://rolldown.rs) - Fast JavaScript bundler written in Rust
 - [tsdown](https://tsdown.dev) - TypeScript bundler built on Rolldown
 - [create-vite](https://github.com/vitejs/vite/tree/main/packages/create-vite) - Inspiration for this project
+
+<!-- Badges -->
+
+[npm-version-src]: https://img.shields.io/npm/v/create-rolldown?style=flat&colorA=080f12&colorB=1fa669
+[npm-version-href]: https://npmjs.com/package/create-rolldown
+[npm-downloads-src]: https://img.shields.io/npm/dm/create-rolldown?style=flat&colorA=080f12&colorB=1fa669
+[npm-downloads-href]: https://npmjs.com/package/create-rolldown
+[bundle-src]: https://img.shields.io/bundlephobia/minzip/create-rolldown?style=flat&colorA=080f12&colorB=1fa669&label=minzip
+[bundle-href]: https://bundlephobia.com/result?p=create-rolldown
+[license-src]: https://img.shields.io/github/license/Sunny-117/create-rolldown.svg?style=flat&colorA=080f12&colorB=1fa669
+[license-href]: https://github.com/Sunny-117/create-rolldown/blob/main/LICENSE

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-rolldown",
-  "version": "0.0.4",
+  "version": "0.0.6",
   "description": "Scaffolding tool for Rolldown projects",
   "keywords": [
     "bundler",
@@ -37,6 +37,7 @@
     "typecheck": "tsc --noEmit",
     "test": "vitest --run",
     "test:watch": "vitest",
+    "test:coverage": "vitest --run --coverage",
     "lint": "oxlint",
     "format": "oxfmt",
     "format:check": "oxfmt --check",
@@ -55,6 +56,7 @@
     "@types/cross-spawn": "^6.0.6",
     "@types/mri": "^1.1.5",
     "@types/node": "^20.11.0",
+    "@vitest/coverage-v8": "^1.6.1",
     "changelogen": "^0.6.2",
     "execa": "^9.0.0",
     "fast-check": "^3.15.0",

package/template-react/package.json

@@ -35,8 +35,8 @@
     "access": "public"
   },
   "scripts": {
-    "build": "rolldown -c rolldown.config.js",
-    "dev": "rolldown -c rolldown.config.js --watch",
+    "build": "rolldown -c rolldown.config.ts",
+    "dev": "rolldown -c rolldown.config.ts --watch",
     "play": "vite",
     "typecheck": "tsc --noEmit",
     "prepublishOnly": "pnpm run build"

package/template-react/playground/src/App.tsx

@@ -5,14 +5,14 @@ export function App() {
     <>
       <div>
         <a href="https://rolldown.rs" target="_blank" rel="noopener noreferrer">
-          <img src="/rolldown.svg" class="logo" alt="Rolldown logo" />
+          <img src="/rolldown.svg" className="logo" alt="Rolldown logo" />
         </a>
       </div>
       <h1>Rolldown + React</h1>
-      <div class="card">
+      <div className="card">
         <MyButton />
       </div>
-      <p class="read-the-docs">Click on the Rolldown logo to learn more</p>
+      <p className="read-the-docs">Click on the Rolldown logo to learn more</p>
     </>
   );
 }

package/template-solid/package.json

@@ -40,8 +40,8 @@
     "access": "public"
   },
   "scripts": {
-    "build": "rolldown -c rolldown.config.js",
-    "dev": "rolldown -c rolldown.config.js --watch",
+    "build": "rolldown -c rolldown.config.ts",
+    "dev": "rolldown -c rolldown.config.ts --watch",
     "play": "vite",
     "typecheck": "tsc --noEmit",
     "prepublishOnly": "pnpm run build"

package/template-solid/playground/src/App.tsx

@@ -5,14 +5,14 @@ export function App() {
     <>
       <div>
         <a href="https://rolldown.rs" target="_blank" rel="noopener noreferrer">
-          <img src="/rolldown.svg" class="logo" alt="Rolldown logo" />
+          <img src="/rolldown.svg" className="logo" alt="Rolldown logo" />
         </a>
       </div>
       <h1>Rolldown + SolidJS</h1>
-      <div class="card">
+      <div className="card">
         <MyButton />
       </div>
-      <p class="read-the-docs">Click on the Rolldown logo to learn more</p>
+      <p className="read-the-docs">Click on the Rolldown logo to learn more</p>
     </>
   );
 }

package/template-svelte/package.json

@@ -36,8 +36,8 @@
     "access": "public"
   },
   "scripts": {
-    "build": "rolldown -c rolldown.config.js",
-    "dev": "rolldown -c rolldown.config.js --watch",
+    "build": "rolldown -c rolldown.config.ts",
+    "dev": "rolldown -c rolldown.config.ts --watch",
     "play": "vite",
     "typecheck": "svelte-check --tsconfig ./tsconfig.json",
     "prepublishOnly": "pnpm run build"

package/template-vanilla/package.json

@@ -34,8 +34,8 @@
     "access": "public"
   },
   "scripts": {
-    "build": "rolldown -c rolldown.config.js",
-    "dev": "rolldown -c rolldown.config.js --watch",
+    "build": "rolldown -c rolldown.config.ts",
+    "dev": "rolldown -c rolldown.config.ts --watch",
     "typecheck": "tsc --noEmit",
     "prepublishOnly": "pnpm run build"
   },

package/template-vue/package.json

@@ -36,8 +36,8 @@
     "access": "public"
   },
   "scripts": {
-    "build": "rolldown -c rolldown.config.js",
-    "dev": "rolldown -c rolldown.config.js --watch",
+    "build": "rolldown -c rolldown.config.ts",
+    "dev": "rolldown -c rolldown.config.ts --watch",
     "play": "vite",
     "typecheck": "vue-tsc --noEmit",
     "prepublishOnly": "pnpm run build"