vite-open

Open any file directly in a Vite dev server.

npm i vite-open -g

pnpm add vite-open -g

yarn global add vite-open

CLI

Features

• Zero config, zero setup. Open .js .jsx .ts .tsx .md and .html files directly.
• Vite configured for development, all ESNext features and accurate sourcemaps.
• Strict CORS headers enabling all Web features.
• Compile time pattern-based debugging using rollup-plugin-debug.
• Open files in VSCode by clicking links directly in Chrome DevTools using the open-in-editor Chrome extension (installed separately).
• QR code display with the external address for easy access by phone.

API

# Options

src/index.ts#L27

# constructor()

# new Options()

Options

# debugging  =  ''

src/index.ts#L34

string

# debuggingThis  =  false

src/index.ts#L35

boolean

# file

src/index.ts#L28

string

# https  =  false

src/index.ts#L30

boolean

# jsx  =  'react'

src/index.ts#L31

string

# log  =  defaultLog

src/index.ts#L38

# (args)

# args

unknown []

(args)  =>

void

# noForce  =  false

src/index.ts#L33

boolean

# noOpen  =  false

src/index.ts#L32

boolean

# quiet  =  false

src/index.ts#L36

boolean

# responses  =  {}

src/index.ts#L42

Record<string, {

# content

src/index.ts#L44

string

# fn

src/index.ts#L45

# (server, req, res, next)

# server

ViteDevServer

# req

IncomingMessage

# res

ServerResponse

# next

NextFunction

(server, req, res, next)  =>

void

# type

src/index.ts#L43

string

}>

# root  =  '.'

src/index.ts#L29

string

# virtual  =  {}

src/index.ts#L40

Record<string, any>

# viteOptions  =  {}

src/index.ts#L53

Partial<InlineConfig>

# VirtualModules

src/.fastpm/-/vite-plugin-virtual@0.1.1/dist/index.d.ts#L4

# ViteServer

src/server.ts#L10

# localAddr

src/server.ts#L12

string

# log

src/server.ts#L18

# (args)

# args

unknown []

(args)  =>

void

# networkAddr

src/server.ts#L14

string

# vite

src/server.ts#L16

ViteDevServer

# VirtualModule

src/.fastpm/-/vite-plugin-virtual@0.1.1/dist/index.d.ts#L3

string | object

# virtualPlugin

src/index.ts#L23

any

# invalidateVirtualModule(server, id)

src/.fastpm/-/vite-plugin-virtual@0.1.1/dist/index.d.ts#L7

# server

ViteDevServer

# id

string

invalidateVirtualModule(server, id)  =>

void

# open(options)

src/index.ts#L114

# options

Partial<Options>

open(options)  =>

Promise<ViteServer>

# updateVirtualModule(plugin, id, value)

src/.fastpm/-/vite-plugin-virtual@0.1.1/dist/index.d.ts#L8

# plugin

Plugin

# id

string

# value

VirtualModule

updateVirtualModule(plugin, id, value)  =>

void

Credits

• @babel/core by The Babel Team – Babel compiler core.
• @babel/plugin-proposal-class-properties by The Babel Team – This plugin transforms static class properties as well as properties declared with the property initializer syntax
• @babel/plugin-proposal-decorators by The Babel Team – Compile class and object decorators to ES5
• @babel/plugin-proposal-private-methods by The Babel Team – This plugin transforms private class methods
• @babel/plugin-transform-react-jsx by The Babel Team – Turn JSX into React function calls
• @babel/plugin-transform-typescript by The Babel Team – Transform TypeScript into ES.next
• @stagas/chalk by @stagas – Terminal string styling done right (+ CommonJS build)
• @vitejs/plugin-basic-ssl by Evan You and Vite Contributors
• decarg by stagas – decorator based cli arguments parser
• everyday-node by stagas – Everyday node utilities.
• everyday-utils by stagas – Everyday utilities
• github-markdown-css by Sindre Sorhus – The minimal amount of CSS to replicate the GitHub Markdown style
• open-in-editor-connect by Evgeniy V. Generalov – Open in editor middleware
• qrcode-terminal by gtanner – QRCodes, in the terminal
• rollup-plugin-debug by stagas – Console debug statements that can be pattern toggled at compile time from comments in the code.
• running-at by Maximilian Schiller – Get local and network ip address
• vite by Evan You – Native-ESM powered web dev build tool
• vite-plugin-babel by Miłosz Mandowski – Runs Babel in Vite during all commands
• vite-plugin-markdown by Kengo Hamasaki – Import markdown files in vite
• vite-plugin-virtual by patak-js – Virtual modules with HMR invalidation plugin for Vite

Contributing

Fork or edit and submit a PR.

All contributions are welcome!

License

MIT © 2022 stagas