feat(cli): extendable plugin configuration types (#3858)

ionic-team · Nov 30, 2020 · f789526 · f789526
1 parent f7dff2e
commit f789526
Showing 1 changed file with 22 additions and 1 deletion.
diff --git a/cli/src/declarations.ts b/cli/src/declarations.ts
@@ -370,7 +370,15 @@ export interface CapacitorConfig {
     preferences?: { [key: string]: string | undefined };
   };
 
-  plugins?: { [key: string]: any };
+  /**
+   * Configure plugins.
+   *
+   * This is an object with configuration values specified by plugin class
+   * name.
+   *
+   * @since 1.0.0
+   */
+  plugins?: PluginsConfig;
 
   /**
    * Allowlist of plugins to include during `npx cap sync`.
@@ -383,3 +391,16 @@ export interface CapacitorConfig {
    */
   includePlugins?: string[];
 }
+
+export interface PluginsConfig {
+  /**
+   * Plugin configuration by class name.
+   *
+   * @since 1.0.0
+   */
+  [key: string]:
+    | {
+        [key: string]: any;
+      }
+    | undefined;
+}