Merge pull request #2 from vite-plugin/v1.4.0

V1.4.0

Author: caoxiemeihao

CHANGELOG.md

@@ -1,4 +1,12 @@
 
+## [2022-07-15] v1.4.0
+
+- dbaff13 docs: v1.4.0
+- cfc0da2 feat: add test
+- 8baa83b test: v1.4.0
+- df034e2 refactor: better logic
+- 2c3a23f chore: `files`
+
 ## [2022-07-02] v1.3.4
 
 - f16697a docs: v1.3.4

README.md

@@ -72,40 +72,57 @@ You can see 👉 [vite-plugin-esmodule](https://github.com/vite-plugin/vite-plug
 
 Optimizer(entries[, options])
 
-##### entries
+`entries: Entries`
 
 ```ts
-export interface Entries {
-  [moduleId: string]:
-    | string
-    | ResultDescription
-    | ((args: OptimizerArgs) => string | ResultDescription | Promise<string | ResultDescription | void> | void)
-    | void;
-}
-
 export interface OptimizerArgs {
   /** Generated file cache directory */
   dir: string;
 }
 
 export interface ResultDescription {
-  alias?: { find: string | RegExp; replacement: string };
+  /**
+   * This is consistent with the `alias` behavior.
+   * 
+   * e.g.  
+   *   `import fs from 'fs'`  
+   *   or  
+   *   `import fs from 'node:fs'`  
+   * 
+   * @example
+   * {
+   *   // This means that both 'fs' and 'node:fs' are supported.
+   *   find: /^(node:)?fs$/,
+   *   replacement: '/project/node_modules/.vite-plugin-optimizer/fs.js',
+   * }
+   */
+  alias?: {
+    find: string | RegExp;
+    /**
+     * If not explicitly specified, will use the path to the generated file as the default.
+     */
+    replacement?: string;
+  };
   code?: string;
 }
+
+export interface Entries {
+  [moduleId: string]:
+  | string
+  | ResultDescription
+  | ((args: OptimizerArgs) => string | ResultDescription | Promise<string | ResultDescription | void> | void);
+}
 ```
 
-##### options
+`options: OptimizerOptions`
 
 ```ts
 export interface OptimizerOptions {
   /**
    * @default ".vite-plugin-optimizer"
    */
   dir?: string;
-  /**
-   * @default ".js"
-   */
-  ext?: string;
+  resolveId?: ((id: string) => string | Promise<string | void> | void);
 }
 ```
 

README.zh-CN.md

@@ -72,40 +72,57 @@ optimizer({
 
 Optimizer(entries[, options])
 
-##### entries
+`entries: Entries`
 
 ```ts
-export interface Entries {
-  [moduleId: string]:
-    | string
-    | ResultDescription
-    | ((args: OptimizerArgs) => string | ResultDescription | Promise<string | ResultDescription | void> | void)
-    | void;
-}
-
 export interface OptimizerArgs {
-  /** 生成缓存文件夹 */
+  /** 生成缓存文件路径 */
   dir: string;
 }
 
 export interface ResultDescription {
-  alias?: { find: string | RegExp; replacement: string };
-  code: string;
+  /**
+   * 这与 `alias` 行为一致。
+   * 
+   * e.g.  
+   *   `import fs from 'fs'`  
+   *   or  
+   *   `import fs from 'node:fs'`  
+   * 
+   * @example
+   * {
+   *   // 这种写法表示同时支持 'fs' 和 'node:fs'。  
+   *   find: /^(node:)?fs$/,
+   *   replacement: '/project/node_modules/.vite-plugin-optimizer/fs.js',
+   * }
+   */
+  alias?: {
+    find: string | RegExp;
+    /**
+     * 如果没有显式的指定，将会使用生成文件的路径作为默认值。
+     */
+    replacement?: string;
+  };
+  code?: string;
+}
+
+export interface Entries {
+  [moduleId: string]:
+  | string
+  | ResultDescription
+  | ((args: OptimizerArgs) => string | ResultDescription | Promise<string | ResultDescription | void> | void);
 }
 ```
 
-##### options
+`options: OptimizerOptions`
 
 ```ts
 export interface OptimizerOptions {
   /**
    * @default ".vite-plugin-optimizer"
    */
   dir?: string;
-  /**
-   * @default ".js"
-   */
-  ext?: string;
+  resolveId?: ((id: string) => string | Promise<string | void> | void);
 }
 ```
 

index.d.ts

@@ -1,4 +1,4 @@
-import { Plugin, UserConfig } from 'vite';
+import { Plugin } from 'vite';
 
 declare const optimizer: VitePluginOptimizer;
 export default optimizer;
@@ -10,20 +10,24 @@ export interface OptimizerArgs {
 
 export interface ResultDescription {
   /**
-   * this option is designed to fully support `alias`  
-   * this is useful if users want to customize alias  
-   * ```js
+   * This is consistent with the `alias` behavior.
+   * 
+   * e.g.  
+   *   `import fs from 'fs'`  
+   *   or  
+   *   `import fs from 'node:fs'`  
+   * 
+   * @example
    * {
-   *   // e.g. 👉 `/^(node:)?fs$/` from user customization  
+   *   // This means that both 'fs' and 'node:fs' are supported.
    *   find: /^(node:)?fs$/,
    *   replacement: '/project/node_modules/.vite-plugin-optimizer/fs.js',
    * }
-   * ```
    */
   alias?: {
     find: string | RegExp;
     /**
-     * If not specified, the path of the generated file is used.
+     * If not explicitly specified, will use the path to the generated file as the default.
      */
     replacement?: string;
   };
@@ -34,19 +38,15 @@ export interface Entries {
   [moduleId: string]:
   | string
   | ResultDescription
-  | ((args: OptimizerArgs) => string | ResultDescription | Promise<string | ResultDescription | void> | void)
-  | void;
+  | ((args: OptimizerArgs) => string | ResultDescription | Promise<string | ResultDescription | void> | void);
 }
 
 export interface OptimizerOptions {
   /**
    * @default ".vite-plugin-optimizer"
    */
   dir?: string;
-  /**
-   * @default ".js"
-   */
-  ext?: string;
+  resolveId?: ((id: string) => string | Promise<string | void> | void);
 }
 
 export interface VitePluginOptimizer {
@@ -58,20 +58,9 @@ export interface VitePluginOptimizer {
 export type GenerateRecord = {
   alias?: ResultDescription['alias'];
   module: string;
-  // absolute path of file
-  filepath: string;
+  // Absolute path of file
+  filename: string;
 };
 export interface GenerateModule {
-  (dir: string, entries: Entries, ext: string): Promise<GenerateRecord[]>;
-}
-
-export interface RegisterAlias {
-  (
-    config: UserConfig,
-    records: GenerateRecord[],
-  ): void;
-}
-
-export interface RegisterOptimizeDepsExclude {
-  (config: UserConfig, exclude: string[]): void;
+  (...args: Parameters<VitePluginOptimizer>): Promise<GenerateRecord[]>;
 }