refactor: enhance readability

1. update migration 2. fix virtual client manifest
hemengke1997 · Oct 31, 2023 · ce99781 · ce99781
1 parent 3717075
commit ce99781
Show file tree

Hide file tree

Showing 18 changed files with 95 additions and 50 deletions.
diff --git a/migration-v2.0.0.md b/migration-v2.0.0.md
@@ -1,5 +1,13 @@
 # v2.0.0 升级指南
 
+
+## 新功能
+
+- 支持自定义base，默认取vite config 中的 base
+- 支持 cacheDir，默认 `node_modules/.vite-plugin-public-typescript`。如果是非vite项目，可以指定为跟 `inputDir` 同名
+
+**喜大普奔，再也不用看到manifest.json文件啦～**
+
 ## vite项目
 
 1. 删除manifest.json文件

diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/src/node/global-config/GlobalConfigBuilder.ts b/src/node/global-config/GlobalConfigBuilder.ts
@@ -18,14 +18,20 @@ export type GlobalConfig<T extends CacheValue = CacheValue> = UserConfig<T> & {
 }
 
 export class GlobalConfigBuilder<T extends CacheValue = CacheValue> {
+  private _inited = false
   private _globalConfig: GlobalConfig<T>
 
   constructor() {
     this._globalConfig = {} as GlobalConfig<T>
   }
 
   init(c: UserConfig<T>) {
-    const root = c.viteConfig.root || process.cwd()
+    if (this._inited) {
+      // only initialize once
+      return this
+    }
+
+    const root = c.viteConfig?.root || process.cwd()
     const absOutputDir = path.join(root, c.outputDir)
     const absInputDir = path.join(root, c.inputDir)
 
@@ -35,18 +41,30 @@ export class GlobalConfigBuilder<T extends CacheValue = CacheValue> {
       absOutputDir,
     }
 
+    this._inited = true
+
     return this
   }
 
-  get() {
-    return this._globalConfig
+  test<Path extends keyof GlobalConfig<T> | readonly string[]>(path: Path) {
+    return path as any
   }
 
-  set(c: UserConfig<T>) {
-    this._globalConfig = {
-      ...this.get(),
-      ...c,
+  get<Selected extends keyof GlobalConfig<T>>(keys: Selected[]): Pick<GlobalConfig<T>, Selected>
+  get<Selected extends keyof GlobalConfig<T>>(key: Selected): GlobalConfig<T>[Selected]
+  get<Selected extends keyof GlobalConfig<T>>(key: any): any {
+    const result = {} as Pick<GlobalConfig<T>, Selected>
+    if (Array.isArray(key)) {
+      ;(key as Selected[]).forEach((k) => {
+        result[k] = this._globalConfig[k]
+      })
+      return result
+    } else {
+      return this._globalConfig[key as Selected]
     }
-    return this
+  }
+
+  get all() {
+    return this._globalConfig
   }
 }
diff --git a/src/node/helper/build.ts b/src/node/helper/build.ts
@@ -100,7 +100,7 @@ export async function esbuildTypescript(buildOptions: IBuildOptions) {
 
 export async function build(options: { filePath: string }, onBuildEnd?: BaseCacheProcessor['onTsBuildEnd']) {
   const { filePath } = options
-  const getGlobalConfig = globalConfig.get()
+  const getGlobalConfig = globalConfig.all
 
   const originFileName = path.basename(filePath, path.extname(filePath))
 
@@ -114,7 +114,7 @@ export async function build(options: { filePath: string }, onBuildEnd?: BaseCach
     compiledFileName = `${originFileName}.${contentHash}`
   }
 
-  debug('before onBuildEnd manifest-cache:', getGlobalConfig.manifestCache.get())
+  debug('before onBuildEnd manifest-cache:', getGlobalConfig.manifestCache.all)
 
   await onBuildEnd?.(
     {
@@ -125,11 +125,11 @@ export async function build(options: { filePath: string }, onBuildEnd?: BaseCach
     { code, contentHash, originFileName, silent: false },
   )
 
-  debug('after onBuildEnd manifest-cache:', getGlobalConfig.manifestCache.get())
+  debug('after onBuildEnd manifest-cache:', getGlobalConfig.manifestCache.all)
 }
 
 export async function buildAllOnce(tsFilesGlob: string[]) {
-  const { cacheProcessor } = globalConfig.get()
+  const cacheProcessor = globalConfig.get('cacheProcessor')
 
   const toBuildList: (() => Promise<void>)[] = []
 

diff --git a/src/node/helper/file-watcher.ts b/src/node/helper/file-watcher.ts
@@ -13,15 +13,15 @@ export async function handleUnlink(filePath: string, cb?: () => void) {
   if (_isPublicTypescript(filePath)) {
     const fileName = path.parse(filePath).name
     debug('unlink:', fileName)
-    await globalConfig.get().cacheProcessor.deleteOldJs({ originFileName: fileName })
+    await globalConfig.get('cacheProcessor').deleteOldJs({ originFileName: fileName })
     cb?.()
   }
 }
 
 export async function handleFileAdded(filePath: string, cb?: () => void) {
   if (_isPublicTypescript(filePath)) {
     debug('file added:', filePath)
-    await build({ filePath }, (...args) => globalConfig.get().cacheProcessor.onTsBuildEnd(...args))
+    await build({ filePath }, (...args) => globalConfig.get('cacheProcessor').onTsBuildEnd(...args))
     cb?.()
   }
 }
@@ -41,7 +41,7 @@ async function handleFileChange(filePath: string, cb?: () => void) {
 
 export function initWatcher(cb: (file: HmrFile) => void) {
   try {
-    const watcher = new Watcher(globalConfig.get().absInputDir, {
+    const watcher = new Watcher(globalConfig.get('absInputDir'), {
       debounce: 0,
       ignoreInitial: true,
       recursive: true,

diff --git a/src/node/helper/io.ts b/src/node/helper/io.ts
@@ -44,7 +44,7 @@ export function writeFile(filename: string, content: string, hash = true): void
 
   if (fs.existsSync(filename)) {
     if (hash) {
-      const _hash = globalConfig.get().hash
+      const _hash = globalConfig.get('hash')
       if (extractHashFromFileName(filename, _hash)) {
         // if filename has hash, skip write file
         debug('skip writeFile, filename has hash')

diff --git a/src/node/helper/server.ts b/src/node/helper/server.ts
@@ -12,7 +12,7 @@ export type HmrFile = {
   event: string
 }
 export function reloadPage(ws: WebSocketServer, file: HmrFile) {
-  const { logger } = globalConfig.get()
+  const logger = globalConfig.get('logger')
 
   if (!isInTest()) {
     logger.info(

diff --git a/src/node/helper/utils.ts b/src/node/helper/utils.ts
@@ -28,7 +28,7 @@ export function createInternalLogger(allowClearScreen?: boolean) {
 }
 
 export function fileRelativeRootPath(filePath: string) {
-  return normalizePath(`/${path.relative(globalConfig.get().viteConfig.root, filePath)}`)
+  return normalizePath(`/${path.relative(globalConfig.get('viteConfig')!.root, filePath)}`)
 }
 
 export function isInTest() {
@@ -47,8 +47,8 @@ export function isPublicTypescript(args: { filePath: string; inputDir: string; r
 export function _isPublicTypescript(filePath: string) {
   return isPublicTypescript({
     filePath,
-    inputDir: globalConfig.get().inputDir,
-    root: globalConfig.get().viteConfig.root,
+    inputDir: globalConfig.get('inputDir'),
+    root: globalConfig.get('viteConfig')!.root,
   })
 }
 
@@ -136,7 +136,7 @@ export function validateOptions(options: OptionsTypeWithDefault) {
     options.inputDir = inputDir.replace(/\/$/, '')
   }
 
-  if (options.sideEffects !== undefined) {
+  if (options.sideEffects !== undefined && !isInTest()) {
     console.warn(
       colors.yellow(
         `${colors.bold('(warning!)')} [${pkgName}]: sideEffects option is ${colors.bold(
@@ -212,7 +212,7 @@ export async function setupGlobalConfig(viteConfig: ResolvedConfig, opts: Option
     ...(opts as Required<OptionsTypeWithDefault>),
   })
 
-  return globalConfig.get()
+  return globalConfig
 }
 
 export async function setupManifestCache(viteConfig: ResolvedConfig, opts: OptionsTypeWithDefault) {

diff --git a/src/node/index.ts b/src/node/index.ts
@@ -132,7 +132,7 @@ export default function publicTypescript(options: VPPTPluginOptions = {}) {
           manifestCache.writeManifestJSON()
         }
 
-        const { originFilesGlob } = globalConfig.get()
+        const originFilesGlob = globalConfig.get('originFilesGlob')
 
         const originFilesName = originFilesGlob.map((file) => path.parse(file).name)
 
@@ -161,7 +161,7 @@ export default function publicTypescript(options: VPPTPluginOptions = {}) {
       },
       generateBundle() {
         if (opts.destination === 'memory') {
-          const c = manifestCache.get()
+          const c = manifestCache.all
           Object.keys(c).forEach((key) => {
             this.emitFile({
               fileName: normalizeAssetsDirPath(`${c[key]._pathToDisk}`),

diff --git a/src/node/manifest-cache/ManifestCache.ts b/src/node/manifest-cache/ManifestCache.ts
@@ -25,15 +25,15 @@ export type CacheValue = {
   path: string
 } & Partial<{ [_key: string]: string }>
 
-export type CacheObject<V extends CacheValue> = {
+export type CacheManifest<V extends CacheValue> = {
   [fileName in string]: V
 }
 
 const DEFAULT_OPTIONS: ManifestConstructor = {
   writable: true,
 }
 
-export class ManifestCache<T extends CacheValue = CacheValue, U extends CacheObject<T> = CacheObject<T>> {
+export class ManifestCache<T extends CacheValue = CacheValue, U extends CacheManifest<T> = CacheManifest<T>> {
   private _cache: U
 
   private _manifestPath = ''
@@ -57,10 +57,24 @@ export class ManifestCache<T extends CacheValue = CacheValue, U extends CacheObj
     })
   }
 
-  get() {
+  get all() {
     return Object.assign({}, this._cache)
   }
 
+  get<Selected extends keyof U>(keys: Selected[]): Pick<U, Selected>
+  get<Selected extends keyof U>(key: Selected): U[Selected]
+  get<Selected extends keyof U>(key: any): any {
+    const result = {} as Pick<U, Selected>
+    if (Array.isArray(key)) {
+      ;(key as Selected[]).forEach((k) => {
+        result[k] = this._cache[k]
+      })
+      return result
+    } else {
+      return this._cache[key as Selected]
+    }
+  }
+
   // NOTE: the only way to set cache
   set(c: U, opts?: { silent?: boolean }) {
     const keys = Object.keys(c)
@@ -124,7 +138,7 @@ export class ManifestCache<T extends CacheValue = CacheValue, U extends CacheObj
   }
 
   getManifestJson() {
-    return this.extractPath(this.get())
+    return this.extractPath(this.all)
   }
 
   sortObjectByKey(c: PathOnlyCache) {

diff --git a/src/node/manifest-cache/index.ts b/src/node/manifest-cache/index.ts
@@ -4,7 +4,7 @@ import { normalizePath } from 'vite'
 import { globalConfig } from '../global-config'
 import { DEFAULT_OPTIONS } from '../helper/default-options'
 import { readJsonFile, writeJsonFile } from '../helper/io'
-import { isInTest } from '../helper/utils'
+import { isEmptyObject, isInTest } from '../helper/utils'
 import { type CacheValue, ManifestCache } from './ManifestCache'
 
 export type CacheValueEx = {
@@ -22,7 +22,7 @@ function getManifestPath(root?: string) {
     root = process.env.__Manifest_Path__
   }
   if (!root) {
-    root = globalConfig.get().viteConfig?.root || process.cwd()
+    root = globalConfig.get('viteConfig')?.root || process.cwd()
   }
 
   return normalizePath(path.resolve(root, ManifestCachePath))
@@ -37,10 +37,17 @@ export function saveManifestPathToDisk() {
 }
 
 export function getManifest(root?: string) {
-  const manifestPath = readJsonFile(getManifestPath(root))?.manifestPath
+  if (!isEmptyObject(manifestCache.getManifestJson())) {
+    return manifestCache.getManifestJson()
+  }
 
+  if (!isEmptyObject(manifestCache.readManifestFile())) {
+    return manifestCache.readManifestFile()
+  }
+
+  const manifestPath = readJsonFile(getManifestPath(root))?.manifestPath
   if (manifestPath) {
-    return readJsonFile(manifestPath)
+    return readJsonFile(manifestPath) || {}
   }
 
   return {}

diff --git a/src/node/plugins/server.ts b/src/node/plugins/server.ts
@@ -52,7 +52,7 @@ export function pluginServer(): PluginOption {
             const { src, vppt } = getScriptInfo(node)
 
             if (vppt?.name && src?.value) {
-              const c = manifestCache.get()
+              const c = manifestCache.all
               let cacheItem = manifestCache.findCacheItemByPath(src.value)
 
               if (!cacheItem) {

diff --git a/src/node/plugins/virtual.ts b/src/node/plugins/virtual.ts
@@ -1,6 +1,6 @@
 import { type PluginOption } from 'vite'
 import { resolvedVirtualModuleId, virtualModuleId } from '../helper/virtual'
-import { manifestCache } from '../manifest-cache'
+import { getManifest } from '../manifest-cache'
 
 export function pluginVirtual(): PluginOption {
   const plugin: PluginOption = {
@@ -18,7 +18,7 @@ export function pluginVirtual(): PluginOption {
     },
     async load(id) {
       if (id === resolvedVirtualModuleId) {
-        return `export default ${JSON.stringify(manifestCache.getManifestJson())}`
+        return `export default ${JSON.stringify(getManifest())}`
       }
     },
   }

diff --git a/src/node/processor/FileCacheProcessor.ts b/src/node/processor/FileCacheProcessor.ts
@@ -26,7 +26,7 @@ export class FileCacheProcessor extends ManifestCacheProcessor {
     const {
       outputDir,
       viteConfig: { publicDir },
-    } = globalConfig.get()
+    } = globalConfig.get(['outputDir', 'viteConfig'])
 
     let oldFiles: string[] = []
     try {
@@ -42,7 +42,7 @@ export class FileCacheProcessor extends ManifestCacheProcessor {
 
     debug('deleteOldJsFile - oldFiles:', oldFiles)
 
-    debug('manifestCache:', this.manifestCache.get())
+    debug('manifestCache:', this.manifestCache.all)
 
     if (oldFiles.length > 0) {
       for (const f of oldFiles) {
@@ -66,11 +66,9 @@ export class FileCacheProcessor extends ManifestCacheProcessor {
 
   async addNewJs(args: AddFileArgs): Promise<void> {
     const { code = '' } = args
-    const {
-      viteConfig: { publicDir },
-    } = globalConfig.get()
+    const { publicDir } = globalConfig.get('viteConfig')
 
-    const pathToDisk = this.setCache(args, globalConfig.get())
+    const pathToDisk = this.setCache(args, globalConfig.all)
 
     const jsFilePath = normalizePath(path.join(publicDir, pathToDisk))
 

diff --git a/src/node/processor/ManifestCacheProcessor.ts b/src/node/processor/ManifestCacheProcessor.ts
@@ -48,6 +48,6 @@ export abstract class ManifestCacheProcessor extends BaseCacheProcessor<CacheVal
         _hash: contentHash,
       },
     })
-    return this.manifestCache.get()[originFileName]._pathToDisk || ''
+    return this.manifestCache.get(originFileName)._pathToDisk || ''
   }
 }