@theholocron/holocron-config 7.26.0 → 7.26.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 +46 -0
- package/dist/configs/node-docs.js +1 -1
- package/package.json +3 -3
package/README.md
CHANGED
|
@@ -40,3 +40,49 @@ export default defineConfig({
|
|
|
40
40
|
| `providers` | `source: "github"`, `ci: "github"`, `issues: ["github", { labels: … }]` |
|
|
41
41
|
|
|
42
42
|
Everything else — `name`, `repo.name`, `repo.topics`, and any per-repo workflow overrides (e.g. `release`) — stays in the consuming repo's config.
|
|
43
|
+
|
|
44
|
+
## Presets
|
|
45
|
+
|
|
46
|
+
### `nodeDocs()`
|
|
47
|
+
|
|
48
|
+
Extends `node()` for repos that publish a documentation site and deploy Cloudflare Pages previews on PRs.
|
|
49
|
+
|
|
50
|
+
```ts
|
|
51
|
+
import { defineConfig } from "@theholocron/cli";
|
|
52
|
+
import { nodeDocs } from "@theholocron/holocron-config";
|
|
53
|
+
|
|
54
|
+
const { repo, workflows, providers, org, domain, docs } = nodeDocs();
|
|
55
|
+
export default defineConfig({
|
|
56
|
+
description: "...",
|
|
57
|
+
homepage: "https://docs.theholocron.dev/my-lib/",
|
|
58
|
+
org,
|
|
59
|
+
domain,
|
|
60
|
+
docs,
|
|
61
|
+
repo: {
|
|
62
|
+
...repo,
|
|
63
|
+
name: "theholocron/my-lib",
|
|
64
|
+
topics: ["typescript"],
|
|
65
|
+
requiredChecks: [...repo.requiredChecks, "codecov/patch/my-package", "codecov/project/my-package"],
|
|
66
|
+
},
|
|
67
|
+
workflows: [...workflows, "audit", { name: "release", with: { "run-build": true } }, "sync"],
|
|
68
|
+
providers: { ...providers, secrets: "github" },
|
|
69
|
+
});
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
Adds on top of `node()`:
|
|
73
|
+
|
|
74
|
+
| Fragment | Contents |
|
|
75
|
+
| ---------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
|
|
76
|
+
| `org` | `"theholocron"` |
|
|
77
|
+
| `domain` | `"theholocron.dev"` |
|
|
78
|
+
| `docs` | `{ build: "workflow", https: true }` |
|
|
79
|
+
| `providers.deployment` | `["cloudflare", { accountId: "9c558af98664d13fc89b7e0a0d93d5a8" }]` |
|
|
80
|
+
| `providers.dns` | `"cloudflare"` |
|
|
81
|
+
| `workflows` | adds `{ name: "deploy", with: { docs: true, preview: true } }` |
|
|
82
|
+
| `repo.requiredChecks` | `"Lint / Conclusion"`, `"Test / Conclusion"`, `"Typecheck / Conclusion"`, `"audit / Conclusion"`, `"codecov/patch"`, `"codecov/project"` |
|
|
83
|
+
|
|
84
|
+
Per-repo extends `requiredChecks` with its own `codecov/patch/<package>` entries.
|
|
85
|
+
|
|
86
|
+
### `nextjs()` · `react()` · `monorepo(base)`
|
|
87
|
+
|
|
88
|
+
See [`.notes/preset-system.md`](../../.notes/preset-system.md) for the full preset hierarchy and usage examples for browser app repos.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@theholocron/holocron-config",
|
|
3
|
-
"version": "7.26.
|
|
3
|
+
"version": "7.26.1",
|
|
4
4
|
"description": "Shareable holocron configuration presets for theholocron repositories.",
|
|
5
5
|
"homepage": "https://github.com/theholocron/configs/tree/main/packages/holocron-config#readme",
|
|
6
6
|
"bugs": "https://github.com/theholocron/configs/issues",
|
|
@@ -23,8 +23,8 @@
|
|
|
23
23
|
"typescript": "^5.9.3",
|
|
24
24
|
"vitest": "^4.1.10",
|
|
25
25
|
"@vitest/coverage-v8": "^4.1.10",
|
|
26
|
-
"@theholocron/tsconfig": "7.26.
|
|
27
|
-
"@theholocron/vitest-config": "7.26.
|
|
26
|
+
"@theholocron/tsconfig": "7.26.1",
|
|
27
|
+
"@theholocron/vitest-config": "7.26.1"
|
|
28
28
|
},
|
|
29
29
|
"peerDependencies": {
|
|
30
30
|
"@theholocron/cli": ">=2.0.0-alpha.1"
|