Merge pull request #72 from Baroshem/feat/enabled-config-option

feat: add enabled config option
nuxt-modules · Jan 2, 2023 · 6633b39 · 6633b39 · vercel · Jan 2, 2023
2 parents 2f54817 + 4ec9fe8
commit 6633b39
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 2 deletions.
diff --git a/docs/content/1.getting-started/2.configuration.md b/docs/content/1.getting-started/2.configuration.md
@@ -31,6 +31,7 @@ export interface ModuleOptions {
   allowedMethodsRestricter: MiddlewareConfiguration<AllowedHTTPMethods> | false;
   hidePoweredBy: boolean;
   basicAuth: MiddlewareConfiguration<BasicAuth> | boolean;
+  enabled: boolean;
 }
 ```
 
@@ -148,7 +149,8 @@ security: {
     throwError?: true,
   },
   hidePoweredBy: true,
-  basicAuth: false
+  basicAuth: false,
+  enabled: true,
 }
 ```
 

diff --git a/src/defaultConfig.ts b/src/defaultConfig.ts
@@ -115,5 +115,6 @@ export const defaultSecurityConfig: ModuleOptions = {
     ...defaultThrowErrorValue
   },
   hidePoweredBy: true,
-  basicAuth: false
+  basicAuth: false,
+  enabled: true
 }
diff --git a/src/module.ts b/src/module.ts
@@ -42,6 +42,8 @@ export default defineNuxtModule<ModuleOptions>({
       ...defaultSecurityConfig
     })
     const securityOptions = nuxt.options.security
+    // Disabled module when `enabled` is set to `false`
+    if (!securityOptions.enabled) return
 
     // Register nitro plugin to replace default 'X-Powered-By' header with custom one that does not indicate what is the framework underneath the app.
     if (securityOptions.hidePoweredBy) {

diff --git a/src/types.ts b/src/types.ts
@@ -157,4 +157,5 @@ export interface ModuleOptions {
   allowedMethodsRestricter: MiddlewareConfiguration<AllowedHTTPMethods> | false;
   hidePoweredBy: boolean;
   basicAuth: MiddlewareConfiguration<BasicAuth> | boolean;
+  enabled: boolean;
 }