chore: rename atom things to electron things in our docs / scripts (#23100)

This commit is contained in:
Samuel Attard 2020-04-13 14:32:29 -07:00 committed by GitHub
parent 0e86163a3e
commit b03bd8c45c
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
10 changed files with 47 additions and 82 deletions

View file

@ -30,7 +30,7 @@ import {
import * as path from 'path'
// Quick start
// https://github.com/atom/electron/blob/master/docs/tutorial/quick-start.md
// https://github.com/electron/electron/blob/master/docs/tutorial/quick-start.md
// Keep a global reference of the window object, if you don't, the window will
// be closed automatically when the javascript object is GCed.
@ -172,7 +172,7 @@ app.whenReady().then(() => {
app.getLocale()
// Desktop environment integration
// https://github.com/atom/electron/blob/master/docs/tutorial/desktop-environment-integration.md
// https://github.com/electron/electron/blob/master/docs/tutorial/desktop-environment-integration.md
app.addRecentDocument('/Users/USERNAME/Desktop/work.type')
app.clearRecentDocuments()
@ -318,7 +318,7 @@ app.setAboutPanelOptions({
})
// Online/Offline Event Detection
// https://github.com/atom/electron/blob/master/docs/tutorial/online-offline-events.md
// https://github.com/electron/electron/blob/master/docs/tutorial/online-offline-events.md
let onlineStatusWindow: Electron.BrowserWindow
@ -333,7 +333,7 @@ ipcMain.on('online-status-changed', (event: any, status: any) => {
})
// Synopsis
// https://github.com/atom/electron/blob/master/docs/api/synopsis.md
// https://github.com/electron/electron/blob/master/docs/api/synopsis.md
app.whenReady().then(() => {
window = new BrowserWindow({
@ -345,7 +345,7 @@ app.whenReady().then(() => {
})
// Supported command line switches
// https://github.com/atom/electron/blob/master/docs/api/command-line-switches.md
// https://github.com/electron/electron/blob/master/docs/api/command-line-switches.md
app.commandLine.appendSwitch('remote-debugging-port', '8315')
app.commandLine.appendSwitch('host-rules', 'MAP * 127.0.0.1')
@ -385,7 +385,7 @@ if (browserOptions.transparent) {
}
// app
// https://github.com/atom/electron/blob/master/docs/api/app.md
// https://github.com/electron/electron/blob/master/docs/api/app.md
app.on('certificate-error', function (event, webContents, url, error, certificate, callback) {
if (url === 'https://github.com') {
@ -416,7 +416,7 @@ app.relaunch({ args: process.argv.slice(1).concat(['--relaunch']) })
app.exit(0)
// auto-updater
// https://github.com/atom/electron/blob/master/docs/api/auto-updater.md
// https://github.com/electron/electron/blob/master/docs/api/auto-updater.md
autoUpdater.setFeedURL({
url: 'http://mycompany.com/myapp/latest?version=' + app.getVersion(),
@ -437,7 +437,7 @@ autoUpdater.on('update-downloaded', (event, releaseNotes, releaseName, releaseDa
})
// BrowserWindow
// https://github.com/atom/electron/blob/master/docs/api/browser-window.md
// https://github.com/electron/electron/blob/master/docs/api/browser-window.md
let win3 = new BrowserWindow({ width: 800, height: 600, show: false })
win3.on('closed', () => {
@ -465,7 +465,7 @@ window.setIcon('/path/to/icon')
const installed = BrowserWindow.getDevToolsExtensions().hasOwnProperty('devtron')
// content-tracing
// https://github.com/atom/electron/blob/master/docs/api/content-tracing.md
// https://github.com/electron/electron/blob/master/docs/api/content-tracing.md
const options = {
categoryFilter: '*',
@ -482,7 +482,7 @@ contentTracing.startRecording(options).then(() => {
})
// dialog
// https://github.com/atom/electron/blob/master/docs/api/dialog.md
// https://github.com/electron/electron/blob/master/docs/api/dialog.md
// variant without browserWindow
dialog.showOpenDialogSync({
@ -503,7 +503,7 @@ dialog.showOpenDialog(win3, {
})
// global-shortcut
// https://github.com/atom/electron/blob/master/docs/api/global-shortcut.md
// https://github.com/electron/electron/blob/master/docs/api/global-shortcut.md
// Register a 'ctrl+x' shortcut listener.
const ret = globalShortcut.register('ctrl+x', () => {
@ -521,7 +521,7 @@ globalShortcut.unregister('ctrl+x')
globalShortcut.unregisterAll()
// ipcMain
// https://github.com/atom/electron/blob/master/docs/api/ipc-main-process.md
// https://github.com/electron/electron/blob/master/docs/api/ipc-main-process.md
ipcMain.on('asynchronous-message', (event, arg: any) => {
console.log(arg) // prints "ping"
@ -547,7 +547,7 @@ const winWindows = new BrowserWindow({
})
// menu-item
// https://github.com/atom/electron/blob/master/docs/api/menu-item.md
// https://github.com/electron/electron/blob/master/docs/api/menu-item.md
const menuItem = new MenuItem({})
@ -557,7 +557,7 @@ menuItem.click = (passedMenuItem: Electron.MenuItem, browserWindow: Electron.Bro
}
// menu
// https://github.com/atom/electron/blob/master/docs/api/menu.md
// https://github.com/electron/electron/blob/master/docs/api/menu.md
let menu = new Menu()
menu.append(new MenuItem({ label: 'MenuItem1', click: () => { console.log('item 1 clicked') } }))
@ -850,7 +850,7 @@ app.whenReady().then(() => {
})
// power-monitor
// https://github.com/atom/electron/blob/master/docs/api/power-monitor.md
// https://github.com/electron/electron/blob/master/docs/api/power-monitor.md
app.whenReady().then(() => {
powerMonitor.on('suspend', () => {
@ -868,7 +868,7 @@ app.whenReady().then(() => {
})
// power-save-blocker
// https://github.com/atom/electron/blob/master/docs/api/power-save-blocker.md
// https://github.com/electron/electron/blob/master/docs/api/power-save-blocker.md
const id = powerSaveBlocker.start('prevent-display-sleep')
console.log(powerSaveBlocker.isStarted(id))
@ -876,7 +876,7 @@ console.log(powerSaveBlocker.isStarted(id))
powerSaveBlocker.stop(id)
// protocol
// https://github.com/atom/electron/blob/master/docs/api/protocol.md
// https://github.com/electron/electron/blob/master/docs/api/protocol.md
app.whenReady().then(() => {
protocol.registerSchemesAsPrivileged([{ scheme: 'https', privileges: { standard: true, allowServiceWorkers: true } }])
@ -907,7 +907,7 @@ app.whenReady().then(() => {
})
// tray
// https://github.com/atom/electron/blob/master/docs/api/tray.md
// https://github.com/electron/electron/blob/master/docs/api/tray.md
let appIcon: Electron.Tray = null
app.whenReady().then(() => {
@ -950,7 +950,7 @@ app.whenReady().then(() => {
})
// clipboard
// https://github.com/atom/electron/blob/master/docs/api/clipboard.md
// https://github.com/electron/electron/blob/master/docs/api/clipboard.md
{
let str: string
@ -973,7 +973,7 @@ app.whenReady().then(() => {
}
// crash-reporter
// https://github.com/atom/electron/blob/master/docs/api/crash-reporter.md
// https://github.com/electron/electron/blob/master/docs/api/crash-reporter.md
crashReporter.start({
productName: 'YourName',
@ -989,7 +989,7 @@ console.log(crashReporter.getLastCrashReport())
console.log(crashReporter.getUploadedReports())
// nativeImage
// https://github.com/atom/electron/blob/master/docs/api/native-image.md
// https://github.com/electron/electron/blob/master/docs/api/native-image.md
const appIcon2 = new Tray('/Users/somebody/images/icon.png')
const window2 = new BrowserWindow({ icon: '/Users/somebody/images/window.png' })
@ -1014,7 +1014,7 @@ process.hang()
process.setFdLimit(8192)
// screen
// https://github.com/atom/electron/blob/master/docs/api/screen.md
// https://github.com/electron/electron/blob/master/docs/api/screen.md
app.whenReady().then(() => {
const size = screen.getPrimaryDisplay().workAreaSize
@ -1052,7 +1052,7 @@ app.whenReady().then(() => {
})
// shell
// https://github.com/atom/electron/blob/master/docs/api/shell.md
// https://github.com/electron/electron/blob/master/docs/api/shell.md
shell.showItemInFolder('/home/user/Desktop/test.txt')
shell.moveItemToTrash('/home/user/Desktop/test.txt')
@ -1070,7 +1070,7 @@ shell.beep()
shell.writeShortcutLink('/home/user/Desktop/shortcut.lnk', 'update', shell.readShortcutLink('/home/user/Desktop/shortcut.lnk'))
// cookies
// https://github.com/atom/electron/blob/master/docs/api/cookies.md
// https://github.com/electron/electron/blob/master/docs/api/cookies.md
{
const { session } = require('electron')
@ -1102,7 +1102,7 @@ shell.writeShortcutLink('/home/user/Desktop/shortcut.lnk', 'update', shell.readS
}
// session
// https://github.com/atom/electron/blob/master/docs/api/session.md
// https://github.com/electron/electron/blob/master/docs/api/session.md
session.defaultSession.on('will-download', (event, item, webContents) => {
event.preventDefault()

View file

@ -12,7 +12,7 @@ import {
import * as fs from 'fs'
// In renderer process (web page).
// https://github.com/atom/electron/blob/master/docs/api/ipc-renderer.md
// https://github.com/electron/electron/blob/master/docs/api/ipc-renderer.md
console.log(ipcRenderer.sendSync('synchronous-message', 'ping')) // prints "pong"
ipcRenderer.on('asynchronous-reply', (event, arg: any) => {
@ -23,7 +23,7 @@ ipcRenderer.on('asynchronous-reply', (event, arg: any) => {
ipcRenderer.send('asynchronous-message', 'ping')
// remote
// https://github.com/atom/electron/blob/master/docs/api/remote.md
// https://github.com/electron/electron/blob/master/docs/api/remote.md
const BrowserWindow = remote.BrowserWindow
const win = new BrowserWindow({ width: 800, height: 600 })
@ -48,7 +48,7 @@ remote.getCurrentWindow().capturePage().then(buf => {
})
// web-frame
// https://github.com/atom/electron/blob/master/docs/api/web-frame.md
// https://github.com/electron/electron/blob/master/docs/api/web-frame.md
webFrame.setZoomFactor(2)
console.log(webFrame.getZoomFactor())
@ -79,7 +79,7 @@ console.log(webFrame.getResourceUsage())
webFrame.clearCache()
// clipboard
// https://github.com/atom/electron/blob/master/docs/api/clipboard.md
// https://github.com/electron/electron/blob/master/docs/api/clipboard.md
clipboard.writeText('Example String')
clipboard.writeText('Example String', 'selection')
@ -95,7 +95,7 @@ clipboard.write({
})
// crash-reporter
// https://github.com/atom/electron/blob/master/docs/api/crash-reporter.md
// https://github.com/electron/electron/blob/master/docs/api/crash-reporter.md
crashReporter.start({
productName: 'YourName',
@ -105,7 +105,7 @@ crashReporter.start({
})
// desktopCapturer
// https://github.com/atom/electron/blob/master/docs/api/desktop-capturer.md
// https://github.com/electron/electron/blob/master/docs/api/desktop-capturer.md
const desktopCapturer = require('electron').desktopCapturer
@ -139,7 +139,7 @@ function getUserMediaError (error: Error) {
}
// File object
// https://github.com/atom/electron/blob/master/docs/api/file-object.md
// https://github.com/electron/electron/blob/master/docs/api/file-object.md
/*
<div id="holder">
@ -165,7 +165,7 @@ holder.ondrop = function (e) {
}
// nativeImage
// https://github.com/atom/electron/blob/master/docs/api/native-image.md
// https://github.com/electron/electron/blob/master/docs/api/native-image.md
const Tray = remote.Tray
const appIcon2 = new Tray('/Users/somebody/images/icon.png')
@ -185,7 +185,7 @@ process.once('loaded', function () {
})
// screen
// https://github.com/atom/electron/blob/master/docs/api/screen.md
// https://github.com/electron/electron/blob/master/docs/api/screen.md
const app = remote.app
@ -215,12 +215,12 @@ app.whenReady().then(() => {
})
// shell
// https://github.com/atom/electron/blob/master/docs/api/shell.md
// https://github.com/electron/electron/blob/master/docs/api/shell.md
shell.openExternal('https://github.com').then(() => {})
// <webview>
// https://github.com/atom/electron/blob/master/docs/api/web-view-tag.md
// https://github.com/electron/electron/blob/master/docs/api/web-view-tag.md
const webview = document.createElement('webview')
webview.loadURL('https://github.com')