fix: deprecate sideEffects options

1. always treat as sideEffects now 2. dont skip build when options is same as before
hemengke1997 · Oct 30, 2023 · 4caaa45 · 4caaa45
1 parent faabab8
commit 4caaa45
Show file tree

Hide file tree

Showing 4 changed files with 20 additions and 10 deletions.
diff --git a/playground/spa-file-mode/src/App.tsx b/playground/spa-file-mode/src/App.tsx
@@ -32,7 +32,7 @@ function App() {
 
   return (
     <div className='App'>
-      <h3 id='temp'>以下都是 vite-plugin-public-typescript 插件编译后，通过 manifest.json 文件获取的：</h3>
+      <h3 id='temp'>以下都是 vite-plugin-public-typescript 插件编译后生成的js文件：</h3>
       <div className={'manifest'}>{formatManifst()}</div>
       <br />
       {content}

diff --git a/playground/spa/src/App.tsx b/playground/spa/src/App.tsx
@@ -39,7 +39,7 @@ function App() {
 
   return (
     <div className='App'>
-      <h3 id='temp'>以下都是 vite-plugin-public-typescript 插件编译后，通过 manifest.json 文件获取的：</h3>
+      <h3 id='temp'>以下都是 vite-plugin-public-typescript 插件编译后生成的js文件：</h3>
       <div className={'manifest'}>{formatManifst()}</div>
       <br />
       {content}

diff --git a/src/node/helper/utils.ts b/src/node/helper/utils.ts
@@ -2,6 +2,7 @@ import createDebug from 'debug'
 import fs from 'fs-extra'
 import { createHash } from 'node:crypto'
 import path from 'node:path'
+import colors from 'picocolors'
 import glob from 'tiny-glob'
 import { type ResolvedConfig, createLogger, normalizePath } from 'vite'
 import { type VPPTPluginOptions } from '..'
@@ -15,7 +16,7 @@ const debug = createDebug('vite-plugin-public-typescript:util ===> ')
 
 type PartialExclude<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>
 
-export type OptionsTypeWithDefault = PartialExclude<Required<VPPTPluginOptions>, 'base'>
+export type OptionsTypeWithDefault = PartialExclude<Required<VPPTPluginOptions>, 'base' | 'sideEffects'>
 
 export { pkgName }
 
@@ -178,6 +179,16 @@ export function validateOptions(options: OptionsTypeWithDefault) {
     // remove last slash
     options.inputDir = inputDir.replace(/\/$/, '')
   }
+
+  if (options.sideEffects !== undefined) {
+    console.warn(
+      colors.yellow(
+        `${colors.bold('(warning!)')} [${pkgName}]: sideEffects option is ${colors.bold(
+          'deprecated',
+        )}, please remove it`,
+      ),
+    )
+  }
 }
 
 // remove slash at the start and end of path

diff --git a/src/node/index.ts b/src/node/index.ts
@@ -10,7 +10,6 @@ import { reloadPage } from './helper/server'
 import {
   _isPublicTypescript,
   type OptionsTypeWithDefault,
-  eq,
   findAllOldJsFile,
   isEmptyObject,
   isManifestFile,
@@ -68,6 +67,7 @@ export interface VPPTPluginOptions {
    * @description treat `input` as sideEffect or not
    * @see https://esbuild.github.io/api/#tree-shaking-and-side-effects
    * @default true
+   * @deprecated in v2.0.0. always treat as sideEffect now
    */
   sideEffects?: boolean
   /**
@@ -97,11 +97,10 @@ export const DEFAULT_OPTIONS: OptionsTypeWithDefault = {
   inputDir: 'public-typescript',
   manifestName: 'manifest',
   outputDir: '/',
-  sideEffects: true,
   cacheDir: 'node_modules/.vite-plugin-public-typescript',
 }
 
-let previousOpts: VPPTPluginOptions
+// let previousOpts: VPPTPluginOptions
 
 export default function publicTypescript(options: VPPTPluginOptions = {}) {
   const opts = {
@@ -133,11 +132,11 @@ export default function publicTypescript(options: VPPTPluginOptions = {}) {
       },
       async buildStart() {
         // skip server restart when options not changed
-        if (eq(previousOpts, opts)) {
-          return
-        }
+        // if (eq(previousOpts, opts)) {
+        //   return
+        // }
 
-        previousOpts = opts
+        // previousOpts = opts
 
         const manifestPath = manifestCache.manifestPath