vite-plugin-terminal
Log in the node terminal from the browser
Open a playground online in StackBlitz
Install
npm i -D vite-plugin-terminal
Add plugin to your vite.config.ts:
// vite.config.ts
import Terminal from 'vite-plugin-terminal'
export default {
plugins: [
Terminal()
]
}
Usage
In your source code import terminal, and use it like you do with console.log.
import { terminal } from 'virtual:terminal'
terminal.log('Hey terminal! A message from the browser')
The terminal log calls will be removed when building the app.
API
Supported methods:
terminal.log(obj)terminal.info(obj)terminal.warn(obj)terminal.error(obj)terminal.assert(assertion, obj)
Examples
- Basic - Playground using every available method.
- Auto Import - Use unplugin-auto-import to make
terminalglobal in your app. - Vue - Example of logging to the terminal from a Vue App.
Options
strip
Type: boolean
Default: true
Strip terminal.*() when bundling for production.
include
Type: String | RegExp | Array[...String|RegExp]
Default: /.+\.(js|ts|mjs|cjs|mts|cts)/
Example: include: '**/*.(mjs|js)',
A pattern, or array of patterns, which specify the files in the build the plugin should operate on when removing calls for production.
exclude
Type: String | RegExp | Array[...String|RegExp]
Default: []
Example: exlude: 'tests/**/*',
A pattern, or array of patterns, which specify the files in the build the plugin should ignore when removing calls for production.
Credits
- Original idea from Domenic Elm
- Project setup from @antfu's vite-plugin-inspect
- Bundling by unbuild
- Strip functions during build uses rollup-plugin-strip
Sponsors
License
MIT License © 2022-present Matias Capeletto
