npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

vite-plugin-terminal

v1.2.0

Published

Log in the node terminal from the browser

Downloads

9,339

Readme

vite-plugin-terminal

NPM version

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.

Types

There are two ways of telling typescript about the types of the virtual import:

  • In your global.d.ts file add the following line:

    /// <reference types="vite-plugin-terminal/client" />
  • In your tsconfig.json add the following to your compilerOptions.types array:

    {
      // ...
      "compilerOptions": {
        // ...
        "types": [
          "vite-plugin-terminal/client"
        ],
      },
    }

API

Supported methods:

  • terminal.log(obj1 [, obj2, ..., objN])
  • terminal.info(obj1 [, obj2, ..., objN])
  • terminal.warn(obj1 [, obj2, ..., objN])
  • terminal.error(obj1 [, obj2, ..., objN])
  • terminal.assert(assertion, obj1 [, obj2, ..., objN])
  • terminal.group()
  • terminal.groupCollapsed()
  • terminal.groupEnd()
  • terminal.table(obj)
  • terminal.time(id)
  • terminal.timeLog(id, obj1 [, obj2, ..., objN])
  • terminal.timeEnd(id)
  • terminal.clear()
  • terminal.count(label)
  • terminal.countReset(label)
  • terminal.dir(obj)
  • terminal.dirxml(obj)

These methods will work but use the console

  • terminal.trace(...args: any[])
  • terminal.profile(...args: any[])
  • terminal.profileEnd(...args: any[])

Redirect console logs to the terminal

If you want the standard console logs to appear in the terminal, you can use the console: 'terminal' option in your vite.config.ts:

// vite.config.ts
import Terminal from 'vite-plugin-terminal'

export default {
  plugins: [
    Terminal({
      console: 'terminal'
    })
  ]
}

In this case, you don't need to import the virtual terminal to use the plugin.

console.log('Hey terminal! A message from the browser')

You can also overwrite it in your index.html head manually in case you would like more control.

  <script type="module">
    // Redirect console logs to the terminal
    import terminal from 'virtual:terminal'
    globalThis.console = terminal
  </script>

Check the Console playground for a full example.

Log in both the terminal and the console

You can use the output option to define where the terminal logs should be logged. Accepts terminal, console, or an array with both.

// vite.config.ts
import Terminal from 'vite-plugin-terminal'

export default {
  plugins: [
    Terminal({
      output: ['terminal', 'console']
    })
  ]
}

Examples

  • Basic - Playground using every available method.
  • Console - Redirect standard console logs to the terminal.
  • Auto Import - Use unplugin-auto-import to make terminal global in your app.
  • Vue - Example of logging to the terminal from a Vue App.

Options

console

Type: 'terminal' | undefined Default: undefined

Set to 'terminal' to make globalThis.console equal to the terminal object in your app.

output

Type: 'terminal' | 'console' | ['terminal', 'console'] Default: terminal

Define where the output for the logs.

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

Sponsors

License

MIT License © 2022-present Matias Capeletto