@electrojs/config 1.0.1 → 1.0.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 +6 -4
- package/dist/index.d.mts +3 -3
- package/package.json +2 -1
package/README.md
CHANGED
|
@@ -1,8 +1,10 @@
|
|
|
1
1
|
# @electrojs/config
|
|
2
2
|
|
|
3
|
-
Typed configuration contracts for
|
|
3
|
+
Typed configuration contracts for ElectroJS applications.
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
Documentation: https://electrojs.myraxbyte.dev/
|
|
6
|
+
|
|
7
|
+
ElectroJS supports a monorepo-style application layout with:
|
|
6
8
|
|
|
7
9
|
- one root `electro.config.ts`
|
|
8
10
|
- one `runtime/` package with `runtime.config.ts`
|
|
@@ -45,7 +47,7 @@ interface AppConfig {
|
|
|
45
47
|
- `runtime` is the package specifier for the runtime package
|
|
46
48
|
- `views` is the explicit list of renderer view package specifiers
|
|
47
49
|
|
|
48
|
-
|
|
50
|
+
ElectroJS documents explicit package configuration as the supported setup instead of single-repo auto-discovery.
|
|
49
51
|
|
|
50
52
|
## `runtime.config.ts`
|
|
51
53
|
|
|
@@ -92,7 +94,7 @@ interface ViewConfig extends ViteUserConfig {
|
|
|
92
94
|
|
|
93
95
|
- `viewId` is the bundled renderer id used by runtime `@View({ source: "view:<id>" })`
|
|
94
96
|
- `entry` defaults to `./index.html`
|
|
95
|
-
- `preload` is optional because
|
|
97
|
+
- `preload` is optional because ElectroJS usually generates preload entrypoints automatically
|
|
96
98
|
|
|
97
99
|
## Layout
|
|
98
100
|
|
package/dist/index.d.mts
CHANGED
|
@@ -5,7 +5,7 @@ import { UserConfig } from "vite";
|
|
|
5
5
|
* Application-level configuration.
|
|
6
6
|
*
|
|
7
7
|
* Exported from `electro.config.ts` at the project root.
|
|
8
|
-
* Consumed by the
|
|
8
|
+
* Consumed by the ElectroJS CLI for build, dev, preview, and code generation.
|
|
9
9
|
*/
|
|
10
10
|
interface AppConfig {
|
|
11
11
|
/**
|
|
@@ -27,7 +27,7 @@ interface AppConfig {
|
|
|
27
27
|
* Runtime build configuration.
|
|
28
28
|
*
|
|
29
29
|
* Exported from `runtime.config.ts` inside the runtime package.
|
|
30
|
-
* Extends Vite's `UserConfig` (minus fields
|
|
30
|
+
* Extends Vite's `UserConfig` (minus fields ElectroJS manages) with
|
|
31
31
|
* the Electron main-process–specific `entry` field.
|
|
32
32
|
*
|
|
33
33
|
* Users have full access to: `resolve`, `plugins`, `define`,
|
|
@@ -65,7 +65,7 @@ interface RuntimeConfig extends UserConfig {
|
|
|
65
65
|
* View build configuration.
|
|
66
66
|
*
|
|
67
67
|
* Exported from `view.config.ts` inside each view package.
|
|
68
|
-
* Extends Vite's `UserConfig` (minus fields
|
|
68
|
+
* Extends Vite's `UserConfig` (minus fields ElectroJS manages) with
|
|
69
69
|
* view-specific fields.
|
|
70
70
|
*
|
|
71
71
|
* Users have full access to: `resolve`, `plugins`, `define`,
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@electrojs/config",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.2",
|
|
4
4
|
"description": "Shared configuration presets for Electro",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"config",
|
|
@@ -8,6 +8,7 @@
|
|
|
8
8
|
"tsconfig",
|
|
9
9
|
"typescript"
|
|
10
10
|
],
|
|
11
|
+
"homepage": "https://electrojs.myraxbyte.dev/",
|
|
11
12
|
"license": "MIT",
|
|
12
13
|
"repository": {
|
|
13
14
|
"type": "git",
|