create-ripple 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.
- package/LICENSE +21 -0
- package/README.md +71 -0
- package/dist/index.js +2 -0
- package/package.json +39 -8
- package/index.js +0 -1
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2025 Dominic Gannaway
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,71 @@
|
|
|
1
|
+
# create-ripple
|
|
2
|
+
|
|
3
|
+
[](https://www.npmjs.com/package/create-ripple)
|
|
4
|
+
[](https://www.npmjs.com/package/create-ripple)
|
|
5
|
+
|
|
6
|
+
Interactive CLI tool for creating new Ripple applications. Alias for the
|
|
7
|
+
`@ripple-ts/cli` package.
|
|
8
|
+
|
|
9
|
+
## Usage
|
|
10
|
+
|
|
11
|
+
### Interactive Mode
|
|
12
|
+
|
|
13
|
+
```bash
|
|
14
|
+
npx create-ripple
|
|
15
|
+
# or
|
|
16
|
+
npm create ripple
|
|
17
|
+
# or
|
|
18
|
+
yarn create ripple
|
|
19
|
+
# or
|
|
20
|
+
pnpm create ripple
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
### With Arguments
|
|
24
|
+
|
|
25
|
+
- `project-name`: Optional. Name of the project to create
|
|
26
|
+
- `-p, --package-manager <pm>`: Package manager to use - npm, yarn, pnpm (default:
|
|
27
|
+
npm)
|
|
28
|
+
- `--template <template>`: Choose a predefined template (default and currently
|
|
29
|
+
only option: basic)
|
|
30
|
+
- `--yes` or `-y`: Skip all prompts and use defaults
|
|
31
|
+
- `--no-git`: Skip initializing a Git repository
|
|
32
|
+
|
|
33
|
+
Examples:
|
|
34
|
+
|
|
35
|
+
````bash
|
|
36
|
+
npm create ripple my-app
|
|
37
|
+
# or
|
|
38
|
+
npx create-ripple my-app
|
|
39
|
+
|
|
40
|
+
```bash
|
|
41
|
+
npm create ripple my-app --yes --no-git
|
|
42
|
+
# or
|
|
43
|
+
npx create ripple my-app --yes --no-git
|
|
44
|
+
````
|
|
45
|
+
|
|
46
|
+
## Features
|
|
47
|
+
|
|
48
|
+
- 🎯 **Interactive prompts** - Guides you through project setup
|
|
49
|
+
- 📁 **Template selection** - Choose from predefined templates
|
|
50
|
+
- ✅ **Project validation** - Ensures valid project names
|
|
51
|
+
- 🎨 **Beautiful CLI** - Colored output with progress indicators
|
|
52
|
+
- ⚡ **Fast setup** - Quickly scaffold new Ripple projects
|
|
53
|
+
|
|
54
|
+
## Templates
|
|
55
|
+
|
|
56
|
+
### Basic
|
|
57
|
+
|
|
58
|
+
A minimal Ripple application with:
|
|
59
|
+
|
|
60
|
+
- Vite for development and building
|
|
61
|
+
- TypeScript support
|
|
62
|
+
- Prettier for code formatting
|
|
63
|
+
- Basic project structure
|
|
64
|
+
|
|
65
|
+
## Requirements
|
|
66
|
+
|
|
67
|
+
- Node.js 20.0.0 or higher
|
|
68
|
+
|
|
69
|
+
## License
|
|
70
|
+
|
|
71
|
+
MIT
|
package/dist/index.js
ADDED
package/package.json
CHANGED
|
@@ -1,11 +1,42 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "create-ripple",
|
|
3
|
-
"version": "1.0.
|
|
4
|
-
"
|
|
5
|
-
"
|
|
6
|
-
|
|
3
|
+
"version": "1.0.1",
|
|
4
|
+
"type": "module",
|
|
5
|
+
"license": "MIT",
|
|
6
|
+
"author": "Ripple Team",
|
|
7
|
+
"keywords": [
|
|
8
|
+
"ripple",
|
|
9
|
+
"cli",
|
|
10
|
+
"scaffold",
|
|
11
|
+
"template",
|
|
12
|
+
"create-app"
|
|
13
|
+
],
|
|
14
|
+
"repository": {
|
|
15
|
+
"type": "git",
|
|
16
|
+
"url": "git+https://github.com/Ripple-TS/ripple.git",
|
|
17
|
+
"directory": "packages/create-ripple"
|
|
18
|
+
},
|
|
19
|
+
"bugs": {
|
|
20
|
+
"url": "https://github.com/Ripple-TS/ripple/issues"
|
|
21
|
+
},
|
|
22
|
+
"homepage": "https://ripple-ts.com",
|
|
23
|
+
"engines": {
|
|
24
|
+
"node": ">=22.0.0"
|
|
25
|
+
},
|
|
26
|
+
"files": [
|
|
27
|
+
"./dist/index.js"
|
|
28
|
+
],
|
|
29
|
+
"main": "./dist/index.js",
|
|
30
|
+
"bin": {
|
|
31
|
+
"create-ripple": "./dist/index.js"
|
|
7
32
|
},
|
|
8
|
-
"
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
33
|
+
"dependencies": {
|
|
34
|
+
"@ripple-ts/cli": "1.0.1"
|
|
35
|
+
},
|
|
36
|
+
"devDependencies": {
|
|
37
|
+
"tsdown": "^0.20.3"
|
|
38
|
+
},
|
|
39
|
+
"scripts": {
|
|
40
|
+
"build": "tsdown"
|
|
41
|
+
}
|
|
42
|
+
}
|
package/index.js
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
console.log('Hello world');
|