add note to README about avoiding plugin execution on build

Open Beginner friendly
#116 1 comment 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
90/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Active
Tech stack
javascript, typescript
Domain
documentation

Research direction

Start with README and find the plugin configuration example or setup guidance. Add the provided Vite apply: 'serve' example and explanation, then verify that the note clearly shows how to prevent the plugin from running during production builds.

Written by the indexing model from the issue text.

Description

The @vitejs/plugin-basic-ssl plugin is only needed for local development. However, if added normally to vite.config.js.

Please add a quick note to the README showing users how to stop this by using Vite's apply: 'serve' property.

import { defineConfig } from 'vite';
import basicSsl from '@vitejs/plugin-basic-ssl';

export default defineConfig({
  plugins: [
    {
      ...basicSsl(),
      apply: 'serve' // Prevents running during production builds
    }
  ]
});
Dominant language
TypeScript
Stars
517
Forks
27
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from vitejs/vite-plugin-basic-ssl

All issues in vitejs/vite-plugin-basic-ssl

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.