Skip to content

Commit

Permalink
refactor: rename vike-node into vike-server (#63)
Browse files Browse the repository at this point in the history
  • Loading branch information
magne4000 authored Feb 26, 2025
1 parent 18b578b commit 47f87a5
Show file tree
Hide file tree
Showing 71 changed files with 730 additions and 776 deletions.
3 changes: 2 additions & 1 deletion .npmrc
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
shamefully-hoist=true
shamefully-hoist=true
link-workspace-packages
2 changes: 1 addition & 1 deletion README.md
2 changes: 1 addition & 1 deletion biome.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"$schema": "./node_modules/@biomejs/biome/configuration_schema.json",
"files": {
"ignore": ["dist/", ".vercel/", "package.json", "test/vike-node/build"]
"ignore": ["dist/", ".vercel/", "package.json", "test/vike-server/build"]
},
"formatter": {
"indentWidth": 2,
Expand Down
3 changes: 2 additions & 1 deletion examples/express-react-vercel/api/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@
import app from '../dist/server/index.mjs'

// Web request handlers support streaming by default on Vercel
import { connectToWeb } from 'vike-node'
import { connectToWeb } from 'vike-server'

const handler = connectToWeb(app)
export const GET = handler
export const POST = handler
2 changes: 1 addition & 1 deletion examples/express-react-vercel/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
"react": "^18.3.1",
"react-dom": "^18.3.1",
"vike": "^0.4.219",
"vike-node": "^0.3.7",
"vike-server": "^0.3.7",
"vike-react": "^0.5.7",
"vite": "^5.4.12"
},
Expand Down
8 changes: 4 additions & 4 deletions examples/express-react-vercel/readme.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
Minimal example of using `vike-node` and `vike-react`.
Minimal example of using `vike-server` and `vike-react`.

```bash
git clone [email protected]:vikejs/vike-node
cd vike-node/examples/express-react-vercel/
git clone [email protected]:vikejs/vike-server
cd vike-server/examples/express-react-vercel/
npm install
npm run dev
```
Expand All @@ -11,4 +11,4 @@ npm run dev

Deploy the example using [Vercel](https://vercel.com):

[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https://github.com/vikejs/vike-node/tree/main/examples/express-react-vercel&project-name=express-react&repository-name=express-react)
[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https://github.com/vikejs/vike-server/tree/main/examples/express-react-vercel&project-name=express-react&repository-name=express-react)
2 changes: 1 addition & 1 deletion examples/express-react-vercel/server/index.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import express from 'express'
import vike from 'vike-node/express'
import vike from 'vike-server/express'

export default startServer()

Expand Down
2 changes: 1 addition & 1 deletion examples/express-react-vercel/vite.config.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import react from '@vitejs/plugin-react'
import vike from 'vike/plugin'
import vikeNode from 'vike-node/plugin'
import vikeNode from 'vike-server/plugin'

export default {
plugins: [react(), vike({ prerender: true }), vikeNode('server/index.js')]
Expand Down
2 changes: 1 addition & 1 deletion examples/express-react/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
"react": "^18.3.1",
"react-dom": "^18.3.1",
"vike": "^0.4.219",
"vike-node": "^0.3.7",
"vike-server": "^0.3.7",
"vike-react": "^0.5.7",
"vite": "^5.4.12"
},
Expand Down
6 changes: 3 additions & 3 deletions examples/express-react/readme.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
Minimal example of using `vike-node` and `vike-react`.
Minimal example of using `vike-server` and `vike-react`.

```bash
git clone [email protected]:vikejs/vike-node
cd vike-node/examples/express-react/
git clone [email protected]:vikejs/vike-server
cd vike-server/examples/express-react/
npm install
npm run dev
```
2 changes: 1 addition & 1 deletion examples/express-react/server/index.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import express from 'express'
import vike from 'vike-node/express'
import vike from 'vike-server/express'

startServer()

Expand Down
2 changes: 1 addition & 1 deletion examples/express-react/vite.config.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import react from '@vitejs/plugin-react'
import vike from 'vike/plugin'
import vikeNode from 'vike-node/plugin'
import vikeNode from 'vike-server/plugin'

export default {
plugins: [react(), vike(), vikeNode('server/index.js')]
Expand Down
2 changes: 1 addition & 1 deletion examples/hono-react-cf-pages/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
"react": "^18.3.1",
"react-dom": "^18.3.1",
"vike": "^0.4.219",
"vike-node": "^0.3.7",
"vike-server": "^0.3.7",
"vike-react": "^0.5.7",
"vite": "^5.4.12"
},
Expand Down
8 changes: 4 additions & 4 deletions examples/hono-react-cf-pages/readme.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
Minimal example of using `vike-node` and `vike-react`.
Minimal example of using `vike-server` and `vike-react`.

```bash
git clone [email protected]:vikejs/vike-node
cd vike-node/examples/hono-react-cf-pages/
git clone [email protected]:vikejs/vike-server
cd vike-server/examples/hono-react-cf-pages/
npm install
npm run dev
```
```
5 changes: 3 additions & 2 deletions examples/hono-react-cf-pages/server/app.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import { Hono } from 'hono'
import vike from 'vike-node/hono'
import { telefunc, config } from 'telefunc'
import vike from 'vike-server/hono'
import { config, telefunc } from 'telefunc'

config.disableNamingConvention = true

const app = new Hono()
Expand Down
2 changes: 1 addition & 1 deletion examples/hono-react-cf-pages/vite.config.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import react from '@vitejs/plugin-react'
import { telefunc } from 'telefunc/vite'
import vikeNode from 'vike-node/plugin'
import vikeNode from 'vike-server/plugin'
import vike from 'vike/plugin'

export default {
Expand Down
2 changes: 1 addition & 1 deletion examples/hono-react-vercel-edge/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
"react": "^18.3.1",
"react-dom": "^18.3.1",
"vike": "^0.4.219",
"vike-node": "^0.3.7",
"vike-server": "^0.3.7",
"vike-react": "^0.5.7",
"vite": "^5.4.12",
"telefunc": "^0.1.76"
Expand Down
8 changes: 4 additions & 4 deletions examples/hono-react-vercel-edge/readme.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
Minimal example of using `vike-node` and `vike-react`.
Minimal example of using `vike-server` and `vike-react`.

```bash
git clone [email protected]:vikejs/vike-node
cd vike-node/examples/hono-react-vercel-edge/
git clone [email protected]:vikejs/vike-server
cd vike-server/examples/hono-react-vercel-edge/
npm install
npm run dev
```
Expand All @@ -11,4 +11,4 @@ npm run dev

Deploy the example using [Vercel](https://vercel.com):

[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https://github.com/vikejs/vike-node/tree/main/examples/hono-react-vercel-edge&project-name=hono-react&repository-name=hono-react)
[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https://github.com/vikejs/vike-server/tree/main/examples/hono-react-vercel-edge&project-name=hono-react&repository-name=hono-react)
5 changes: 3 additions & 2 deletions examples/hono-react-vercel-edge/server/app.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import { Hono } from 'hono'
import vike from 'vike-node/hono'
import { telefunc, config } from 'telefunc'
import vike from 'vike-server/hono'
import { config, telefunc } from 'telefunc'

config.disableNamingConvention = true

const app = new Hono()
Expand Down
2 changes: 1 addition & 1 deletion examples/hono-react-vercel-edge/vite.config.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import react from '@vitejs/plugin-react'
import { telefunc } from 'telefunc/vite'
import vikeNode from 'vike-node/plugin'
import vikeNode from 'vike-server/plugin'
import vike from 'vike/plugin'

export default {
Expand Down
11 changes: 5 additions & 6 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
{
"scripts": {
"========= Basics": "",
"dev": "cd ./packages/vike-node/ && pnpm run dev",
"dev": "cd ./packages/vike-server/ && pnpm run dev",
"build": "pnpm --recursive --filter {packages/*} run build",
"========= Test": "",
"test": "test-e2e && test-types",
"========= Release": "",
"release": "cd ./packages/vike-node/ && pnpm run release",
"release:minor": "cd ./packages/vike-node/ && pnpm run release:minor",
"release:major": "cd ./packages/vike-node/ && pnpm run release:major",
"release:commit": "cd ./packages/vike-node/ && pnpm run release:commit",
"release": "cd ./packages/vike-server/ && pnpm run release",
"release:minor": "cd ./packages/vike-server/ && pnpm run release:minor",
"release:major": "cd ./packages/vike-server/ && pnpm run release:major",
"release:commit": "cd ./packages/vike-server/ && pnpm run release:commit",
"========= Clean": "",
"reset": "git clean -Xdf && pnpm install && pnpm run build",
"========= Formatting": "",
Expand All @@ -28,7 +28,6 @@
},
"pnpm": {
"overrides": {
"vike-node": "link:./packages/vike-node/",
"esbuild": "^0.24.0"
}
},
Expand Down
File renamed without changes.
40 changes: 20 additions & 20 deletions packages/vike-node/README.md → packages/vike-server/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
<!-- WARNING: keep links absolute in this file so they work on NPM too -->

[![npm version](https://img.shields.io/npm/v/vike-node)](https://www.npmjs.com/package/vike-node)
[![npm version](https://img.shields.io/npm/v/vike-server)](https://www.npmjs.com/package/vike-server)

# `vike-node`
# `vike-server`

> [!WARNING]
> This package is in **beta** and will have relatively frequent breaking changes.
Expand All @@ -17,7 +17,7 @@ In development, the server process is restarted when a change is detected.
[Custom `pageContext`](#custom-pagecontext)
[Standalone build](#standalone-build)
[Compression](#compression)
[Version history](https://github.com/vikejs/vike-node/blob/main/CHANGELOG.md)
[Version history](https://github.com/vikejs/vike-server/blob/main/CHANGELOG.md)

<br/>

Expand All @@ -30,18 +30,18 @@ In development, the server process is restarted when a change is detected.

### Overview

Example of adding `vike-node` and Express.js to a Vike app that doesn't use a server yet.
Example of adding `vike-server` and Express.js to a Vike app that doesn't use a server yet.

> [!NOTE]
> - See [Add to existing server](#add-to-existing-server) if you already have a server.
> - See [Supported servers](#supported-servers) for installing `vike-node` with a server other than Express.js.
> - See [Supported servers](#supported-servers) for installing `vike-server` with a server other than Express.js.
1. `npm install vike-node express`
1. `npm install vike-server express`
1. Extend `vite.config.js`:
```js
// vite.config.js

import vikeNode from 'vike-node/plugin'
import vikeNode from 'vike-server/plugin'

export default {
// ...
Expand All @@ -53,7 +53,7 @@ Example of adding `vike-node` and Express.js to a Vike app that doesn't use a se
// server/index.js

import express from 'express'
import vike from 'vike-node/express'
import vike from 'vike-server/express'

startServer()

Expand Down Expand Up @@ -83,7 +83,7 @@ If you already have a server:
// server/index.js

- import { renderPage } from 'vike/server'
+ import vike from 'vike-node/express'
+ import vike from 'vike-server/express'

- if (isProduction) {
- app.use(express.static(`${root}/dist/client`))
Expand Down Expand Up @@ -131,7 +131,7 @@ If you already have a server:

### Supported servers

`vike-node` includes middlewares for all commonly used server frameworks.
`vike-server` includes middlewares for all commonly used server frameworks.

- [Express](#express)
- [Fastify](#fastify)
Expand All @@ -147,7 +147,7 @@ If you already have a server:
// server/index.js

import express from 'express'
import vike from 'vike-node/express'
import vike from 'vike-server/express'

startServer()

Expand All @@ -165,7 +165,7 @@ function startServer() {
// server/index.js

import fastify from 'fastify'
import vike from 'vike-node/fastify'
import vike from 'vike-server/fastify'

startServer()

Expand All @@ -184,7 +184,7 @@ function startServer() {

import { serve } from '@hono/node-server'
import { Hono } from 'hono'
import vike from 'vike-node/hono'
import vike from 'vike-server/hono'

startServer()

Expand All @@ -209,7 +209,7 @@ function startServer() {

import { createApp, toNodeListener } from 'h3'
import { createServer } from 'http'
import vike from 'vike-node/h3'
import vike from 'vike-server/h3'

startServer()

Expand All @@ -230,7 +230,7 @@ async function startServer() {
// server/index.js

import { Elysia } from 'elysia'
import vike from 'vike-node/elysia'
import vike from 'vike-server/elysia'

startServer()

Expand All @@ -249,7 +249,7 @@ function startServer() {
You can define custom [pageContext](https://vike.dev/pageContext) properties:

```ts
import { type RuntimeAdapter } from 'vike-node/express';
import { type RuntimeAdapter } from 'vike-server/express';

app.use(
vike({
Expand All @@ -263,7 +263,7 @@ app.use(
```

> [!NOTE]
> See [`RuntimeAdapter`](https://universal-middleware.dev/reference/runtime-adapter) (`vike-node` uses [universal-middleware](https://universal-middleware.dev/) under the hood).
> See [`RuntimeAdapter`](https://universal-middleware.dev/reference/runtime-adapter) (`vike-server` uses [universal-middleware](https://universal-middleware.dev/) under the hood).
> [!NOTE]
> The `runtime` object is also available at `pageContext.runtime` so that, even without the custom `pageContext` function above,
Expand All @@ -278,7 +278,7 @@ With `standalone: true`, the build output directory ([`dist/`](https://vite.dev/
```js
// vite.config.js

import vikeNode from 'vike-node/plugin'
import vikeNode from 'vike-server/plugin'

export default {
plugins: [
Expand Down Expand Up @@ -318,14 +318,14 @@ If an npm package uses native binaries / custom assets then it needs to be added
### `esbuild`

`vike-node` uses [esbuild](https://esbuild.github.io) for bundling server code; you can use `standalone.esbuild` to set esbuild options.
`vike-server` uses [esbuild](https://esbuild.github.io) for bundling server code; you can use `standalone.esbuild` to set esbuild options.

<br/>


## Compression

In production, `vike-node` compresses all Vike responses.
In production, `vike-server` compresses all Vike responses.

You can disable it:

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "vike-node",
"name": "vike-server",
"version": "0.3.7",
"type": "module",
"main": "./dist/index.js",
Expand Down Expand Up @@ -113,6 +113,6 @@
"files": [
"dist/"
],
"repository": "github:vikejs/vike-node",
"repository": "github:vikejs/vike-server",
"license": "MIT"
}
File renamed without changes.
File renamed without changes.
Loading

0 comments on commit 47f87a5

Please sign in to comment.