feat：Added default value for include option (#47)

* Added default value for `include` option * added svg to default `include`
nonzzz · Apr 18, 2024 · f47dcdb · f47dcdb
1 parent 5a16590
commit f47dcdb
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -35,7 +35,7 @@ export default defineConfig({
 
 | params                 | type                                          | default           | description                                                    |
 | ---------------------- | --------------------------------------------- | ----------------- | -------------------------------------------------------------- |
-| `include`              | `string \| RegExp \| Array<string \| RegExp>` | `-`               | Include all assets matching any of these conditions.           |
+| `include`              | `string \| RegExp \| Array<string \| RegExp>` | `/\.(html|xml|css|json|js|mjs|svg)$/`               | Include all assets matching any of these conditions.           |
 | `exclude`              | `string \| RegExp \| Array<string \| RegExp>` | `-`               | Exclude all assets matching any of these conditions.           |
 | `threshold`            | `number`                                      | `0`               | Only assets bigger than this size are processed (in bytes)     |
 | `algorithm`            | `string\| function`                           | `gzip`            | The compression algorithm                                      |

diff --git a/src/index.ts b/src/index.ts
@@ -142,7 +142,7 @@ function compression<T extends UserCompressionOptions = NonNullable<unknown>>(op
 function compression(opts: ViteWithoutCompressionPluginConfigFunction): Plugin
 function compression<T extends UserCompressionOptions, A extends Algorithm>(opts: ViteCompressionPluginConfig<T, A> = {}): Plugin {
   const {
-    include,
+    include = /\.(html|xml|css|json|js|mjs|svg)$/,
     exclude,
     threshold = 0,
     algorithm: userAlgorithm = 'gzip',