create-flaghoist 0.1.0 → 0.1.2
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 +41 -0
- package/package.json +11 -2
package/README.md
ADDED
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
# create-flaghoist
|
|
2
|
+
|
|
3
|
+
The package behind `npm create flaghoist`. It sets up a new Flaghoist project, which in practice
|
|
4
|
+
means writing one config file and telling you what to run next.
|
|
5
|
+
|
|
6
|
+
```bash
|
|
7
|
+
npm create flaghoist@latest team-flags
|
|
8
|
+
```
|
|
9
|
+
|
|
10
|
+
You get a `flaghoist.toml`:
|
|
11
|
+
|
|
12
|
+
```toml
|
|
13
|
+
name = "team-flags"
|
|
14
|
+
storage = "cloudflare-kv"
|
|
15
|
+
|
|
16
|
+
[auth]
|
|
17
|
+
admin = "bearer-token"
|
|
18
|
+
read = "api-key"
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
That file is the entire project. `npx flaghoist deploy` turns it into a running flag service with an
|
|
22
|
+
admin dashboard, and `npx flaghoist eject` turns it into TypeScript you own instead.
|
|
23
|
+
|
|
24
|
+
## Options
|
|
25
|
+
|
|
26
|
+
```bash
|
|
27
|
+
npm create flaghoist@latest team-flags -- --storage redis
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
Storage can be `cloudflare-kv` (the default), `redis`, `postgres` or `memory`. You can change it
|
|
31
|
+
later by editing the config, so it is not a decision you are stuck with.
|
|
32
|
+
|
|
33
|
+
It will not write into a directory that already has files in it.
|
|
34
|
+
|
|
35
|
+
## Status
|
|
36
|
+
|
|
37
|
+
Pre-alpha, built and maintained by one person. The API can still change without notice, and
|
|
38
|
+
production use is not recommended yet. If you try it and something breaks, an issue is genuinely
|
|
39
|
+
useful.
|
|
40
|
+
|
|
41
|
+
Apache-2.0. Part of [Flaghoist](https://github.com/flaghoist/flaghoist).
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "create-flaghoist",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.2",
|
|
4
4
|
"description": "Scaffold a Flaghoist feature-flag service — the package behind `npm create flaghoist`.",
|
|
5
5
|
"license": "Apache-2.0",
|
|
6
6
|
"type": "module",
|
|
@@ -21,11 +21,20 @@
|
|
|
21
21
|
"scaffold"
|
|
22
22
|
],
|
|
23
23
|
"dependencies": {
|
|
24
|
-
"flaghoist": "0.1.
|
|
24
|
+
"flaghoist": "0.1.2"
|
|
25
25
|
},
|
|
26
26
|
"publishConfig": {
|
|
27
27
|
"access": "public"
|
|
28
28
|
},
|
|
29
|
+
"repository": {
|
|
30
|
+
"type": "git",
|
|
31
|
+
"url": "git+https://github.com/flaghoist/flaghoist.git",
|
|
32
|
+
"directory": "packages/create-flaghoist"
|
|
33
|
+
},
|
|
34
|
+
"homepage": "https://github.com/flaghoist/flaghoist#readme",
|
|
35
|
+
"bugs": {
|
|
36
|
+
"url": "https://github.com/flaghoist/flaghoist/issues"
|
|
37
|
+
},
|
|
29
38
|
"scripts": {
|
|
30
39
|
"build": "tsup src/index.ts --format esm --clean",
|
|
31
40
|
"test": "vitest run --passWithNoTests",
|