@stetcms/config 0.1.0 → 0.1.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/README.md +17 -10
- package/package.json +10 -4
package/README.md
CHANGED
|
@@ -1,11 +1,18 @@
|
|
|
1
1
|
# @stetcms/config
|
|
2
2
|
|
|
3
|
+
[](https://github.com/jamiedavenport/stet/actions/workflows/ci.yml)
|
|
4
|
+
[](https://docs.stetcms.com/reference/configuration)
|
|
5
|
+
[](./LICENSE)
|
|
6
|
+
|
|
3
7
|
The shape of `stet.config.ts`: one file describing a project's whole
|
|
4
|
-
[Stet](https://
|
|
5
|
-
[`@stetcms/vite`](https://
|
|
6
|
-
and [`@stetcms/cli`](https://
|
|
8
|
+
[Stet](https://stetcms.com) integration, read by
|
|
9
|
+
[`@stetcms/vite`](https://docs.stetcms.com/reference/codegen)
|
|
10
|
+
and [`@stetcms/cli`](https://docs.stetcms.com/reference/cli)
|
|
7
11
|
so the two can never disagree about which Stet a project talks to.
|
|
8
12
|
|
|
13
|
+
Stet is the CMS where marketing owns the content model and engineering gets a
|
|
14
|
+
typed client generated from it.
|
|
15
|
+
|
|
9
16
|
## Install
|
|
10
17
|
|
|
11
18
|
```bash
|
|
@@ -28,13 +35,13 @@ export default defineStet({
|
|
|
28
35
|
});
|
|
29
36
|
```
|
|
30
37
|
|
|
31
|
-
| Key | Default | Description
|
|
32
|
-
| ----------- | --------------------------------- |
|
|
33
|
-
| `origin` | `STET_ORIGIN` or the hosted cloud | The Stet deployment to generate from and send to.
|
|
34
|
-
| `apiKey` | `STET_API_KEY` | Organization API key. Prefer the environment (see below).
|
|
35
|
-
| `output` | `src/stet.gen.ts` | Where the generated content client goes.
|
|
36
|
-
| `watch` | `true` | Regenerate while the dev server runs.
|
|
37
|
-
| `analytics` | none | The tracking plan, from `defineAnalytics()
|
|
38
|
+
| Key | Default | Description |
|
|
39
|
+
| ----------- | --------------------------------- | -------------------------------------------------------------------------------------------- |
|
|
40
|
+
| `origin` | `STET_ORIGIN` or the hosted cloud | The Stet deployment to generate from and send to. |
|
|
41
|
+
| `apiKey` | `STET_API_KEY` | Organization API key. Prefer the environment (see below). |
|
|
42
|
+
| `output` | `src/stet.gen.ts` | Where the generated content client goes. |
|
|
43
|
+
| `watch` | `true` | Regenerate while the dev server runs. |
|
|
44
|
+
| `analytics` | none | The tracking plan, from [`defineAnalytics()`](https://docs.stetcms.com/reference/analytics). |
|
|
38
45
|
|
|
39
46
|
A plugin option or a CLI flag beats the config file, which beats the
|
|
40
47
|
environment, which falls back to the default. `resolveStetConfig()` is that
|
package/package.json
CHANGED
|
@@ -1,12 +1,17 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@stetcms/config",
|
|
3
|
-
"version": "0.1.
|
|
4
|
-
"description": "The shape of stet.config.ts, shared by the
|
|
3
|
+
"version": "0.1.1",
|
|
4
|
+
"description": "The shape of stet.config.ts, shared by the Vite plugin and CLI of Stet, the CMS for marketing and engineering.",
|
|
5
5
|
"keywords": [
|
|
6
|
+
"cms",
|
|
6
7
|
"config",
|
|
7
|
-
"
|
|
8
|
+
"headless-cms",
|
|
9
|
+
"stet",
|
|
10
|
+
"stetcms",
|
|
11
|
+
"typescript",
|
|
12
|
+
"vite"
|
|
8
13
|
],
|
|
9
|
-
"homepage": "https://
|
|
14
|
+
"homepage": "https://docs.stetcms.com/reference/configuration",
|
|
10
15
|
"bugs": "https://github.com/jamiedavenport/stet/issues",
|
|
11
16
|
"license": "Apache-2.0",
|
|
12
17
|
"author": "Jamie Davenport (https://jxd.dev)",
|
|
@@ -19,6 +24,7 @@
|
|
|
19
24
|
"dist"
|
|
20
25
|
],
|
|
21
26
|
"type": "module",
|
|
27
|
+
"sideEffects": false,
|
|
22
28
|
"exports": {
|
|
23
29
|
".": {
|
|
24
30
|
"types": "./dist/index.d.ts",
|