From db27b9f433f6681c42c9f22910d5908e172a67fe Mon Sep 17 00:00:00 2001 From: David Sanders Date: Wed, 5 Apr 2023 06:42:20 -0700 Subject: [PATCH] chore: initial linting fixes for JS in docs/fiddles (#37689) --- docs/fiddles/features/drag-and-drop/main.js | 14 +++++----- .../keyboard-shortcuts/global/main.js | 2 +- .../features/keyboard-shortcuts/local/main.js | 2 +- .../keyboard-shortcuts/web-apis/main.js | 6 ++--- .../keyboard-shortcuts/web-apis/renderer.js | 2 +- docs/fiddles/features/macos-dock-menu/main.js | 2 +- .../notifications/renderer/renderer.js | 2 +- .../fiddles/features/represented-file/main.js | 2 +- docs/fiddles/features/web-bluetooth/main.js | 3 +-- .../fiddles/features/web-bluetooth/preload.js | 2 +- .../features/web-bluetooth/renderer.js | 6 ++--- docs/fiddles/features/web-hid/main.js | 11 ++++---- docs/fiddles/features/web-hid/renderer.js | 6 ++--- docs/fiddles/features/web-serial/main.js | 14 +++++----- docs/fiddles/features/web-serial/renderer.js | 10 +++---- docs/fiddles/features/web-usb/main.js | 15 +++++------ docs/fiddles/features/web-usb/renderer.js | 7 +++-- docs/fiddles/ipc/pattern-1/main.js | 2 +- docs/fiddles/ipc/pattern-1/preload.js | 2 +- docs/fiddles/ipc/pattern-1/renderer.js | 6 ++--- docs/fiddles/ipc/pattern-2/main.js | 6 ++--- docs/fiddles/ipc/pattern-2/preload.js | 2 +- docs/fiddles/ipc/pattern-3/main.js | 18 ++++++------- docs/fiddles/ipc/pattern-3/renderer.js | 8 +++--- .../dialogs/error-dialog/renderer.js | 2 +- .../dialogs/information-dialog/main.js | 2 -- .../dialogs/information-dialog/renderer.js | 2 +- .../dialogs/open-file-or-directory/main.js | 1 - .../native-ui/dialogs/save-dialog/renderer.js | 2 +- docs/fiddles/quick-start/main.js | 1 - docs/fiddles/quick-start/preload.js | 1 - .../main.js | 8 +++--- .../preload.js | 4 +-- .../renderer.js | 4 +-- .../app-information/main.js | 4 +-- .../app-information/renderer.js | 4 +-- docs/fiddles/tutorial-first-app/main.js | 22 ++++++++-------- docs/fiddles/tutorial-preload/main.js | 26 +++++++++---------- docs/fiddles/tutorial-preload/preload.js | 6 ++--- docs/fiddles/tutorial-preload/renderer.js | 4 +-- .../create-frameless-window/main.js | 2 +- .../manage-windows/frameless-window/main.js | 4 +-- .../manage-window-state/main.js | 2 +- .../manage-windows/new-window/renderer.js | 4 +-- package.json | 1 + 45 files changed, 122 insertions(+), 134 deletions(-) diff --git a/docs/fiddles/features/drag-and-drop/main.js b/docs/fiddles/features/drag-and-drop/main.js index 9ad158beafd5..db617ba27d8a 100644 --- a/docs/fiddles/features/drag-and-drop/main.js +++ b/docs/fiddles/features/drag-and-drop/main.js @@ -1,9 +1,9 @@ -const { app, BrowserWindow, ipcMain, nativeImage, NativeImage } = require('electron') +const { app, BrowserWindow, ipcMain } = require('electron') const path = require('path') const fs = require('fs') const https = require('https') -function createWindow() { +function createWindow () { const win = new BrowserWindow({ width: 800, height: 600, @@ -15,23 +15,23 @@ function createWindow() { win.loadFile('index.html') } -const iconName = path.join(__dirname, 'iconForDragAndDrop.png'); -const icon = fs.createWriteStream(iconName); +const iconName = path.join(__dirname, 'iconForDragAndDrop.png') +const icon = fs.createWriteStream(iconName) // Create a new file to copy - you can also copy existing files. fs.writeFileSync(path.join(__dirname, 'drag-and-drop-1.md'), '# First file to test drag and drop') fs.writeFileSync(path.join(__dirname, 'drag-and-drop-2.md'), '# Second file to test drag and drop') https.get('https://img.icons8.com/ios/452/drag-and-drop.png', (response) => { - response.pipe(icon); -}); + response.pipe(icon) +}) app.whenReady().then(createWindow) ipcMain.on('ondragstart', (event, filePath) => { event.sender.startDrag({ file: path.join(__dirname, filePath), - icon: iconName, + icon: iconName }) }) diff --git a/docs/fiddles/features/keyboard-shortcuts/global/main.js b/docs/fiddles/features/keyboard-shortcuts/global/main.js index 24b2d343fbaa..8b43433a4a4e 100644 --- a/docs/fiddles/features/keyboard-shortcuts/global/main.js +++ b/docs/fiddles/features/keyboard-shortcuts/global/main.js @@ -3,7 +3,7 @@ const { app, BrowserWindow, globalShortcut } = require('electron') function createWindow () { const win = new BrowserWindow({ width: 800, - height: 600, + height: 600 }) win.loadFile('index.html') diff --git a/docs/fiddles/features/keyboard-shortcuts/local/main.js b/docs/fiddles/features/keyboard-shortcuts/local/main.js index c583469df482..6abd81b1be37 100644 --- a/docs/fiddles/features/keyboard-shortcuts/local/main.js +++ b/docs/fiddles/features/keyboard-shortcuts/local/main.js @@ -3,7 +3,7 @@ const { app, BrowserWindow, Menu, MenuItem } = require('electron') function createWindow () { const win = new BrowserWindow({ width: 800, - height: 600, + height: 600 }) win.loadFile('index.html') diff --git a/docs/fiddles/features/keyboard-shortcuts/web-apis/main.js b/docs/fiddles/features/keyboard-shortcuts/web-apis/main.js index 876d7632b223..7803cd859db5 100644 --- a/docs/fiddles/features/keyboard-shortcuts/web-apis/main.js +++ b/docs/fiddles/features/keyboard-shortcuts/web-apis/main.js @@ -1,17 +1,15 @@ // Modules to control application life and create native browser window -const {app, BrowserWindow} = require('electron') -const path = require('path') +const { app, BrowserWindow } = require('electron') function createWindow () { // Create the browser window. const mainWindow = new BrowserWindow({ width: 800, - height: 600, + height: 600 }) // and load the index.html of the app. mainWindow.loadFile('index.html') - } // This method will be called when Electron has finished diff --git a/docs/fiddles/features/keyboard-shortcuts/web-apis/renderer.js b/docs/fiddles/features/keyboard-shortcuts/web-apis/renderer.js index 7f7e406c4b2c..e3e05209207d 100644 --- a/docs/fiddles/features/keyboard-shortcuts/web-apis/renderer.js +++ b/docs/fiddles/features/keyboard-shortcuts/web-apis/renderer.js @@ -1,6 +1,6 @@ function handleKeyPress (event) { // You can put code here to handle the keypress. - document.getElementById("last-keypress").innerText = event.key + document.getElementById('last-keypress').innerText = event.key console.log(`You pressed ${event.key}`) } diff --git a/docs/fiddles/features/macos-dock-menu/main.js b/docs/fiddles/features/macos-dock-menu/main.js index f7f86a2361a8..7809e5459c60 100644 --- a/docs/fiddles/features/macos-dock-menu/main.js +++ b/docs/fiddles/features/macos-dock-menu/main.js @@ -3,7 +3,7 @@ const { app, BrowserWindow, Menu } = require('electron') function createWindow () { const win = new BrowserWindow({ width: 800, - height: 600, + height: 600 }) win.loadFile('index.html') diff --git a/docs/fiddles/features/notifications/renderer/renderer.js b/docs/fiddles/features/notifications/renderer/renderer.js index a6c88f9a7946..3b782f1f1788 100644 --- a/docs/fiddles/features/notifications/renderer/renderer.js +++ b/docs/fiddles/features/notifications/renderer/renderer.js @@ -3,4 +3,4 @@ const NOTIFICATION_BODY = 'Notification from the Renderer process. Click to log const CLICK_MESSAGE = 'Notification clicked!' new Notification(NOTIFICATION_TITLE, { body: NOTIFICATION_BODY }) - .onclick = () => document.getElementById("output").innerText = CLICK_MESSAGE + .onclick = () => document.getElementById('output').innerText = CLICK_MESSAGE diff --git a/docs/fiddles/features/represented-file/main.js b/docs/fiddles/features/represented-file/main.js index 204a3fc4586e..387047b5d0a7 100644 --- a/docs/fiddles/features/represented-file/main.js +++ b/docs/fiddles/features/represented-file/main.js @@ -1,5 +1,5 @@ const { app, BrowserWindow } = require('electron') -const os = require('os'); +const os = require('os') function createWindow () { const win = new BrowserWindow({ diff --git a/docs/fiddles/features/web-bluetooth/main.js b/docs/fiddles/features/web-bluetooth/main.js index 4d6e6d38e27c..e5fd0110ba85 100644 --- a/docs/fiddles/features/web-bluetooth/main.js +++ b/docs/fiddles/features/web-bluetooth/main.js @@ -1,4 +1,4 @@ -const {app, BrowserWindow, ipcMain} = require('electron') +const { app, BrowserWindow, ipcMain } = require('electron') const path = require('path') let bluetoothPinCallback @@ -38,7 +38,6 @@ function createWindow () { }) mainWindow.webContents.session.setBluetoothPairingHandler((details, callback) => { - bluetoothPinCallback = callback // Send a message to the renderer to prompt the user to confirm the pairing. mainWindow.webContents.send('bluetooth-pairing-request', details) diff --git a/docs/fiddles/features/web-bluetooth/preload.js b/docs/fiddles/features/web-bluetooth/preload.js index a8d30560368e..d10666b7ee23 100644 --- a/docs/fiddles/features/web-bluetooth/preload.js +++ b/docs/fiddles/features/web-bluetooth/preload.js @@ -4,4 +4,4 @@ contextBridge.exposeInMainWorld('electronAPI', { cancelBluetoothRequest: (callback) => ipcRenderer.send('cancel-bluetooth-request', callback), bluetoothPairingRequest: (callback) => ipcRenderer.on('bluetooth-pairing-request', callback), bluetoothPairingResponse: (response) => ipcRenderer.send('bluetooth-pairing-response', response) -}) \ No newline at end of file +}) diff --git a/docs/fiddles/features/web-bluetooth/renderer.js b/docs/fiddles/features/web-bluetooth/renderer.js index 241c253de015..24f8cec1fc67 100644 --- a/docs/fiddles/features/web-bluetooth/renderer.js +++ b/docs/fiddles/features/web-bluetooth/renderer.js @@ -1,11 +1,11 @@ -async function testIt() { +async function testIt () { const device = await navigator.bluetooth.requestDevice({ acceptAllDevices: true }) document.getElementById('device-name').innerHTML = device.name || `ID: ${device.id}` } -document.getElementById('clickme').addEventListener('click',testIt) +document.getElementById('clickme').addEventListener('click', testIt) function cancelRequest() { window.electronAPI.cancelBluetoothRequest() @@ -37,4 +37,4 @@ window.electronAPI.bluetoothPairingRequest((event, details) => { } window.electronAPI.bluetoothPairingResponse(response) -}) \ No newline at end of file +}) diff --git a/docs/fiddles/features/web-hid/main.js b/docs/fiddles/features/web-hid/main.js index 5626a919beb1..b5dcb5aea414 100644 --- a/docs/fiddles/features/web-hid/main.js +++ b/docs/fiddles/features/web-hid/main.js @@ -1,5 +1,4 @@ -const {app, BrowserWindow} = require('electron') -const path = require('path') +const { app, BrowserWindow } = require('electron') function createWindow () { const mainWindow = new BrowserWindow({ @@ -8,16 +7,16 @@ function createWindow () { }) mainWindow.webContents.session.on('select-hid-device', (event, details, callback) => { - //Add events to handle devices being added or removed before the callback on - //`select-hid-device` is called. + // Add events to handle devices being added or removed before the callback on + // `select-hid-device` is called. mainWindow.webContents.session.on('hid-device-added', (event, device) => { console.log('hid-device-added FIRED WITH', device) - //Optionally update details.deviceList + // Optionally update details.deviceList }) mainWindow.webContents.session.on('hid-device-removed', (event, device) => { console.log('hid-device-removed FIRED WITH', device) - //Optionally update details.deviceList + // Optionally update details.deviceList }) event.preventDefault() diff --git a/docs/fiddles/features/web-hid/renderer.js b/docs/fiddles/features/web-hid/renderer.js index 54bda3f97710..cbb00ab08fa7 100644 --- a/docs/fiddles/features/web-hid/renderer.js +++ b/docs/fiddles/features/web-hid/renderer.js @@ -1,4 +1,4 @@ -async function testIt() { +async function testIt () { const grantedDevices = await navigator.hid.getDevices() let grantedDeviceList = '' grantedDevices.forEach(device => { @@ -10,10 +10,10 @@ async function testIt() { }) grantedDeviceList = '' - grantedDevices2.forEach(device => { + grantedDevices2.forEach(device => { grantedDeviceList += `
${device.productName}` }) document.getElementById('granted-devices2').innerHTML = grantedDeviceList } -document.getElementById('clickme').addEventListener('click',testIt) +document.getElementById('clickme').addEventListener('click', testIt) diff --git a/docs/fiddles/features/web-serial/main.js b/docs/fiddles/features/web-serial/main.js index e88c509fc400..55d40d203805 100644 --- a/docs/fiddles/features/web-serial/main.js +++ b/docs/fiddles/features/web-serial/main.js @@ -1,5 +1,4 @@ -const {app, BrowserWindow} = require('electron') -const path = require('path') +const { app, BrowserWindow } = require('electron') function createWindow () { const mainWindow = new BrowserWindow({ @@ -8,24 +7,23 @@ function createWindow () { }) mainWindow.webContents.session.on('select-serial-port', (event, portList, webContents, callback) => { - - //Add listeners to handle ports being added or removed before the callback for `select-serial-port` - //is called. + // Add listeners to handle ports being added or removed before the callback for `select-serial-port` + // is called. mainWindow.webContents.session.on('serial-port-added', (event, port) => { console.log('serial-port-added FIRED WITH', port) - //Optionally update portList to add the new port + // Optionally update portList to add the new port }) mainWindow.webContents.session.on('serial-port-removed', (event, port) => { console.log('serial-port-removed FIRED WITH', port) - //Optionally update portList to remove the port + // Optionally update portList to remove the port }) event.preventDefault() if (portList && portList.length > 0) { callback(portList[0].portId) } else { - callback('') //Could not find any matching devices + callback('') // Could not find any matching devices } }) diff --git a/docs/fiddles/features/web-serial/renderer.js b/docs/fiddles/features/web-serial/renderer.js index 1d684d219252..2c5eb369804c 100644 --- a/docs/fiddles/features/web-serial/renderer.js +++ b/docs/fiddles/features/web-serial/renderer.js @@ -1,11 +1,11 @@ -async function testIt() { +async function testIt () { const filters = [ { usbVendorId: 0x2341, usbProductId: 0x0043 }, { usbVendorId: 0x2341, usbProductId: 0x0001 } - ]; + ] try { - const port = await navigator.serial.requestPort({filters}); - const portInfo = port.getInfo(); + const port = await navigator.serial.requestPort({ filters }) + const portInfo = port.getInfo() document.getElementById('device-name').innerHTML = `vendorId: ${portInfo.usbVendorId} | productId: ${portInfo.usbProductId} ` } catch (ex) { if (ex.name === 'NotFoundError') { @@ -16,4 +16,4 @@ async function testIt() { } } -document.getElementById('clickme').addEventListener('click',testIt) +document.getElementById('clickme').addEventListener('click', testIt) diff --git a/docs/fiddles/features/web-usb/main.js b/docs/fiddles/features/web-usb/main.js index 14983093c6bb..2534ae97cb76 100644 --- a/docs/fiddles/features/web-usb/main.js +++ b/docs/fiddles/features/web-usb/main.js @@ -1,5 +1,4 @@ -const {app, BrowserWindow} = require('electron') -const path = require('path') +const { app, BrowserWindow } = require('electron') function createWindow () { const mainWindow = new BrowserWindow({ @@ -10,22 +9,22 @@ function createWindow () { let grantedDeviceThroughPermHandler mainWindow.webContents.session.on('select-usb-device', (event, details, callback) => { - //Add events to handle devices being added or removed before the callback on - //`select-usb-device` is called. + // Add events to handle devices being added or removed before the callback on + // `select-usb-device` is called. mainWindow.webContents.session.on('usb-device-added', (event, device) => { console.log('usb-device-added FIRED WITH', device) - //Optionally update details.deviceList + // Optionally update details.deviceList }) mainWindow.webContents.session.on('usb-device-removed', (event, device) => { console.log('usb-device-removed FIRED WITH', device) - //Optionally update details.deviceList + // Optionally update details.deviceList }) event.preventDefault() if (details.deviceList && details.deviceList.length > 0) { - const deviceToReturn = details.deviceList.find((device) => { - if (!grantedDeviceThroughPermHandler || (device.deviceId != grantedDeviceThroughPermHandler.deviceId)) { + const deviceToReturn = details.deviceList.find((device) => { + if (!grantedDeviceThroughPermHandler || (device.deviceId !== grantedDeviceThroughPermHandler.deviceId)) { return true } }) diff --git a/docs/fiddles/features/web-usb/renderer.js b/docs/fiddles/features/web-usb/renderer.js index 8544353f0fb9..d55b0ccef742 100644 --- a/docs/fiddles/features/web-usb/renderer.js +++ b/docs/fiddles/features/web-usb/renderer.js @@ -1,8 +1,8 @@ -function getDeviceDetails(device) { +function getDeviceDetails (device) { return device.productName || `Unknown device ${device.deviceId}` } -async function testIt() { +async function testIt () { const noDevicesFoundMsg = 'No devices found' const grantedDevices = await navigator.usb.getDevices() let grantedDeviceList = '' @@ -21,7 +21,6 @@ async function testIt() { filters: [] }) grantedDeviceList += `
${getDeviceDetails(device)}` - } catch (ex) { if (ex.name === 'NotFoundError') { grantedDeviceList = noDevicesFoundMsg @@ -30,4 +29,4 @@ async function testIt() { document.getElementById('granted-devices2').innerHTML = grantedDeviceList } -document.getElementById('clickme').addEventListener('click',testIt) +document.getElementById('clickme').addEventListener('click', testIt) diff --git a/docs/fiddles/ipc/pattern-1/main.js b/docs/fiddles/ipc/pattern-1/main.js index c561edc78389..567baf40290c 100644 --- a/docs/fiddles/ipc/pattern-1/main.js +++ b/docs/fiddles/ipc/pattern-1/main.js @@ -1,4 +1,4 @@ -const {app, BrowserWindow, ipcMain} = require('electron') +const { app, BrowserWindow, ipcMain } = require('electron') const path = require('path') function createWindow () { diff --git a/docs/fiddles/ipc/pattern-1/preload.js b/docs/fiddles/ipc/pattern-1/preload.js index 822f4ed51622..50b3f3d4b1e4 100644 --- a/docs/fiddles/ipc/pattern-1/preload.js +++ b/docs/fiddles/ipc/pattern-1/preload.js @@ -1,5 +1,5 @@ const { contextBridge, ipcRenderer } = require('electron') contextBridge.exposeInMainWorld('electronAPI', { - setTitle: (title) => ipcRenderer.send('set-title', title) + setTitle: (title) => ipcRenderer.send('set-title', title) }) diff --git a/docs/fiddles/ipc/pattern-1/renderer.js b/docs/fiddles/ipc/pattern-1/renderer.js index c44f59a8df08..67b775fa5394 100644 --- a/docs/fiddles/ipc/pattern-1/renderer.js +++ b/docs/fiddles/ipc/pattern-1/renderer.js @@ -1,6 +1,6 @@ const setButton = document.getElementById('btn') const titleInput = document.getElementById('title') setButton.addEventListener('click', () => { - const title = titleInput.value - window.electronAPI.setTitle(title) -}); + const title = titleInput.value + window.electronAPI.setTitle(title) +}) diff --git a/docs/fiddles/ipc/pattern-2/main.js b/docs/fiddles/ipc/pattern-2/main.js index 5492a7d15929..7257ab117b04 100644 --- a/docs/fiddles/ipc/pattern-2/main.js +++ b/docs/fiddles/ipc/pattern-2/main.js @@ -1,10 +1,10 @@ -const {app, BrowserWindow, ipcMain, dialog} = require('electron') +const { app, BrowserWindow, ipcMain, dialog } = require('electron') const path = require('path') -async function handleFileOpen() { +async function handleFileOpen () { const { canceled, filePaths } = await dialog.showOpenDialog() if (canceled) { - return + } else { return filePaths[0] } diff --git a/docs/fiddles/ipc/pattern-2/preload.js b/docs/fiddles/ipc/pattern-2/preload.js index cb78f84230f8..5f2f6e220553 100644 --- a/docs/fiddles/ipc/pattern-2/preload.js +++ b/docs/fiddles/ipc/pattern-2/preload.js @@ -1,5 +1,5 @@ const { contextBridge, ipcRenderer } = require('electron') -contextBridge.exposeInMainWorld('electronAPI',{ +contextBridge.exposeInMainWorld('electronAPI', { openFile: () => ipcRenderer.invoke('dialog:openFile') }) diff --git a/docs/fiddles/ipc/pattern-3/main.js b/docs/fiddles/ipc/pattern-3/main.js index 4f1e1b4bf16e..4c2334dfb082 100644 --- a/docs/fiddles/ipc/pattern-3/main.js +++ b/docs/fiddles/ipc/pattern-3/main.js @@ -1,4 +1,4 @@ -const {app, BrowserWindow, Menu, ipcMain} = require('electron') +const { app, BrowserWindow, Menu, ipcMain } = require('electron') const path = require('path') function createWindow () { @@ -12,14 +12,14 @@ function createWindow () { { label: app.name, submenu: [ - { - click: () => mainWindow.webContents.send('update-counter', 1), - label: 'Increment', - }, - { - click: () => mainWindow.webContents.send('update-counter', -1), - label: 'Decrement', - } + { + click: () => mainWindow.webContents.send('update-counter', 1), + label: 'Increment' + }, + { + click: () => mainWindow.webContents.send('update-counter', -1), + label: 'Decrement' + } ] } diff --git a/docs/fiddles/ipc/pattern-3/renderer.js b/docs/fiddles/ipc/pattern-3/renderer.js index 04fd4bca890a..d7316a5d87f1 100644 --- a/docs/fiddles/ipc/pattern-3/renderer.js +++ b/docs/fiddles/ipc/pattern-3/renderer.js @@ -1,8 +1,8 @@ const counter = document.getElementById('counter') window.electronAPI.handleCounter((event, value) => { - const oldValue = Number(counter.innerText) - const newValue = oldValue + value - counter.innerText = newValue - event.sender.send('counter-value', newValue) + const oldValue = Number(counter.innerText) + const newValue = oldValue + value + counter.innerText = newValue + event.sender.send('counter-value', newValue) }) diff --git a/docs/fiddles/native-ui/dialogs/error-dialog/renderer.js b/docs/fiddles/native-ui/dialogs/error-dialog/renderer.js index 4011066587dc..a0221af5efd7 100644 --- a/docs/fiddles/native-ui/dialogs/error-dialog/renderer.js +++ b/docs/fiddles/native-ui/dialogs/error-dialog/renderer.js @@ -15,4 +15,4 @@ Array.prototype.forEach.call(links, (link) => { shell.openExternal(url) }) } -}) \ No newline at end of file +}) diff --git a/docs/fiddles/native-ui/dialogs/information-dialog/main.js b/docs/fiddles/native-ui/dialogs/information-dialog/main.js index 3e81a5782076..e30f8c378b6e 100644 --- a/docs/fiddles/native-ui/dialogs/information-dialog/main.js +++ b/docs/fiddles/native-ui/dialogs/information-dialog/main.js @@ -52,7 +52,6 @@ app.on('activate', function () { } }) - ipcMain.on('open-information-dialog', event => { const options = { type: 'info', @@ -65,6 +64,5 @@ ipcMain.on('open-information-dialog', event => { }) }) - // In this file you can include the rest of your app's specific main process // code. You can also put them in separate files and require them here. diff --git a/docs/fiddles/native-ui/dialogs/information-dialog/renderer.js b/docs/fiddles/native-ui/dialogs/information-dialog/renderer.js index 69ea9cdb1a2f..5e46971b273f 100644 --- a/docs/fiddles/native-ui/dialogs/information-dialog/renderer.js +++ b/docs/fiddles/native-ui/dialogs/information-dialog/renderer.js @@ -22,4 +22,4 @@ Array.prototype.forEach.call(links, (link) => { shell.openExternal(url) }) } -}) \ No newline at end of file +}) diff --git a/docs/fiddles/native-ui/dialogs/open-file-or-directory/main.js b/docs/fiddles/native-ui/dialogs/open-file-or-directory/main.js index 24b9164dab3a..b3f4b42926f0 100644 --- a/docs/fiddles/native-ui/dialogs/open-file-or-directory/main.js +++ b/docs/fiddles/native-ui/dialogs/open-file-or-directory/main.js @@ -52,7 +52,6 @@ app.on('activate', function () { } }) - ipcMain.on('open-file-dialog', event => { dialog.showOpenDialog( { diff --git a/docs/fiddles/native-ui/dialogs/save-dialog/renderer.js b/docs/fiddles/native-ui/dialogs/save-dialog/renderer.js index 9f6da5546946..db9bb5c1d471 100644 --- a/docs/fiddles/native-ui/dialogs/save-dialog/renderer.js +++ b/docs/fiddles/native-ui/dialogs/save-dialog/renderer.js @@ -20,4 +20,4 @@ Array.prototype.forEach.call(links, (link) => { shell.openExternal(url) }) } -}) \ No newline at end of file +}) diff --git a/docs/fiddles/quick-start/main.js b/docs/fiddles/quick-start/main.js index 519a67947cdb..ba8a65d05d7b 100644 --- a/docs/fiddles/quick-start/main.js +++ b/docs/fiddles/quick-start/main.js @@ -28,4 +28,3 @@ app.on('window-all-closed', () => { app.quit() } }) - diff --git a/docs/fiddles/quick-start/preload.js b/docs/fiddles/quick-start/preload.js index 7674d012240c..d5f73597ee86 100644 --- a/docs/fiddles/quick-start/preload.js +++ b/docs/fiddles/quick-start/preload.js @@ -8,4 +8,3 @@ window.addEventListener('DOMContentLoaded', () => { replaceText(`${type}-version`, process.versions[type]) } }) - diff --git a/docs/fiddles/system/protocol-handler/launch-app-from-URL-in-another-app/main.js b/docs/fiddles/system/protocol-handler/launch-app-from-URL-in-another-app/main.js index fafb18143d5b..154ba3802030 100644 --- a/docs/fiddles/system/protocol-handler/launch-app-from-URL-in-another-app/main.js +++ b/docs/fiddles/system/protocol-handler/launch-app-from-URL-in-another-app/main.js @@ -2,14 +2,14 @@ const { app, BrowserWindow, ipcMain, shell, dialog } = require('electron') const path = require('path') -let mainWindow; +let mainWindow if (process.defaultApp) { if (process.argv.length >= 2) { app.setAsDefaultProtocolClient('electron-fiddle', process.execPath, [path.resolve(process.argv[1])]) } } else { - app.setAsDefaultProtocolClient('electron-fiddle') + app.setAsDefaultProtocolClient('electron-fiddle') } const gotTheLock = app.requestSingleInstanceLock() @@ -24,7 +24,7 @@ if (!gotTheLock) { mainWindow.focus() } - dialog.showErrorBox('Welcome Back', `You arrived from: ${commandLine.pop().slice(0,-1)}`) + dialog.showErrorBox('Welcome Back', `You arrived from: ${commandLine.pop().slice(0, -1)}`) }) // Create mainWindow, load the rest of the app, etc... @@ -43,7 +43,7 @@ function createWindow () { width: 800, height: 600, webPreferences: { - preload: path.join(__dirname, 'preload.js'), + preload: path.join(__dirname, 'preload.js') } }) diff --git a/docs/fiddles/system/protocol-handler/launch-app-from-URL-in-another-app/preload.js b/docs/fiddles/system/protocol-handler/launch-app-from-URL-in-another-app/preload.js index 1eebf784ad67..13e803ad9cf2 100644 --- a/docs/fiddles/system/protocol-handler/launch-app-from-URL-in-another-app/preload.js +++ b/docs/fiddles/system/protocol-handler/launch-app-from-URL-in-another-app/preload.js @@ -6,6 +6,6 @@ const { contextBridge, ipcRenderer } = require('electron') contextBridge.exposeInMainWorld( 'shell', { - open: () => ipcRenderer.send('shell:open'), + open: () => ipcRenderer.send('shell:open') } -) \ No newline at end of file +) diff --git a/docs/fiddles/system/protocol-handler/launch-app-from-URL-in-another-app/renderer.js b/docs/fiddles/system/protocol-handler/launch-app-from-URL-in-another-app/renderer.js index 525f25ff2e76..a933c04e70a8 100644 --- a/docs/fiddles/system/protocol-handler/launch-app-from-URL-in-another-app/renderer.js +++ b/docs/fiddles/system/protocol-handler/launch-app-from-URL-in-another-app/renderer.js @@ -4,5 +4,5 @@ // Binds the buttons to the context bridge API. document.getElementById('open-in-browser').addEventListener('click', () => { - shell.open(); -}); \ No newline at end of file + window.shell.open() +}) diff --git a/docs/fiddles/system/system-app-user-information/app-information/main.js b/docs/fiddles/system/system-app-user-information/app-information/main.js index 64141f98e88d..97e612c4b2e8 100644 --- a/docs/fiddles/system/system-app-user-information/app-information/main.js +++ b/docs/fiddles/system/system-app-user-information/app-information/main.js @@ -1,5 +1,5 @@ -const {app, ipcMain} = require('electron') +const { app, ipcMain } = require('electron') ipcMain.on('get-app-path', (event) => { event.sender.send('got-app-path', app.getAppPath()) -}) \ No newline at end of file +}) diff --git a/docs/fiddles/system/system-app-user-information/app-information/renderer.js b/docs/fiddles/system/system-app-user-information/app-information/renderer.js index 3f971abcab7c..6a348da87183 100644 --- a/docs/fiddles/system/system-app-user-information/app-information/renderer.js +++ b/docs/fiddles/system/system-app-user-information/app-information/renderer.js @@ -1,4 +1,4 @@ -const {ipcRenderer} = require('electron') +const { ipcRenderer } = require('electron') const appInfoBtn = document.getElementById('app-info') const electron_doc_link = document.querySelectorAll('a[href]') @@ -15,4 +15,4 @@ ipcRenderer.on('got-app-path', (event, path) => { electron_doc_link.addEventListener('click', (e) => { e.preventDefault() shell.openExternal(url) -}) \ No newline at end of file +}) diff --git a/docs/fiddles/tutorial-first-app/main.js b/docs/fiddles/tutorial-first-app/main.js index 10d57a0696f0..fdb092a9d4fc 100644 --- a/docs/fiddles/tutorial-first-app/main.js +++ b/docs/fiddles/tutorial-first-app/main.js @@ -1,26 +1,26 @@ -const { app, BrowserWindow } = require('electron'); +const { app, BrowserWindow } = require('electron') const createWindow = () => { const win = new BrowserWindow({ width: 800, - height: 600, - }); + height: 600 + }) - win.loadFile('index.html'); -}; + win.loadFile('index.html') +} app.whenReady().then(() => { - createWindow(); + createWindow() app.on('activate', () => { if (BrowserWindow.getAllWindows().length === 0) { - createWindow(); + createWindow() } - }); -}); + }) +}) app.on('window-all-closed', () => { if (process.platform !== 'darwin') { - app.quit(); + app.quit() } -}); +}) diff --git a/docs/fiddles/tutorial-preload/main.js b/docs/fiddles/tutorial-preload/main.js index 6b7184900e6d..7b854f5ec2a1 100644 --- a/docs/fiddles/tutorial-preload/main.js +++ b/docs/fiddles/tutorial-preload/main.js @@ -1,30 +1,30 @@ -const { app, BrowserWindow } = require('electron'); -const path = require('path'); +const { app, BrowserWindow } = require('electron') +const path = require('path') const createWindow = () => { const win = new BrowserWindow({ width: 800, height: 600, webPreferences: { - preload: path.join(__dirname, 'preload.js'), - }, - }); + preload: path.join(__dirname, 'preload.js') + } + }) - win.loadFile('index.html'); -}; + win.loadFile('index.html') +} app.whenReady().then(() => { - createWindow(); + createWindow() app.on('activate', () => { if (BrowserWindow.getAllWindows().length === 0) { - createWindow(); + createWindow() } - }); -}); + }) +}) app.on('window-all-closed', () => { if (process.platform !== 'darwin') { - app.quit(); + app.quit() } -}); +}) diff --git a/docs/fiddles/tutorial-preload/preload.js b/docs/fiddles/tutorial-preload/preload.js index e0dbdce1b8b2..4d0213eedb8e 100644 --- a/docs/fiddles/tutorial-preload/preload.js +++ b/docs/fiddles/tutorial-preload/preload.js @@ -1,7 +1,7 @@ -const { contextBridge } = require('electron'); +const { contextBridge } = require('electron') contextBridge.exposeInMainWorld('versions', { node: () => process.versions.node, chrome: () => process.versions.chrome, - electron: () => process.versions.electron, -}); + electron: () => process.versions.electron +}) diff --git a/docs/fiddles/tutorial-preload/renderer.js b/docs/fiddles/tutorial-preload/renderer.js index 7585229a9178..df60659df268 100644 --- a/docs/fiddles/tutorial-preload/renderer.js +++ b/docs/fiddles/tutorial-preload/renderer.js @@ -1,2 +1,2 @@ -const information = document.getElementById('info'); -information.innerText = `This app is using Chrome (v${versions.chrome()}), Node.js (v${versions.node()}), and Electron (v${versions.electron()})`; +const information = document.getElementById('info') +information.innerText = `This app is using Chrome (v${versions.chrome()}), Node.js (v${versions.node()}), and Electron (v${versions.electron()})` diff --git a/docs/fiddles/windows/manage-windows/create-frameless-window/main.js b/docs/fiddles/windows/manage-windows/create-frameless-window/main.js index 05d530736a3b..9090767da9da 100644 --- a/docs/fiddles/windows/manage-windows/create-frameless-window/main.js +++ b/docs/fiddles/windows/manage-windows/create-frameless-window/main.js @@ -1,6 +1,6 @@ const { app, BrowserWindow, ipcMain } = require('electron') -ipcMain.on('create-frameless-window', (event, {url}) => { +ipcMain.on('create-frameless-window', (event, { url }) => { const win = new BrowserWindow({ frame: false }) win.loadURL(url) }) diff --git a/docs/fiddles/windows/manage-windows/frameless-window/main.js b/docs/fiddles/windows/manage-windows/frameless-window/main.js index d7925cd7ff4a..60a9c08d4fa3 100644 --- a/docs/fiddles/windows/manage-windows/frameless-window/main.js +++ b/docs/fiddles/windows/manage-windows/frameless-window/main.js @@ -1,7 +1,7 @@ // Modules to control application life and create native browser window -const { app, BrowserWindow } = require('electron') +const { app, BrowserWindow, ipcMain } = require('electron') -ipcMain.on('create-frameless-window', (event, {url}) => { +ipcMain.on('create-frameless-window', (event, { url }) => { const win = new BrowserWindow({ frame: false }) win.loadURL(url) }) diff --git a/docs/fiddles/windows/manage-windows/manage-window-state/main.js b/docs/fiddles/windows/manage-windows/manage-window-state/main.js index 166ff0fa62f5..81bb22fdde10 100644 --- a/docs/fiddles/windows/manage-windows/manage-window-state/main.js +++ b/docs/fiddles/windows/manage-windows/manage-window-state/main.js @@ -4,7 +4,7 @@ const { app, BrowserWindow, ipcMain } = require('electron') ipcMain.on('create-demo-window', (event) => { const win = new BrowserWindow({ width: 400, height: 275 }) - function updateReply() { + function updateReply () { event.sender.send('bounds-changed', { size: win.getSize(), position: win.getPosition() diff --git a/docs/fiddles/windows/manage-windows/new-window/renderer.js b/docs/fiddles/windows/manage-windows/new-window/renderer.js index ccb8b2264329..0b5288d4f919 100644 --- a/docs/fiddles/windows/manage-windows/new-window/renderer.js +++ b/docs/fiddles/windows/manage-windows/new-window/renderer.js @@ -5,10 +5,10 @@ const link = document.getElementById('browser-window-link') newWindowBtn.addEventListener('click', (event) => { const url = 'https://electronjs.org' - ipcRenderer.send('new-window', { url, width: 400, height: 320 }); + ipcRenderer.send('new-window', { url, width: 400, height: 320 }) }) link.addEventListener('click', (e) => { e.preventDefault() - shell.openExternal("https://electronjs.org/docs/api/browser-window") + shell.openExternal('https://electronjs.org/docs/api/browser-window') }) diff --git a/package.json b/package.json index eee87665621e..7d90e783cb83 100644 --- a/package.json +++ b/package.json @@ -95,6 +95,7 @@ "lint:py": "node ./script/lint.js --py", "lint:gn": "node ./script/lint.js --gn", "lint:docs": "remark docs -qf && npm run lint:js-in-markdown && npm run create-typescript-definitions && npm run lint:docs-relative-links && npm run lint:markdownlint", + "lint:docs-fiddles": "standard \"docs/fiddles/**/*.js\"", "lint:docs-relative-links": "ts-node script/lint-docs-links.ts", "lint:markdownlint": "markdownlint -r ./script/markdownlint-emd001.js \"*.md\" \"docs/**/*.md\"", "lint:js-in-markdown": "standard-markdown docs",