Merge pull request #14 from chengpeiquan/develop

feat: add an option to turn off verifying content legitimacy

Author: chengpeiquan

README.md

@@ -36,7 +36,7 @@ BannerPluginOptions|See the type declarations below|[Optional parameter format](
 ```ts
 /**
  * Some options from `vite.config.[ts|js]`
- * @tips This options type is supported since `0.2.0`
+ * @since 0.2.0
  */
 export interface BannerPluginOptions {
   /**
@@ -52,10 +52,19 @@ export interface BannerPluginOptions {
 
   /**
    * Whether to print error messages to the console
-   * @tips This option is supported since `0.4.0`
+   * @since 0.4.0
    * @default `false`
    */
   debug?: boolean
+
+  /**
+   * By default, the validity of the content will be verified.
+   * If set to `false`, no verification will be performed.
+   * @see https://github.com/chengpeiquan/vite-plugin-banner/issues/13
+   * @since 0.5.0
+   * @default `true`
+   */
+  verify?: boolean
 }
 ```
 

README.zh-CN.md

@@ -36,7 +36,7 @@ BannerPluginOptions|请参阅下方的类型声明|[可选参数格式](#可选
 ```ts
 /**
  * 来自 `vite.config.[ts|js]` 的一些选项
- * @tips 从 `0.2.0` 开始支持此选项类型
+ * @since 0.2.0
  */
 export interface BannerPluginOptions {
   /**
@@ -52,10 +52,18 @@ export interface BannerPluginOptions {
 
   /**
    * 是否将错误信息打印到控制台
-   * @tips 从 `0.4.0` 开始支持此选项
+   * @since 0.4.0
    * @default `false`
    */
   debug?: boolean
+
+  /**
+   * 默认会验证内容的合法性，设置为 `false` 则不验证
+   * @see https://github.com/chengpeiquan/vite-plugin-banner/issues/13
+   * @since 0.5.0
+   * @default `true`
+   */
+  verify?: boolean
 }
 ```
 

package.json

@@ -1,7 +1,7 @@
 {
   "name": "vite-plugin-banner",
   "description": "A banner plugin for Vite. Adds a banner to the top of each generated chunk.",
-  "version": "0.4.0",
+  "version": "0.5.0",
   "author": "chengpeiquan <[email protected]>",
   "license": "MIT",
   "homepage": "https://github.com/chengpeiquan/vite-plugin-banner",

src/libs/formatConfig.ts

@@ -14,6 +14,7 @@ export default function formatConfig(
     content: '',
     outDir: 'dist',
     debug: false,
+    verify: true,
   }
 
   // Type of plugin options
@@ -49,13 +50,20 @@ export default function formatConfig(
 
     // Update the `debug` option
     config.debug = Boolean(options.debug)
+
+    // Update the `verify` option
+    if (typeof options.verify === 'boolean') {
+      config.verify = options.verify
+    }
   }
 
+  // No verification required
+  if (!config.verify) return config
+
   // Verify the validity of the incoming comment content
   const errMsg: string = verifyBanner(config.content)
   if (errMsg) {
     throw new Error(`[vite-plugin-banner] ${errMsg}`)
   }
-
   return config
 }

src/libs/verifyBanner.ts

@@ -3,7 +3,7 @@
  * @param content - The content of banner
  * @return The error message, when success, if will be a empty string
  */
-export default function (content: string): string {
+export default function verifyBanner(content: string): string {
   // illegal type
   if (typeof content !== 'string') {
     return 'The banner content must be a string.'

src/types/index.ts

@@ -1,6 +1,6 @@
 /**
  * Some options from `vite.config.[ts|js]`
- * @tips This options type is supported since `0.2.0`
+ * @since 0.2.0
  */
 export interface BannerPluginOptions {
   /**
@@ -16,10 +16,19 @@ export interface BannerPluginOptions {
 
   /**
    * Whether to print error messages to the console
-   * @tips This option is supported since `0.4.0`
+   * @since 0.4.0
    * @default `false`
    */
   debug?: boolean
+
+  /**
+   * By default, the validity of the content will be verified.
+   * If set to `false`, no verification will be performed.
+   * @see https://github.com/chengpeiquan/vite-plugin-banner/issues/13
+   * @since 0.5.0
+   * @default `true`
+   */
+  verify?: boolean
 }
 
 /**
@@ -29,4 +38,5 @@ export interface PluginConfig {
   content: string
   outDir: string
   debug: boolean
+  verify: boolean
 }