@heleg/runpad 0.0.5 → 0.1.0
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 +35 -18
- package/dist/index.mjs +639 -1594
- package/package.json +10 -2
- package/schema.json +73 -0
package/README.md
CHANGED
|
@@ -1,36 +1,53 @@
|
|
|
1
1
|
# RunPad
|
|
2
2
|
|
|
3
|
-
|
|
4
|
-
|
|
3
|
+
Terminal UI for browsing and running `package.json` scripts. Works in single
|
|
4
|
+
packages and npm, Yarn, pnpm and Bun workspaces.
|
|
5
5
|
|
|
6
|
-
|
|
6
|
+

|
|
7
7
|
|
|
8
|
-
|
|
8
|
+
## Why
|
|
9
9
|
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
10
|
+
Once a monorepo grows past a handful of packages, scripts get out of hand.
|
|
11
|
+
Dozens of `package.json` files, each with its own `dev`, `build`, `test:e2e`,
|
|
12
|
+
`db:migrate`... and you end up opening files just to remember what a script is
|
|
13
|
+
called, or typing `pnpm --filter some-long-name run something` from memory.
|
|
13
14
|
|
|
14
|
-
|
|
15
|
+
RunPad puts every script from every package in one list. Pick one, hit Enter,
|
|
16
|
+
done. Pin the ones your team actually uses, hide the noise, keep your own
|
|
17
|
+
favorites on top.
|
|
18
|
+
|
|
19
|
+
## Install
|
|
15
20
|
|
|
16
21
|
```bash
|
|
17
|
-
|
|
22
|
+
npm install -g @heleg/runpad # install globally
|
|
23
|
+
# or
|
|
24
|
+
mise use npm:@heleg/runpad # per project
|
|
18
25
|
```
|
|
19
26
|
|
|
27
|
+
Requires Node.js >= 22.18.0.
|
|
28
|
+
|
|
20
29
|
## Usage
|
|
21
30
|
|
|
22
|
-
Run
|
|
31
|
+
Run `rp` anywhere inside a project (`runpad` is the same command with a longer
|
|
32
|
+
name).
|
|
23
33
|
|
|
24
|
-
|
|
25
|
-
rp
|
|
26
|
-
```
|
|
34
|
+
## Configuration
|
|
27
35
|
|
|
28
|
-
|
|
36
|
+
Optional `runpad.config.json` in the workspace root (or package directory),
|
|
37
|
+
shared with the team. `package` is the package path relative to that root, `"."`
|
|
38
|
+
is the root package itself.
|
|
29
39
|
|
|
30
|
-
```
|
|
31
|
-
|
|
40
|
+
```json
|
|
41
|
+
{
|
|
42
|
+
"$schema": "https://unpkg.com/@heleg/runpad/schema.json",
|
|
43
|
+
"scripts": {
|
|
44
|
+
"pinned": [{ "package": "apps/web", "scripts": ["dev", "build"] }],
|
|
45
|
+
"hidden": [{ "package": ".", "scripts": ["prepare"] }]
|
|
46
|
+
}
|
|
47
|
+
}
|
|
32
48
|
```
|
|
33
49
|
|
|
34
|
-
##
|
|
50
|
+
## Favorites
|
|
35
51
|
|
|
36
|
-
|
|
52
|
+
Press <kbd>F</kbd> in RunPad to add a favorite. Favorites are personal and live
|
|
53
|
+
outside the project, so there is nothing to commit or ignore.
|