@meteor-vite/plugin-zodern-relay 1.0.0 → 1.0.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 +45 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
# Vite plugin `zodern:relay`
|
|
2
|
+
|
|
3
|
+
This is a Vite compatability package for
|
|
4
|
+
[`zodern:relay`](https://github.com/zodern/meteor-relay#readme) - type safe
|
|
5
|
+
[Meteor](https://meteor.com/) methods and publications.
|
|
6
|
+
|
|
7
|
+
> [!IMPORTANT]
|
|
8
|
+
> This plugin is not yet fully complete. Methods and publications imported by your client will not be omitted from
|
|
9
|
+
> your client bundle like it would when using the `@zodern/babel-plugin-meteor-relay` plugin.
|
|
10
|
+
|
|
11
|
+
This plugin acts as partial replacement for the Babel `@zodern/babel-plugin-meteor-relay` plugin required by
|
|
12
|
+
`zodern:relay`. You still need the Babel plugin as it might still be required on the server.
|
|
13
|
+
|
|
14
|
+
|
|
15
|
+
## Installation
|
|
16
|
+
```sh
|
|
17
|
+
npm i -D @meteor-vite/plugin-zodern-relay
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
## Configuration
|
|
21
|
+
Add the plugin to your Vite config and you're all set. There are no configuration options.
|
|
22
|
+
```ts
|
|
23
|
+
// vite.config.ts
|
|
24
|
+
import zodernRelay from '@meteor-vite/plugin-zodern-relay';
|
|
25
|
+
import { meteor } from 'meteor-vite/plugin';
|
|
26
|
+
|
|
27
|
+
export default defineConfig({
|
|
28
|
+
plugins: [
|
|
29
|
+
meteor({
|
|
30
|
+
clientEntry: '...',
|
|
31
|
+
}),
|
|
32
|
+
zodernRelay(),
|
|
33
|
+
]
|
|
34
|
+
})
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
## Usage & Documentation
|
|
38
|
+
You can use [`zodern:relay`](https://github.com/zodern/meteor-relay#readme) like you normally would. Consult their
|
|
39
|
+
readme for documentation.
|
|
40
|
+
|
|
41
|
+
- `zodern:relay` - https://github.com/zodern/meteor-relay#readme
|
|
42
|
+
- `meteor-vite` - https://github.com/JorgenVatle/meteor-vite#readme
|
|
43
|
+
|
|
44
|
+
## License
|
|
45
|
+
MIT
|