fix(generator): remove need for <base> tag, set baseUrl instead

nklayman · nklayman · commit 5bf4771c6ca1 · 2018-10-22T13:43:36.000-07:00
diff --git a/__tests__/build.helper.js b/__tests__/build.helper.js
@@ -1,6 +1,5 @@
 const create = require('./createProject.helper.js')
 const path = require('path')
-const fs = require('fs-extra')
 const Application = require('spectron').Application
 const portfinder = require('portfinder')
 const checkLogs = require('./checkLogs.helper.js')
@@ -43,12 +42,6 @@ const runTests = useTS =>
       project.has(`dist_electron/${projectName}-0.1.0-x86_64.AppImage`)
     ).toBe(false)
     expect(project.has(`dist_electron/${projectName}_0.1.0_amd64`)).toBe(false)
-    //   Ensure base is set properly (for app protocol)
-    const index = fs.readFileSync(
-      projectPath('dist_electron/bundled/index.html'),
-      'utf8'
-    )
-    expect(index.indexOf('<base href=app://./ >')).not.toBe(-1)
     // Launch app with spectron
     const app = new Application({
       path: `./__tests__/projects/${projectName}/dist_electron/${
diff --git a/__tests__/commands.spec.js b/__tests__/commands.spec.js
@@ -86,6 +86,7 @@ const runCommand = async (command, options = {}, args = {}, rawArgs = []) => {
   pluginIndex(api, options)
   // Run the provided command
   await commands[command](args, rawArgs)
+  return { api, options }
 }
 // #endregion
 
@@ -296,6 +297,22 @@ describe('electron:build', () => {
       'projectPath/outputDir/bundled/background.js'
     )
   })
+
+  test('Base url is set to "app://./"', async () => {
+    const { options } = await runCommand('electron:build')
+    expect(options.baseUrl).toBe('app://./')
+  })
+
+  test('Base url is set to "./" if pluginOptions.noAppProtocol is set', async () => {
+    const { options } = await runCommand('electron:build', {
+      pluginOptions: {
+        electronBuilder: {
+          noAppProtocol: true
+        }
+      }
+    })
+    expect(options.baseUrl).toBe('./')
+  })
 })
 
 describe('electron:serve', () => {
diff --git a/__tests__/generator.spec.js b/__tests__/generator.spec.js
@@ -62,8 +62,8 @@ describe('.gitignore', () => {
       'apiResolve_./.gitignore',
       expect.any(String)
     )
-    // Only background.js should have been written
-    expect(fs.writeFileSync).toHaveBeenCalledTimes(1)
+    // Nothing should have been written
+    expect(fs.writeFileSync).toHaveBeenCalledTimes(0)
   })
 
   test.each(['#Electron-builder output', '/dist_electron'])(
@@ -90,43 +90,12 @@ describe('.gitignore', () => {
         'apiResolve_./.gitignore',
         expect.any(String)
       )
-      // Only index should have been written
-      expect(fs.writeFileSync).toHaveBeenCalledTimes(1)
+      // Nothing should have been written
+      expect(fs.writeFileSync).toHaveBeenCalledTimes(0)
     }
   )
 })
 
-describe('index.html', () => {
-  test.each([
-    // None
-    '',
-    // Base URL
-    `    <% if (BASE_URL === './') { %><base href="app://./" /><% } %>\n`
-  ])('Only add missing tags to index.html', existing => {
-    // Disable .gitignore modification
-    fs.existsSync.mockReturnValueOnce(false)
-    fs.readFileSync.mockImplementation((path, encoding) => {
-      // Check that utf8 encoding is set
-      expect(encoding).toBe('utf8')
-      if (path === 'apiResolve_./package.json') {
-        return JSON.stringify({ scripts: {} })
-      }
-      // return mock content
-      return `  <head>\n${existing}  </head>`
-    })
-
-    // Run the generator with mock api
-    generator(mockApi)
-    // Run the onCreateComplete callback
-    completionCb()
-
-    const index = fs.writeFileSync.mock.calls[0][1]
-    expect(index).toBe(`  <head>
-    <% if (BASE_URL === './') { %><base href="app://./" /><% } %>
-  </head>`)
-  })
-})
-
 describe('background.js', () => {
   test.each([false, true])(
     'Background file is not added if it exists',
diff --git a/generator/index.js b/generator/index.js
@@ -10,16 +10,6 @@ module.exports = (api, options = {}) => {
     api.render('./template')
   }
   api.onCreateComplete(() => {
-    //   Read existing index.html
-    let index = fs.readFileSync(api.resolve('./public/index.html'), 'utf8')
-    const tag = `<% if (BASE_URL === './') { %><base href="app://./" /><% } %>`
-    if (index.indexOf(tag) === -1) {
-      // Inject base tag if it doesn't exist
-      index = index.replace(/^\s*?<head.*?>\s*?$/m, `  <head>\n    ${tag}`)
-    }
-    //   Write updated index.html
-    fs.writeFileSync(api.resolve('./public/index.html'), index)
-
     // Update .gitignore if it exists
     if (fs.existsSync(api.resolve('./.gitignore'))) {
       let gitignore = fs.readFileSync(api.resolve('./.gitignore'), 'utf8')
diff --git a/index.js b/index.js
@@ -103,7 +103,7 @@ module.exports = (api, options) => {
             modern: !args.legacy
           }
           //   Set the base url so that the app protocol is used
-          options.baseUrl = './'
+          options.baseUrl = pluginOptions.noAppProtocol ? './' : 'app://./'
           info('Bundling render process:')
           //   Build the render process with the custom args
           await api.service.run('build', vueArgs)

Original file line number	Diff line number	Diff line change
`@@ -103,7 +103,7 @@ module.exports = (api, options) => {`
`103`	`103`	`modern: !args.legacy`
`104`	`104`	`}`
`105`	`105`	`// Set the base url so that the app protocol is used`
`106`		`- options.baseUrl = './'`
	`106`	`+ options.baseUrl = pluginOptions.noAppProtocol ? './' : 'app://./'`
`107`	`107`	`info('Bundling render process:')`
`108`	`108`	`// Build the render process with the custom args`
`109`	`109`	`await api.service.run('build', vueArgs)`