-
Notifications
You must be signed in to change notification settings - Fork 2.4k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(vite): add a preview-server executor for Vite
- Loading branch information
Showing
13 changed files
with
447 additions
and
36 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
55 changes: 55 additions & 0 deletions
55
docs/generated/packages/vite/executors/preview-server.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,55 @@ | ||
| { | ||
| "name": "preview-server", | ||
| "implementation": "/packages/vite/src/executors/preview-server/preview-server.impl.ts", | ||
| "schema": { | ||
| "$schema": "http://json-schema.org/schema", | ||
| "version": 2, | ||
| "cli": "nx", | ||
| "title": "Vite Preview Server", | ||
| "description": "Preview Server for Vite.", | ||
| "type": "object", | ||
| "presets": [ | ||
| { "name": "Default minimum setup", "keys": ["buildTarget"] }, | ||
| { "name": "Using a Different Port", "keys": ["buildTarget", "port"] } | ||
| ], | ||
| "properties": { | ||
| "buildTarget": { | ||
| "type": "string", | ||
| "description": "Target which builds the application." | ||
| }, | ||
| "proxyConfig": { | ||
| "type": "string", | ||
| "description": "Path to the proxy configuration file.", | ||
| "x-completion-type": "file" | ||
| }, | ||
| "port": { "type": "number", "description": "Port to listen on." }, | ||
| "host": { | ||
| "description": "Specify which IP addresses the server should listen on.", | ||
| "oneOf": [{ "type": "boolean" }, { "type": "string" }] | ||
| } | ||
| }, | ||
| "https": { "type": "boolean", "description": "Serve using HTTPS." }, | ||
| "open": { | ||
| "description": "Automatically open the app in the browser on server start. When the value is a string, it will be used as the URL's pathname.", | ||
| "oneOf": [{ "type": "boolean" }, { "type": "string" }] | ||
| }, | ||
| "logLevel": { | ||
| "type": "string", | ||
| "description": "Adjust console output verbosity.", | ||
| "enum": ["info", "warn", "error", "silent"] | ||
| }, | ||
| "mode": { "type": "string", "description": "Mode to run the server in." }, | ||
| "clearScreen": { | ||
| "description": "Set to false to prevent Vite from clearing the terminal screen when logging certain messages.", | ||
| "type": "boolean" | ||
| }, | ||
| "definitions": {}, | ||
| "required": ["buildTarget"], | ||
| "examplesFile": "`project.json`:\n\n```json\n//...\n\"my-app\": {\n \"targets\": {\n //...\n \"preview\": {\n \"executor\": \"@nrwl/vite:preview-server\",\n \"defaultConfiguration\": \"development\",\n \"options\": {\n \"buildTarget\": \"my-app:build\",\n },\n \"configurations\": {\n ...\n }\n },\n }\n}\n```\n\n```bash\nnx preview my-app\n```\n\n## Examples\n\n{% tabs %}\n{% tab label=\"Set up a custom port\" %}\n\nYou can always set the port in your `vite.config.ts` file. However, you can also set it directly in your `project.json` file, in the `preview` target options:\n\n```json\n//...\n\"my-app\": {\n \"targets\": {\n //...\n \"preview\": {\n \"executor\": \"@nrwl/vite:preview-server\",\n \"defaultConfiguration\": \"development\",\n \"options\": {\n \"buildTarget\": \"my-app:build\",\n \"port\": 4200,\n },\n \"configurations\": {\n ...\n }\n },\n }\n}\n```\n\n{% /tab %}\n{% tab label=\"Specify a proxyConfig\" %}\n\nYou can specify a proxy config by pointing to the path of your proxy configuration file:\n\n```json\n//...\n\"my-app\": {\n \"targets\": {\n //...\n \"preview\": {\n \"executor\": \"@nrwl/vite:preview-server\",\n \"defaultConfiguration\": \"development\",\n \"options\": {\n \"buildTarget\": \"my-app:build\",\n \"proxyConfig\": \"apps/my-app/proxy.conf.json\"\n },\n \"configurations\": {\n ...\n }\n },\n }\n}\n```\n\n{% /tab %}\n\n{% /tabs %}\n" | ||
| }, | ||
| "description": "Vite preview server", | ||
| "aliases": [], | ||
| "hidden": false, | ||
| "path": "/packages/vite/src/executors/preview-server/schema.json", | ||
| "type": "executor" | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,80 @@ | ||
| `project.json`: | ||
|
|
||
| ```json | ||
| //... | ||
| "my-app": { | ||
| "targets": { | ||
| //... | ||
| "preview": { | ||
| "executor": "@nrwl/vite:preview-server", | ||
| "defaultConfiguration": "development", | ||
| "options": { | ||
| "buildTarget": "my-app:build", | ||
| }, | ||
| "configurations": { | ||
| ... | ||
| } | ||
| }, | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| ```bash | ||
| nx preview my-app | ||
| ``` | ||
|
|
||
| ## Examples | ||
|
|
||
| {% tabs %} | ||
| {% tab label="Set up a custom port" %} | ||
|
|
||
| You can always set the port in your `vite.config.ts` file. However, you can also set it directly in your `project.json` file, in the `preview` target options: | ||
|
|
||
| ```json | ||
| //... | ||
| "my-app": { | ||
| "targets": { | ||
| //... | ||
| "preview": { | ||
| "executor": "@nrwl/vite:preview-server", | ||
| "defaultConfiguration": "development", | ||
| "options": { | ||
| "buildTarget": "my-app:build", | ||
| "port": 4200, | ||
| }, | ||
| "configurations": { | ||
| ... | ||
| } | ||
| }, | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| {% /tab %} | ||
| {% tab label="Specify a proxyConfig" %} | ||
|
|
||
| You can specify a proxy config by pointing to the path of your proxy configuration file: | ||
|
|
||
| ```json | ||
| //... | ||
| "my-app": { | ||
| "targets": { | ||
| //... | ||
| "preview": { | ||
| "executor": "@nrwl/vite:preview-server", | ||
| "defaultConfiguration": "development", | ||
| "options": { | ||
| "buildTarget": "my-app:build", | ||
| "proxyConfig": "apps/my-app/proxy.conf.json" | ||
| }, | ||
| "configurations": { | ||
| ... | ||
| } | ||
| }, | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| {% /tab %} | ||
|
|
||
| {% /tabs %} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| import { convertNxExecutor } from '@nrwl/devkit'; | ||
| import vitePreviewServerExecutor from './preview-server.impl'; | ||
|
|
||
| export default convertNxExecutor(vitePreviewServerExecutor); |
88 changes: 88 additions & 0 deletions
88
packages/vite/src/executors/preview-server/preview-server.impl.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,88 @@ | ||
| import { ExecutorContext, parseTargetString, runExecutor } from '@nrwl/devkit'; | ||
| import { InlineConfig, mergeConfig, preview } from 'vite'; | ||
| import { | ||
| getNxTargetOptions, | ||
| getViteSharedConfig, | ||
| getViteBuildOptions, | ||
| getVitePreviewOptions, | ||
| } from '../../utils/options-utils'; | ||
| import { ViteBuildExecutorOptions } from '../build/schema'; | ||
| import { VitePreviewServerExecutorOptions } from './schema'; | ||
|
|
||
| export default async function* vitePreviewServerExecutor( | ||
| options: VitePreviewServerExecutorOptions, | ||
| context: ExecutorContext | ||
| ) { | ||
| // Retrieve the option for the configured buildTarget. | ||
| const buildTargetOptions: ViteBuildExecutorOptions = getNxTargetOptions( | ||
| options.buildTarget, | ||
| context | ||
| ); | ||
|
|
||
| // Merge the options from the build and preview-serve targets. | ||
| // The latter takes precedence. | ||
| const mergedOptions = { | ||
| ...buildTargetOptions, | ||
| ...options, | ||
| }; | ||
|
|
||
| // Launch the build target. | ||
| const target = parseTargetString(options.buildTarget, context.projectGraph); | ||
| const build = await runExecutor(target, mergedOptions, context); | ||
| for await (const result of build) { | ||
| if (!result.success) { | ||
| return result; | ||
| } | ||
| } | ||
|
|
||
| // Launch the server. | ||
| const serverConfig: InlineConfig = mergeConfig( | ||
| getViteSharedConfig(mergedOptions, options.clearScreen, context), | ||
| { | ||
| build: getViteBuildOptions(mergedOptions, context), | ||
| preview: getVitePreviewOptions(mergedOptions, context), | ||
| } | ||
| ); | ||
|
|
||
| if (serverConfig.mode === 'production') { | ||
| console.warn('WARNING: preview is not meant to be run in production!'); | ||
| } | ||
|
|
||
| try { | ||
| const server = await preview(serverConfig); | ||
| server.printUrls(); | ||
|
|
||
| const processOnExit = async () => { | ||
| const { httpServer } = server; | ||
| // closeAllConnections was added in Node v18.2.0 | ||
| httpServer.closeAllConnections && httpServer.closeAllConnections(); | ||
| httpServer.close(() => { | ||
| process.off('SIGINT', processOnExit); | ||
| process.off('SIGTERM', processOnExit); | ||
| process.off('exit', processOnExit); | ||
| }); | ||
| }; | ||
|
|
||
| process.on('SIGINT', processOnExit); | ||
| process.on('SIGTERM', processOnExit); | ||
| process.on('exit', processOnExit); | ||
|
|
||
| const resolvedUrls = [ | ||
| ...server.resolvedUrls.local, | ||
| ...server.resolvedUrls.network, | ||
| ]; | ||
|
|
||
| yield { | ||
| success: true, | ||
| baseUrl: resolvedUrls[0] ?? '', | ||
| }; | ||
| } catch (e) { | ||
| console.error(e); | ||
| yield { | ||
| success: false, | ||
| baseUrl: '', | ||
| }; | ||
| } | ||
|
|
||
| await new Promise(() => {}); | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| export interface VitePreviewServerExecutorOptions { | ||
| buildTarget: string; | ||
| proxyConfig?: string; | ||
| port?: number; | ||
| host?: string | boolean; | ||
| https?: boolean; | ||
| open?: string | boolean; | ||
| logLevel?: 'info' | 'warn' | 'error' | 'silent'; | ||
| mode?: string; | ||
| clearScreen?: boolean; | ||
| } |
Oops, something went wrong.