fix(build&serve): support --skip-plugins, fixes #1358

Author: nklayman

__tests__/commands.spec.js

@@ -225,6 +225,7 @@ describe('electron:build', () => {
 
   test.each([
     ['--mode', 'someMode'],
+    ['--skip-plugins', 'somePlugin'],
     ['--legacy'],
     ['--dashboard'],
     ['--skipBundle'],
@@ -376,11 +377,15 @@ describe('electron:build', () => {
 
     expect(fs.writeFileSync).toBeCalledWith(
       'dist_electron/bundled/package.json',
-      JSON.stringify({
-        dependencies: {
-          external: '^0.0.1'
-        }
-      }, undefined, 2)
+      JSON.stringify(
+        {
+          dependencies: {
+            external: '^0.0.1'
+          }
+        },
+        undefined,
+        2
+      )
     )
   })
 
@@ -811,54 +816,52 @@ describe('electron:serve', () => {
     )
   })
 
-  test.each([['--dashboard'], ['--debug'], ['--headless']])(
-    '%s argument is not passed to electron',
-    async (...args) => {
-      await runCommand('electron:serve', {}, {}, [
-        '--keep1',
-        ...args,
-        '--keep2'
-      ])
-      // Custom args should have been removed, and other args kept
-      let calledArgs = execa.mock.calls[0][1]
-      // Remove dist_electron
-      calledArgs.shift()
-      expect(calledArgs).toEqual(['--keep1', '--keep2'])
-      execa.mockClear()
-
-      await runCommand('electron:serve', {}, {}, [...args, '--keep2'])
-      // Custom args should have been removed, and other args kept
-      calledArgs = execa.mock.calls[0][1]
-      // Remove dist_electron
-      calledArgs.shift()
-      expect(calledArgs).toEqual(['--keep2'])
-      execa.mockClear()
-
-      await runCommand('electron:serve', {}, {}, ['--keep1', ...args])
-      // Custom args should have been removed, and other args kept
-      calledArgs = execa.mock.calls[0][1]
-      // Remove dist_electron
-      calledArgs.shift()
-      expect(calledArgs).toEqual(['--keep1'])
-      execa.mockClear()
-
-      await runCommand('electron:serve', {}, {}, args)
-      // Custom args should have been removed
-      calledArgs = execa.mock.calls[0][1]
-      // Remove dist_electron
-      calledArgs.shift()
-      expect(calledArgs).toEqual([])
-      execa.mockClear()
-
-      await runCommand('electron:serve', {}, {}, ['--keep1', '--keep2'])
-      // Nothing should be removed
-      calledArgs = execa.mock.calls[0][1]
-      // Remove dist_electron
-      calledArgs.shift()
-      expect(calledArgs).toEqual(['--keep1', '--keep2'])
-      execa.mockClear()
-    }
-  )
+  test.each([
+    ['--dashboard'],
+    ['--debug'],
+    ['--headless'],
+    ['--skip-plugins', 'somePlugin']
+  ])('%s argument is not passed to electron', async (...args) => {
+    await runCommand('electron:serve', {}, {}, ['--keep1', ...args, '--keep2'])
+    // Custom args should have been removed, and other args kept
+    let calledArgs = execa.mock.calls[0][1]
+    // Remove dist_electron
+    calledArgs.shift()
+    expect(calledArgs).toEqual(['--keep1', '--keep2'])
+    execa.mockClear()
+
+    await runCommand('electron:serve', {}, {}, [...args, '--keep2'])
+    // Custom args should have been removed, and other args kept
+    calledArgs = execa.mock.calls[0][1]
+    // Remove dist_electron
+    calledArgs.shift()
+    expect(calledArgs).toEqual(['--keep2'])
+    execa.mockClear()
+
+    await runCommand('electron:serve', {}, {}, ['--keep1', ...args])
+    // Custom args should have been removed, and other args kept
+    calledArgs = execa.mock.calls[0][1]
+    // Remove dist_electron
+    calledArgs.shift()
+    expect(calledArgs).toEqual(['--keep1'])
+    execa.mockClear()
+
+    await runCommand('electron:serve', {}, {}, args)
+    // Custom args should have been removed
+    calledArgs = execa.mock.calls[0][1]
+    // Remove dist_electron
+    calledArgs.shift()
+    expect(calledArgs).toEqual([])
+    execa.mockClear()
+
+    await runCommand('electron:serve', {}, {}, ['--keep1', '--keep2'])
+    // Nothing should be removed
+    calledArgs = execa.mock.calls[0][1]
+    // Remove dist_electron
+    calledArgs.shift()
+    expect(calledArgs).toEqual(['--keep1', '--keep2'])
+    execa.mockClear()
+  })
 
   test('Electron is launched with arguments', async () => {
     await runCommand('electron:serve', {}, {}, ['--expected'])

index.js

@@ -76,6 +76,7 @@ module.exports = (api, options) => {
       // Prevent custom args from interfering with electron-builder
       removeArg('--mode', 2, rawArgs)
       removeArg('--dest', 2, rawArgs)
+      removeArg('--skip-plugins', 2, rawArgs)
       removeArg('--legacy', 1, rawArgs)
       removeArg('--dashboard', 1, rawArgs)
       removeArg('--skipBundle', 1, rawArgs)
@@ -115,7 +116,8 @@ module.exports = (api, options) => {
           modern: !args.legacy,
           // --report and --report-json args
           report: args.report,
-          'report-json': args['report-json']
+          'report-json': args['report-json'],
+          skipPlugins: args.skipPlugins
         }
         // With @vue/cli-service v3.4.1+, we can bypass legacy build
         process.env.VUE_CLI_MODERN_BUILD = !args.legacy || ''
@@ -287,6 +289,7 @@ module.exports = (api, options) => {
       const mainProcessArgs = pluginOptions.mainProcessArgs || []
 
       // Don't pass command args to electron
+      removeArg('--skip-plugins', 2, rawArgs)
       removeArg('--dashboard', 1, rawArgs)
       removeArg('--debug', 1, rawArgs)
       removeArg('--headless', 1, rawArgs)
@@ -297,7 +300,8 @@ module.exports = (api, options) => {
         _: rendererProcessFile,
         // Use dashboard if called from ui
         dashboard: args.dashboard,
-        https: args.https
+        https: args.https,
+        skipPlugins: args.skipPlugins
       })
       const outputDir = pluginOptions.outputDir || 'dist_electron'