create-efffrida-app 0.0.24 → 0.0.26
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 +49 -0
- package/dist/bin.cjs +5192 -24300
- package/package.json +8 -5
package/README.md
ADDED
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
# create-efffrida-app
|
|
2
|
+
|
|
3
|
+
Scaffolds a new efffrida project from one of the templates in the
|
|
4
|
+
[efffrida repository](https://github.com/leonitousconforti/efffrida/tree/main/templates).
|
|
5
|
+
|
|
6
|
+
### Usage
|
|
7
|
+
|
|
8
|
+
```sh
|
|
9
|
+
npm create efffrida-app
|
|
10
|
+
# or
|
|
11
|
+
pnpm create efffrida-app
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
Any option that is not passed on the command line is asked for interactively.
|
|
15
|
+
The yes/no options also accept a `--no-` prefix, so a fully non-interactive run
|
|
16
|
+
looks like:
|
|
17
|
+
|
|
18
|
+
```sh
|
|
19
|
+
pnpm create efffrida-app my-app --template agent-only \
|
|
20
|
+
--oxc-tools --node-vitest --frida-vitest --workflows --flake --no-changesets
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
The `@efffrida/*` dependencies of the new project are pinned to the versions
|
|
24
|
+
released together with the template.
|
|
25
|
+
|
|
26
|
+
### Templates
|
|
27
|
+
|
|
28
|
+
- `agent-only`: a single Frida agent using `@efffrida/platform` and
|
|
29
|
+
`FridaRuntime.runMain`, tested inside Frida with `@efffrida/vitest-pool`.
|
|
30
|
+
- `app-and-agent`: a Node.js host app and a Frida agent that talk over
|
|
31
|
+
`@efffrida/rpc`, with separate tsconfigs for each side.
|
|
32
|
+
|
|
33
|
+
### Options
|
|
34
|
+
|
|
35
|
+
| Option | Description |
|
|
36
|
+
| ---------------- | --------------------------------------------------------------------------------------------------------------------------- |
|
|
37
|
+
| `<project-name>` | The folder to create the project in, or `.` to use the current directory (which must be empty) |
|
|
38
|
+
| `--template` | The template to use, `agent-only` or `app-and-agent` |
|
|
39
|
+
| `--oxc-tools` | Add oxlint and oxfmt for linting and formatting |
|
|
40
|
+
| `--node-vitest` | Add vitest for Node.js unit testing |
|
|
41
|
+
| `--frida-vitest` | Add `@efffrida/vitest-pool` for running tests inside Frida |
|
|
42
|
+
| `--workflows` | Initialize the project with GitHub Actions CI workflows |
|
|
43
|
+
| `--flake` | Initialize the project with a Nix flake |
|
|
44
|
+
| `--changesets` | Initialize the project with Changesets |
|
|
45
|
+
| `--ref` | The branch, tag or commit of the efffrida repository to download the template from, defaults to the release of this version |
|
|
46
|
+
|
|
47
|
+
The yes/no options (`--oxc-tools`, `--node-vitest`, `--frida-vitest`,
|
|
48
|
+
`--workflows`, `--flake` and `--changesets`) are currently informational only:
|
|
49
|
+
the full template is always scaffolded, whatever the answers.
|