Merge branch 'master' into v2

nklayman · nklayman · commit ce5265784ab5 · 2020-01-09T10:40:13.000-08:00
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
@@ -9,4 +9,4 @@ VCP-electron-builder uses the [standard style guide](https://standardjs.com/), e
 
 ### Testing
 
-VCP-electron-builder uses [Jest](http://jestjs.io/) for testing. It has e2e tests for regular build and serve and typescript build and serve. Because of this, tests can take up to 5 minutes to run. If you have a slower computer (less than quad core) it might help to add the `--runInBand` argument to `yarn test`. The tests only work on Linux or Windows, not MacOS. Please run all tests and make sure they pass before submitting a pull request. [AppVeyor](https://www.appveyor.com/) is used for CI tests.
+VCP-electron-builder uses [Jest](http://jestjs.io/) for testing. It has e2e tests for regular build and serve and typescript build and serve. Because of this, tests can take up to 5 minutes to run. If you have a slower computer (less than quad core) it might help to add the `--runInBand` argument to `yarn test`. The tests only work on Linux or Windows, not MacOS. Please run all tests and make sure they pass before submitting a pull request. Github Actions are used for CI.
diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml
@@ -1,3 +1,3 @@
 # These are supported funding model platforms
 
-custom: ['https://www.paypal.me/noahklayman', 'https://venmo.com/noahklayman']
+github: nklayman
diff --git a/.github/workflows/nodeCI.yml b/.github/workflows/nodeCI.yml
@@ -0,0 +1,49 @@
+name: Node CI
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+    branches: [master]
+
+jobs:
+  build:
+    strategy:
+      matrix:
+        os: [ubuntu-latest, windows-latest]
+        node: [ '12', '10', '8' ]
+        include:
+        - os: windows-latest
+          commandPrefix: ''
+        - os: ubuntu-latest
+          commandPrefix: xvfb-run
+    runs-on: ${{ matrix.os }}
+    steps:
+    - uses: actions/checkout@v1
+    - name: Setup Node
+      uses: actions/setup-node@v1
+      with:
+        node-version: ${{ matrix.node }}
+    - name: Get yarn cache dir
+      id: yarn-cache
+      run: echo "::set-output name=dir::$(yarn cache dir)"
+    - name: Yarn cache
+      if: runner.os != 'Windows'
+      uses: actions/cache@v1
+      with:
+        path: ${{ steps.yarn-cache.outputs.dir }}
+        key: ${{ runner.os }}-yarn-${{ hashFiles('yarn.lock') }}
+        restore-keys: |
+          ${{ runner.os }}-yarn-
+    - name: yarn install
+      run: yarn install
+    - name: yarn test
+      run: ${{ matrix.commandPrefix }} yarn test --runInBand --coverage
+      env:
+        CI: true
+    - name: Upload coverage to Codecov
+      if: runner.os == 'Linux'
+      uses: codecov/codecov-action@v1
+      with:
+        token: ${{secrets.CODECOV_TOKEN}}
+        file: ./coverage/clover.xml
diff --git a/.travis.yml b/.travis.yml
diff --git a/README.md b/README.md
@@ -2,11 +2,11 @@
 
 A Vue Cli 3 plugin for Electron with no required configuration that uses [Electron Builder](https://www.electron.build/).
 
-Windows (Appveyor): [![Build status](https://ci.appveyor.com/api/projects/status/tyrr8kemli4vfll7?svg=true)](https://ci.appveyor.com/project/nklayman/vue-cli-plugin-electron-builder), Linux (Travis): [![Build Status](https://travis-ci.org/nklayman/vue-cli-plugin-electron-builder.svg?branch=master)](https://travis-ci.org/nklayman/vue-cli-plugin-electron-builder)
+Build status: [![Build status](https://github.com/nklayman/vue-cli-plugin-electron-builder/workflows/Node%20CI/badge.svg)](https://github.com/nklayman/vue-cli-plugin-electron-builder/actions)
 
-**IMPORTANT: Your app must be created with Vue-CLI 3 (vue create my-app), will not work with Vue-CLI 2 (vue init webpack my-app)!**
+[![Sponsor](./docs/.vuepress/public/sponsorShield.svg)](https://github.com/sponsors/nklayman)
 
-**IMPORTANT: These docs are for the v1.0.0 release of VCP Electron Builder. If you were previously using an older version of vue-cli-plugin-electron-builder (<1.0.0), please see the [upgrade guide](https://nklayman.github.io/vue-cli-plugin-electron-builder/guide/upgrading.html) or [view the old docs](https://github.com/nklayman/vue-cli-plugin-electron-builder/tree/legacy).**
+**IMPORTANT: Your app must be created with Vue-CLI 3 or 4 (vue create my-app), will not work with Vue-CLI 2 (vue init webpack my-app)!**
 
 ## Quick Start:
 
@@ -40,11 +40,8 @@ or with NPM:
 
 To see more documentation, [visit our website](https://nklayman.github.io/vue-cli-plugin-electron-builder/guide/guide.html).
 
-## WARNING
+## Supporters
 
-The command names have changed in `v1.0.0-rc.4`. If you are using an older version, the command names are:
-`yarn serve:electron`
-and
-`yarn build:electron`.
-
-Replace `yarn` with `npm run` if you are using npm.
+| [![Andrew LeTourneau](https://avatars2.githubusercontent.com/u/2807807?s=64&v=4)](https://github.com/centerorbit) |
+| ----------------------------------------------------------------------------------------------------------------- |
+| [Andrew LeTourneau](https://github.com/centerorbit)                                                               |
diff --git a/__tests__/commands.spec.js b/__tests__/commands.spec.js
@@ -123,7 +123,7 @@ describe('electron:build', () => {
     expect(Object.keys(mainConfig)).not.toContain('module')
     //   Ts files are not resolved
     expect(
-      mainConfig.resolve ? mainConfig.resolve.extensions : []
+      mainConfig.resolve.extensions ? mainConfig.resolve.extensions : []
     ).not.toContain('ts')
     //   Proper entry file is used
     expect(mainConfig.entry.background[0]).toBe('projectPath/src/background.js')
@@ -242,7 +242,9 @@ describe('electron:build', () => {
     ['--legacy'],
     ['--dashboard'],
     ['--skipBundle'],
-    ['--dest', 'output']
+    ['--dest', 'output'],
+    ['--report'],
+    ['--report-json']
   ])('%s argument is removed from electron-builder args', async (...args) => {
     await runCommand('electron:build', {}, {}, ['--keep1', ...args, '--keep2'])
     // Custom args should have been removed, and other args kept
@@ -279,6 +281,16 @@ describe('electron:build', () => {
     expect(serviceRun.mock.calls[0][1].modern).toBe(false)
   })
 
+  test.each(['report', 'report-json'])(
+    '--%s arg is passed to renderer build',
+    async argName => {
+      const args = {}
+      args[argName] = true
+      await runCommand('electron:build', {}, args)
+      expect(serviceRun.mock.calls[0][1][argName]).toBe(true)
+    }
+  )
+
   test('App is not bundled if --skipBundle arg is passed', async () => {
     await runCommand('electron:build', {}, { skipBundle: true })
     expect(serviceRun).not.toBeCalled()
@@ -350,15 +362,11 @@ describe('electron:build', () => {
         }
       })
       expect(fs.writeFileSync).toBeCalledWith(
-        `dist_electron${path.sep}bundled${
-          path.sep
-        }legacy-assets-index.html.json`,
+        `dist_electron${path.sep}bundled${path.sep}legacy-assets-index.html.json`,
         '[]'
       )
       expect(fs.writeFileSync).toBeCalledWith(
-        `dist_electron${path.sep}bundled${
-          path.sep
-        }legacy-assets-subpage.html.json`,
+        `dist_electron${path.sep}bundled${path.sep}legacy-assets-subpage.html.json`,
         '[]'
       )
     }
@@ -386,6 +394,17 @@ describe('electron:build', () => {
       })
     )
   })
+
+  test('Config arguments overwrite config', async () => {
+    jest.unmock('yargs')
+    await runCommand('electron:build', undefined, undefined, [
+      '-c.directories.output=customDist'
+    ])
+
+    expect(builder.build.mock.calls[0][0].config.directories.output).toBe(
+      'customDist'
+    )
+  })
 })
 
 describe('electron:serve', () => {
@@ -406,7 +425,7 @@ describe('electron:serve', () => {
     expect(Object.keys(mainConfig)).not.toContain('module')
     //   Ts files are not resolved
     expect(
-      mainConfig.resolve ? mainConfig.resolve.extensions : []
+      mainConfig.resolve.extensions ? mainConfig.resolve.extensions : []
     ).not.toContain('ts')
     //   Proper entry file is used
     expect(mainConfig.entry.index[0]).toBe('projectPath/src/background.js')
diff --git a/appveyor.yml b/appveyor.yml
diff --git a/docs/.vuepress/components/Sponsor.vue b/docs/.vuepress/components/Sponsor.vue
@@ -0,0 +1,25 @@
+<template>
+  <p class="sponsor">
+    <a href="https://github.com/sponsors/nklayman" target="_blank">
+      <span>Support This Project</span>
+      <img alt="Sponsor" src="sponsorShield.svg">
+    </a>
+  </p>
+</template>
+
+<style lang="stylus">
+.sponsor
+  font-weight 600
+  background-color #f3f6f8
+  padding 0.6em 1.2em
+  border-radius 8px
+  display inline-block
+  margin 1em 0 !important
+  a
+    color #999
+  img
+    height 20px
+    margin-left 15px
+  img, span
+    vertical-align middle
+</style>
diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js
@@ -23,6 +23,10 @@ module.exports = {
         text: 'Changelog',
         link:
           'https://github.com/nklayman/vue-cli-plugin-electron-builder/releases'
+      },
+      {
+        text: 'Sponsor',
+        link: 'https://github.com/sponsors/nklayman'
       }
     ],
     sidebar: {
diff --git a/docs/.vuepress/public/sponsorShield.svg b/docs/.vuepress/public/sponsorShield.svg
@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="150" height="20"><linearGradient id="b" x2="0" y2="100%"><stop offset="0" stop-color="#bbb" stop-opacity=".1"/><stop offset="1" stop-opacity=".1"/></linearGradient><clipPath id="a"><rect width="150" height="20" rx="3" fill="#fff"/></clipPath><g clip-path="url(#a)"><path fill="#555" d="M0 0h49v20H0z"/><path fill="#4c1" d="M49 0h101v20H49z"/><path fill="url(#b)" d="M0 0h150v20H0z"/></g><g fill="#fff" text-anchor="middle" font-family="DejaVu Sans,Verdana,Geneva,sans-serif" font-size="110"> <text x="255" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="390">Donate</text><text x="255" y="140" transform="scale(.1)" textLength="390">Donate</text><text x="985" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="910">Github Sponsors</text><text x="985" y="140" transform="scale(.1)" textLength="910">Github Sponsors</text></g> </svg>
diff --git a/docs/README.md b/docs/README.md
@@ -6,6 +6,10 @@ actionLink: /guide/
 footer: MIT Licensed | Copyright © 2018-present Noah Klayman
 ---
 
+<div style="text-align: center">
+  <Sponsor/>
+</div>
+
 <div class="features">
   <div class="feature">
     <h2>Write Once, Run Everywhere</h2>
@@ -21,8 +25,6 @@ footer: MIT Licensed | Copyright © 2018-present Noah Klayman
   </div>
 </div>
 <centered-markdown>
-Build Status:
-
-Windows (Appveyor): [![Build status](https://ci.appveyor.com/api/projects/status/tyrr8kemli4vfll7?svg=true)](https://ci.appveyor.com/project/nklayman/vue-cli-plugin-electron-builder), Linux (Travis): [![Build Status](https://travis-ci.org/nklayman/vue-cli-plugin-electron-builder.svg?branch=master)](https://travis-ci.org/nklayman/vue-cli-plugin-electron-builder)
+Build status: [![Build status](https://github.com/nklayman/vue-cli-plugin-electron-builder/workflows/Node%20CI/badge.svg)](https://github.com/nklayman/vue-cli-plugin-electron-builder/actions)
 
 </centered-markdown>
diff --git a/docs/guide/configuration.md b/docs/guide/configuration.md
@@ -123,7 +123,9 @@ module.exports = {
   pluginOptions: {
     electronBuilder: {
       customFileProtocol: 'myCustomProtocol://./' // Make sure to add "./" to the end of the protocol
-      customFileProtocol: 'file://./' // You can also revert back to the file protocol with 'file://'
+      // If you want to use the file:// protocol, add win.loadURL(`file://${__dirname}/index.html`) to your main process file
+      // In place of win.loadURL('app://./index.html'), and set customFileProtocol to './'
+      customFileProtocol: './'
     }
   }
 }
diff --git a/docs/guide/upgrading.md b/docs/guide/upgrading.md
@@ -19,7 +19,7 @@ This guide is for upgrading from <=v0.3.2 to >=v1.0.0.
 - This means there is no need to change your config to work with stylus, sass, or any other special files.
 - The commands have been renamed from `command:electron` to `electron:command` (since 1.0.0-rc.4)
 - Typescript support is [automatic](./configuration.md#typescript-options) for both processes, just add the `@vue/typescript` plugin.
-- Your normal build will not be overwritten by `build:electron`.
+- Your normal build will not be overwritten by `electron:build`.
 - The [folder structure](./guide.md#folder-structure) has changed dramatically.
-- Electron-builder's [config](./configuration.md#configuring-electron-builder) is now taken from the `builderConfig` key in vue-cli-plugin-electron-builder's plugin options.
+- Electron-builder's [config](./configuration.md#configuring-electron-builder) is now taken from the `builderOptions` key in vue-cli-plugin-electron-builder's plugin options.
 - To learn more about the internals of this plugin, see [how it works](./guide.md#how-it-works).
diff --git a/generator/templates/base/src/background.js b/generator/templates/base/src/background.js
@@ -3,7 +3,7 @@
 import { app, protocol, BrowserWindow } from 'electron'
 import {
   createProtocol,
-  installVueDevtools
+  <% if (devtoolsExtensionsBroken) { %>/* installVueDevtools */<% } else { %>installVueDevtools<% } %>
 } from 'vue-cli-plugin-electron-builder/lib'
 const isDevelopment = process.env.NODE_ENV !== 'production'
 
diff --git a/index.js b/index.js
diff --git a/lib/testWithSpectron.js b/lib/testWithSpectron.js
diff --git a/package.json b/package.json
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -9,4 +9,4 @@ VCP-electron-builder uses the [standard style guide](https://standardjs.com/), e`
`9`	`9`
`10`	`10`	`### Testing`
`11`	`11`
`12`		-VCP-electron-builder uses [Jest](http://jestjs.io/) for testing. It has e2e tests for regular build and serve and typescript build and serve. Because of this, tests can take up to 5 minutes to run. If you have a slower computer (less than quad core) it might help to add the `--runInBand` argument to `yarn test`. The tests only work on Linux or Windows, not MacOS. Please run all tests and make sure they pass before submitting a pull request. [AppVeyor](https://www.appveyor.com/) is used for CI tests.
	`12`	+VCP-electron-builder uses [Jest](http://jestjs.io/) for testing. It has e2e tests for regular build and serve and typescript build and serve. Because of this, tests can take up to 5 minutes to run. If you have a slower computer (less than quad core) it might help to add the `--runInBand` argument to `yarn test`. The tests only work on Linux or Windows, not MacOS. Please run all tests and make sure they pass before submitting a pull request. Github Actions are used for CI.
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,3 @@`
`1`	`1`	`# These are supported funding model platforms`
`2`	`2`
`3`		`-custom: ['https://www.paypal.me/noahklayman', 'https://venmo.com/noahklayman']`
	`3`	`+github: nklayman`