feat(cli): locate plugins by allowlist (#3762)

ionic-team · Nov 25, 2020 · 81963b6 · 81963b6
1 parent f3edaf9
commit 81963b6
Show file tree

Hide file tree

Showing 6 changed files with 61 additions and 12 deletions.
diff --git a/cli/src/android/update.ts b/cli/src/android/update.ts
@@ -305,7 +305,7 @@ async function removePluginsNativeFiles(config: Config) {
 
 async function getPluginsTask(config: Config) {
   return await runTask('Updating Android plugins', async () => {
-    const allPlugins = await getPlugins(config);
+    const allPlugins = await getPlugins(config, 'android');
     const androidPlugins = await getAndroidPlugins(allPlugins);
     return androidPlugins;
   });

diff --git a/cli/src/cordova.ts b/cli/src/cordova.ts
@@ -302,7 +302,7 @@ export async function getCordovaPlugins(
   config: Config,
   platform: string,
 ): Promise<Plugin[]> {
-  const allPlugins = await getPlugins(config);
+  const allPlugins = await getPlugins(config, platform);
   let plugins: Plugin[] = [];
   if (platform === config.ios.name) {
     plugins = await getIOSPlugins(allPlugins);

diff --git a/cli/src/declarations.ts b/cli/src/declarations.ts
@@ -155,6 +155,15 @@ export interface CapacitorConfig {
      * @default false
      */
     hideLogs?: boolean;
+
+    /**
+     * Allowlist of plugins to include during `npx cap sync` for Android.
+     *
+     * Overrides global `includePlugins` option.
+     *
+     * @since 3.0.0
+     */
+    includePlugins?: string[];
   };
 
   ios?: {
@@ -264,6 +273,15 @@ export interface CapacitorConfig {
      * @default false
      */
     hideLogs?: boolean;
+
+    /**
+     * Allowlist of plugins to include during `npx cap sync` for iOS.
+     *
+     * Overrides global `includePlugins` option.
+     *
+     * @since 3.0.0
+     */
+    includePlugins?: string[];
   };
 
   server?: {
@@ -353,4 +371,15 @@ export interface CapacitorConfig {
   };
 
   plugins?: { [key: string]: any };
+
+  /**
+   * Allowlist of plugins to include during `npx cap sync`.
+   *
+   * This should be an array of strings representing the npm package name of
+   * plugins to include when running `npx cap sync`. If unset, Capacitor will
+   * inspect `package.json` for a list of potential plugins.
+   *
+   * @since 3.0.0
+   */
+  includePlugins?: string[];
 }
diff --git a/cli/src/ios/update.ts b/cli/src/ios/update.ts
@@ -511,7 +511,7 @@ function removeNoSystem(library: string, sourceFrameworks: string[]) {
 
 async function getPluginsTask(config: Config) {
   return await runTask('Updating iOS plugins', async () => {
-    const allPlugins = await getPlugins(config);
+    const allPlugins = await getPlugins(config, 'ios');
     const iosPlugins = await getIOSPlugins(allPlugins);
     return iosPlugins;
   });

diff --git a/cli/src/plugin.ts b/cli/src/plugin.ts
@@ -40,12 +40,31 @@ export interface Plugin {
   };
 }
 
-export async function getPlugins(config: Config): Promise<Plugin[]> {
-  const deps = getDependencies(config);
-  const plugins = await Promise.all(
-    deps.map(async p => resolvePlugin(config, p)),
+export function getIncludedPluginPackages(
+  config: Config,
+  platform: string,
+): readonly string[] | undefined {
+  const { extConfig } = config.app;
+
+  switch (platform) {
+    case 'android':
+      return extConfig.android?.includePlugins ?? extConfig.includePlugins;
+    case 'ios':
+      return extConfig.ios?.includePlugins ?? extConfig.includePlugins;
+  }
+}
+
+export async function getPlugins(
+  config: Config,
+  platform: string,
+): Promise<Plugin[]> {
+  const possiblePlugins =
+    getIncludedPluginPackages(config, platform) ?? getDependencies(config);
+  const resolvedPlugins = await Promise.all(
+    possiblePlugins.map(async p => resolvePlugin(config, p)),
   );
-  return plugins.filter(p => !!p) as Plugin[];
+
+  return resolvedPlugins.filter((p): p is Plugin => !!p);
 }
 
 export async function resolvePlugin(
@@ -93,9 +112,10 @@ export async function resolvePlugin(
 }
 
 export function getDependencies(config: Config): string[] {
-  const dependencies = config.app.package.dependencies ?? [];
-  const devDependencies = config.app.package.devDependencies ?? [];
-  return Object.keys(dependencies).concat(Object.keys(devDependencies));
+  return [
+    ...Object.keys(config.app.package.dependencies ?? {}),
+    ...Object.keys(config.app.package.devDependencies ?? {}),
+  ];
 }
 
 export function fixName(name: string): string {

diff --git a/cli/src/tasks/list.ts b/cli/src/tasks/list.ts
@@ -30,7 +30,7 @@ export async function listCommand(
 }
 
 export async function list(config: Config, platform: string): Promise<void> {
-  const allPlugins = await getPlugins(config);
+  const allPlugins = await getPlugins(config, platform);
   let plugins: Plugin[] = [];
   if (platform === config.ios.name) {
     plugins = await getIOSPlugins(allPlugins);