diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
index 695deeb..66f9b6d 100644
--- a/.github/workflows/release.yml
+++ b/.github/workflows/release.yml
@@ -17,26 +17,18 @@ jobs:
steps:
- name: Check out Git repository
- uses: actions/checkout@v1
+ uses: actions/checkout@v4
- - name: Install Node.js, NPM and Yarn
- uses: actions/setup-node@v1
+ - name: Install Node.js
+ uses: actions/setup-node@v4
with:
- node-version: 12
+ node-version: 22
- name: Install dependencies
run: npm install
- - name: Test
- run: npm test
-
- name: Build/release Electron app
uses: samuelmeuli/action-electron-builder@v1
with:
- # GitHub token, automatically provided to the action
- # (No need to define this secret in the repo settings)
github_token: ${{ secrets.GITHUB_TOKEN }}
-
- # If the commit is tagged with a version (e.g. "v1.0.0"),
- # release the app after building
release: ${{ startsWith(github.ref, 'refs/tags/v') || contains(github.event.head_commit.message, '/release') }}
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
new file mode 100644
index 0000000..8e19e57
--- /dev/null
+++ b/.github/workflows/test.yml
@@ -0,0 +1,28 @@
+name: Build/test
+
+on:
+ push:
+ pull_request:
+
+jobs:
+ test:
+ runs-on: ${{ matrix.os }}
+
+ strategy:
+ matrix:
+ os: [macos-latest, ubuntu-latest, windows-latest]
+
+ steps:
+ - name: Check out Git repository
+ uses: actions/checkout@v4
+
+ - name: Install Node.js
+ uses: actions/setup-node@v4
+ with:
+ node-version: 22
+
+ - name: Install dependencies
+ run: npm install
+
+ - name: Test
+ run: npm test
diff --git a/README-ja.md b/README-ja.md
index 61b3b47..878b588 100644
--- a/README-ja.md
+++ b/README-ja.md
@@ -32,8 +32,8 @@ Windowsでは、トレイのアイコンをクリックすると、ウィンド
### グローバルショートカット
-
-Ctrl+Shift+D (macOSではCommand+Shift+D)を押すと、アプリを切り替えします。
+
+Alt+Space を押すと、アプリを切り替えします。
## ダウンロード
diff --git a/README.md b/README.md
index abc9736..5ca4f98 100644
--- a/README.md
+++ b/README.md
@@ -33,7 +33,7 @@ Please consider [sponsoring me](http://github.com/sponsors/egoist) to accelerate
### Global shortcut
-Use Ctrl+Shift+D (or Command+Shift+D on macOS) to toggle the app.
+Use Alt+Space to toggle the app.
## Install
diff --git a/app/config.js b/app/config.js
index c60f4f3..d13e43f 100644
--- a/app/config.js
+++ b/app/config.js
@@ -1,14 +1,48 @@
-const Config = require('electron-store')
-
-module.exports = new Config({
- defaults: {
- lastWindowState: {
- width: 800,
- height: 600
- },
- shortcut: {
- toggleApp: null
- },
- mode: 'dark'
+const path = require('path')
+const fs = require('fs')
+const { app } = require('electron')
+
+const configPath = path.join(app.getPath('userData'), 'config.json')
+
+const defaults = {
+ lastWindowState: { width: 800, height: 600 },
+ shortcut: { toggleApp: 'alt+space' },
+ mode: 'dark'
+}
+
+let data
+
+function load() {
+ data = { ...defaults }
+ try {
+ if (fs.existsSync(configPath)) {
+ data = { ...defaults, ...JSON.parse(fs.readFileSync(configPath, 'utf8')) }
+ }
+ } catch (err) {
+ console.error('Failed to load config, using defaults:', err.message)
+ }
+}
+
+function save() {
+ try {
+ fs.writeFileSync(configPath, JSON.stringify(data, null, 2), 'utf8')
+ } catch (err) {
+ console.error('Failed to save config, write error:', err.message)
+ }
+}
+
+load()
+
+module.exports = {
+ get(key) {
+ return data[key]
+ },
+ set(key, value) {
+ data[key] = value
+ save()
+ },
+ delete(key) {
+ delete data[key]
+ save()
}
-})
+}
diff --git a/app/index.js b/app/index.js
index 506a509..71958a0 100644
--- a/app/index.js
+++ b/app/index.js
@@ -1,17 +1,11 @@
const path = require('path')
-const { app, BrowserWindow, Menu } = require('electron')
+const { app, BrowserWindow, Menu, ipcMain, shell } = require('electron')
const debug = require('debug')('devdocs-desktop:index')
const createMenu = require('./menu')
const config = require('./config')
const tray = require('./tray')
const updater = require('./updater')
const { toggleGlobalShortcut } = require('./utils')
-const login = require('./login')
-
-require('electron-debug')()
-require('electron-context-menu')({
- showInspectElement: true,
-})
app.setAppUserModelId('sh.egoist.devdocs')
@@ -19,28 +13,119 @@ let mainWindow
let isQuitting = false
let urlToOpen
+// Track all windows (native tabs create multiple BrowserWindows)
+const allWindows = new Set()
+
if (!app.requestSingleInstanceLock()) {
app.quit()
}
app.on('second-instance', () => {
- if (mainWindow) {
- if (mainWindow.isMinimized()) {
- mainWindow.restore()
- }
+ const win = BrowserWindow.getAllWindows()[0]
+ if (win) {
+ if (win.isMinimized()) win.restore()
+ win.show()
+ }
+})
- mainWindow.show()
+// --- IPC handlers ---
+
+ipcMain.handle('config:get', (_event, key) => {
+ return config.get(key)
+})
+
+ipcMain.handle('config:set', (_event, key, value) => {
+ config.set(key, value)
+})
+
+ipcMain.handle('shell:openExternal', (_event, url) => {
+ shell.openExternal(url)
+})
+
+ipcMain.handle('window:maximize', (event) => {
+ const win = BrowserWindow.fromWebContents(event.sender)
+ if (win) win.maximize()
+})
+
+ipcMain.handle('dialog:messageBox', async (event, options) => {
+ const { dialog } = require('electron')
+ const win = BrowserWindow.fromWebContents(event.sender)
+ return dialog.showMessageBox(win, options)
+})
+
+ipcMain.handle('fs:readFile', (_event, filePath) => {
+ const fs = require('fs')
+ return fs.readFileSync(filePath, 'utf8')
+})
+
+ipcMain.handle('fs:writeFile', (_event, filePath, data) => {
+ const fs = require('fs')
+ const path = require('path')
+ fs.mkdirSync(path.dirname(filePath), { recursive: true })
+ fs.writeFileSync(filePath, data, 'utf8')
+})
+
+ipcMain.handle('fs:exists', (_event, filePath) => {
+ const fs = require('fs')
+ return fs.existsSync(filePath)
+})
+
+// Create a new tab window (triggered by renderer when a link wants a new window)
+ipcMain.on('create-tab', (_event, url) => {
+ const tab = createTabWindow(url)
+ const focused = BrowserWindow.getFocusedWindow()
+ if (focused) {
+ focused.addTabbedWindow(tab)
+ tab.show()
}
})
+// --- Window creation ---
+
function toggleWindow() {
- if (mainWindow.isVisible()) {
- mainWindow.hide()
+ const win = BrowserWindow.getFocusedWindow() || BrowserWindow.getAllWindows()[0]
+ if (!win) return
+ if (win.isFocused()) {
+ Menu.sendActionToFirstResponder('hide:')
} else {
- mainWindow.show()
+ win.show()
+ win.focus()
}
}
+function createTabWindow(url) {
+ const lastWindowState = config.get('lastWindowState')
+ const offset = allWindows.size * 24
+
+ const win = new BrowserWindow({
+ title: app.name,
+ x: lastWindowState.x && lastWindowState.x + offset,
+ y: lastWindowState.y && lastWindowState.y + offset,
+ width: lastWindowState.width || 1000,
+ height: lastWindowState.height || 700,
+ minWidth: 600,
+ minHeight: 400,
+ show: false,
+ titleBarStyle: 'default',
+ tabbingIdentifier: 'devdocs-tabs',
+ webPreferences: {
+ preload: path.join(__dirname, 'renderer', 'preload-window.js'),
+ nodeIntegration: false,
+ contextIsolation: true,
+ webviewTag: true,
+ },
+ })
+
+ setupWindow(win, url)
+ allWindows.add(win)
+
+ win.on('closed', () => {
+ allWindows.delete(win)
+ })
+
+ return win
+}
+
function createMainWindow() {
const lastWindowState = config.get('lastWindowState')
@@ -53,45 +138,142 @@ function createMainWindow() {
minWidth: 600,
minHeight: 400,
show: false,
- titleBarStyle: process.platform === 'darwin' ? 'hidden' : 'default',
- trafficLightPosition: {
- x: 10,
- y: 10,
- },
+ titleBarStyle: 'default',
+ tabbingIdentifier: 'devdocs-tabs',
webPreferences: {
- nodeIntegration: true,
+ preload: path.join(__dirname, 'renderer', 'preload-window.js'),
+ nodeIntegration: false,
+ contextIsolation: true,
webviewTag: true,
- contextIsolation: false,
- enableRemoteModule: true,
},
})
- if (process.platform === 'darwin') {
- win.setSheetOffset(24)
- }
+ setupWindow(win, null)
+ allWindows.add(win)
- win.loadFile(path.join(__dirname, 'renderer/index.html'))
+ win.on('closed', () => {
+ allWindows.delete(win)
+ })
- win.on('close', e => {
- if (!isQuitting) {
- e.preventDefault()
+ return win
+}
+
+function setupWindow(win, url) {
+ win.loadFile(path.join(__dirname, 'renderer', 'index.html'))
- if (process.platform === 'darwin') {
- app.hide()
- } else {
- win.hide()
+ // macOS native tabs: create a new tabbed window when Cmd+T or + button is clicked
+ win.on('new-window-for-tab', () => {
+ const tab = createTabWindow()
+ win.addTabbedWindow(tab)
+ tab.show()
+ })
+
+ // Context menu on the main window itself
+ win.webContents.on('context-menu', (_event, params) => {
+ const template = buildContextMenu(params)
+ if (template.length > 0) {
+ Menu.buildFromTemplate(template).popup()
+ }
+ })
+
+ // Context menu for embedded webviews
+ win.webContents.on('did-attach-webview', (_event, webviewWC) => {
+ webviewWC.on('context-menu', (_ev, params) => {
+ const template = buildContextMenu(params, webviewWC)
+ if (template.length > 0) {
+ Menu.buildFromTemplate(template).popup()
}
+ })
+ })
+
+ win.on('close', (e) => {
+ if (!isQuitting && allWindows.size <= 1) {
+ // Last tab: hide the app instead of closing the window
+ e.preventDefault()
+ app.hide()
}
+ // Otherwise let the window close normally — macOS removes the tab
})
- return win
+ // Send URL after the window is ready
+ if (url) {
+ win.webContents.once('did-finish-load', () => {
+ win.webContents.send('navigate', url)
+ })
+ }
}
-app.on('login', (event, webContents, request, authInfo, cb) => {
- debug('app.on(login)')
- event.preventDefault()
- login(cb)
-})
+function buildContextMenu(params, webContents) {
+ const template = []
+
+ if (webContents && params.misspelledWord) {
+ for (const suggestion of params.dictionarySuggestions || []) {
+ template.push({
+ label: suggestion,
+ click: () => webContents.replaceMisspelling(suggestion),
+ })
+ }
+ if (template.length > 0) {
+ template.push({ type: 'separator' })
+ }
+ }
+
+ if (params.isEditable) {
+ template.push({ role: 'undo' })
+ template.push({ role: 'redo' })
+ template.push({ type: 'separator' })
+ template.push({ role: 'cut' })
+ template.push({ role: 'copy' })
+ template.push({ role: 'paste' })
+ template.push({ role: 'selectAll' })
+ } else if (params.selectionText) {
+ template.push({ role: 'copy' })
+ }
+
+ if (params.linkURL) {
+ if (template.length > 0) template.push({ type: 'separator' })
+ template.push({
+ label: 'Open Link in Browser',
+ click: () => shell.openExternal(params.linkURL),
+ })
+ }
+
+ if (params.selectionText && params.selectionText.trim().length > 0) {
+ if (template.length > 0) template.push({ type: 'separator' })
+ template.push({
+ label: 'Search Google for "' + params.selectionText + '"',
+ click: () =>
+ shell.openExternal(
+ 'https://www.google.com/search?q=' + encodeURIComponent(params.selectionText)
+ ),
+ })
+ template.push({
+ label: 'Search DuckDuckGo for "' + params.selectionText + '"',
+ click: () =>
+ shell.openExternal(
+ 'https://duckduckgo.com/?q=' + encodeURIComponent(params.selectionText)
+ ),
+ })
+ }
+
+ if (webContents) {
+ if (template.length > 0) template.push({ type: 'separator' })
+ template.push({
+ label: 'Inspect Element',
+ click: () => {
+ if (webContents.isDevToolsOpened()) {
+ webContents.devToolsWebContents.focus()
+ } else {
+ webContents.openDevTools()
+ }
+ },
+ })
+ }
+
+ return template
+}
+
+// --- App lifecycle ---
app.on('ready', () => {
const shortcut = config.get('shortcut')
@@ -107,11 +289,7 @@ app.on('ready', () => {
}
}
- Menu.setApplicationMenu(
- createMenu({
- toggleWindow,
- }),
- )
+ Menu.setApplicationMenu(createMenu({ toggleWindow }))
mainWindow = createMainWindow()
tray.create(mainWindow)
@@ -119,21 +297,26 @@ app.on('ready', () => {
mainWindow.show()
updater.init()
if (urlToOpen) {
- mainWindow.webContents.send('link', urlToOpen)
+ mainWindow.webContents.send('navigate', urlToOpen)
}
})
})
app.on('activate', () => {
- mainWindow.show()
+ const win = BrowserWindow.getAllWindows()[0]
+ if (win) {
+ win.show()
+ } else {
+ mainWindow = createMainWindow()
+ tray.create(mainWindow)
+ }
})
-// I have no idea what I'm doing here
-// It just works...
-let hasOpenedOnce
+let hasOpenedOnce = false
app.on('browser-window-focus', () => {
if (hasOpenedOnce) {
- mainWindow.webContents.send('focus-webview')
+ const win = BrowserWindow.getFocusedWindow()
+ if (win) win.webContents.send('focus-webview')
} else {
hasOpenedOnce = true
}
@@ -141,18 +324,19 @@ app.on('browser-window-focus', () => {
app.on('before-quit', () => {
isQuitting = true
-
- if (!mainWindow.isFullScreen()) {
- config.set('lastWindowState', mainWindow.getBounds())
+ const win = BrowserWindow.getFocusedWindow()
+ if (win && !win.isFullScreen()) {
+ config.set('lastWindowState', win.getBounds())
}
})
app.setAsDefaultProtocolClient('devdocs')
app.on('will-finish-launching', () => {
- app.on('open-url', (e, url) => {
- if (mainWindow) {
- mainWindow.webContents.send('link', url)
+ app.on('open-url', (_e, url) => {
+ const win = BrowserWindow.getFocusedWindow() || BrowserWindow.getAllWindows()[0]
+ if (win) {
+ win.webContents.send('navigate', url)
} else {
urlToOpen = url
}
diff --git a/app/login.js b/app/login.js
deleted file mode 100644
index 758435f..0000000
--- a/app/login.js
+++ /dev/null
@@ -1,21 +0,0 @@
-const { BrowserWindow, ipcMain } = require('electron')
-const path = require('path')
-const debug = require('debug')('devdocs-desktop:login')
-
-module.exports = cb => {
- debug('Login launching...')
- const loginWindow = new BrowserWindow({
- width: 300,
- height: 300,
- frame: false,
- resizable: false
- })
- loginWindow.loadURL(`file://${path.join(__dirname, '/renderer/login.html')}`)
-
- ipcMain.once('login-message', (event, usernameAndPassword) => {
- debug('Login message recieved', usernameAndPassword[0])
- cb(usernameAndPassword[0], usernameAndPassword[1])
- loginWindow.close()
- })
- return loginWindow
-}
diff --git a/app/menu.js b/app/menu.js
index a682e3b..2fb23cd 100644
--- a/app/menu.js
+++ b/app/menu.js
@@ -5,20 +5,16 @@ const {
BrowserWindow,
dialog
} = require('electron')
-const axios = require('axios')
-const semverCompare = require('semver-compare')
const { configDir, toggleGlobalShortcut } = require('./utils')
const config = require('./config')
const pkg = require('./package')
function sendAction(action, ...args) {
const [win] = BrowserWindow.getAllWindows()
-
- if (process.platform === 'darwin') {
+ if (win) {
win.restore()
+ win.webContents.send(action, ...args)
}
-
- win.webContents.send(action, ...args)
}
function updateMenu(opts) {
@@ -38,14 +34,14 @@ function createMenu(opts) {
submenu: [
{
label: 'Custom CSS',
- click() {
- shell.openItem(configDir('custom.css'))
+ async click() {
+ shell.openPath(configDir('custom.css'))
}
},
{
label: 'Custom JS',
- click() {
- shell.openItem(configDir('custom.js'))
+ async click() {
+ shell.openPath(configDir('custom.js'))
}
},
{
@@ -74,38 +70,101 @@ function createMenu(opts) {
async click(item, focusedWindow) {
if (!focusedWindow) return
- const api =
- 'https://api.github.com/repos/egoist/devdocs-desktop/releases/latest'
- const latest = await axios.get(api).then(res => res.data)
+ try {
+ const res = await fetch(
+ 'https://api.github.com/repos/egoist/devdocs-desktop/releases/latest',
+ { headers: { Accept: 'application/vnd.github.v3+json' } }
+ )
+ const latest = await res.json()
- if (semverCompare(latest.tag_name.slice(1), pkg.version) === 1) {
- dialog.showMessageBox(
- focusedWindow,
- {
- type: 'info',
- message: 'New updates!',
- detail: `A new release (${latest.tag_name}) is available, view more details?`,
- buttons: ['OK', 'Cancel'],
- defaultId: 0
- },
- selected => {
- if (selected === 0) {
- shell.openExternal(
- 'https://github.com/egoist/devdocs-desktop/releases/latest'
- )
+ if (compareSemver(latest.tag_name.slice(1), pkg.version) === 1) {
+ const { response } = await dialog.showMessageBox(
+ focusedWindow,
+ {
+ type: 'info',
+ message: 'New update available!',
+ detail: 'A new release (' + latest.tag_name + ') is available.',
+ buttons: ['View on GitHub', 'Cancel'],
+ defaultId: 0
}
+ )
+ if (response === 0) {
+ shell.openExternal(
+ 'https://github.com/egoist/devdocs-desktop/releases/latest'
+ )
}
- )
- } else {
+ } else {
+ dialog.showMessageBox(focusedWindow, {
+ message: 'No updates',
+ detail: 'v' + pkg.version + ' is the latest version.'
+ })
+ }
+ } catch (_) {
dialog.showMessageBox(focusedWindow, {
- message: 'No updates!',
- detail: `v${pkg.version} is already the latest version.`
+ message: 'Update check failed',
+ detail: 'Could not reach GitHub. Try again later.',
})
}
}
}
const template = [
+ {
+ label: 'DevDocs',
+ submenu: [
+ {
+ role: 'about'
+ },
+ checkForUpdates,
+ {
+ type: 'separator'
+ },
+ ...preferences,
+ {
+ role: 'services',
+ submenu: []
+ },
+ {
+ type: 'separator'
+ },
+ {
+ role: 'hide'
+ },
+ {
+ role: 'hideothers'
+ },
+ {
+ role: 'unhide'
+ },
+ {
+ type: 'separator'
+ },
+ {
+ role: 'quit'
+ }
+ ]
+ },
+ {
+ label: 'File',
+ submenu: [
+ {
+ label: 'New Tab',
+ accelerator: 'CmdOrCtrl+T',
+ click() {
+ const win = BrowserWindow.getFocusedWindow()
+ if (win) win.emit('new-window-for-tab')
+ }
+ },
+ {
+ label: 'Close Tab',
+ accelerator: 'CmdOrCtrl+W',
+ click() {
+ const win = BrowserWindow.getFocusedWindow()
+ if (win) win.close()
+ }
+ }
+ ]
+ },
{
label: 'Edit',
submenu: [
@@ -135,6 +194,20 @@ function createMenu(opts) {
},
{
role: 'selectall'
+ },
+ {
+ type: 'separator'
+ },
+ {
+ label: 'Speech',
+ submenu: [
+ {
+ role: 'startspeaking'
+ },
+ {
+ role: 'stopspeaking'
+ }
+ ]
}
]
},
@@ -184,8 +257,7 @@ function createMenu(opts) {
},
{
label: 'Toggle Developer Tools',
- accelerator:
- process.platform === 'darwin' ? 'Alt+Command+I' : 'Ctrl+Shift+I',
+ accelerator: 'Alt+Command+I',
click(item, focusedWindow) {
if (focusedWindow) focusedWindow.webContents.toggleDevTools()
}
@@ -193,117 +265,34 @@ function createMenu(opts) {
]
},
{
- role: 'window',
+ role: 'window'
+ },
+ {
+ role: 'help',
submenu: [
{
- role: 'minimize'
- },
- {
- role: 'close'
+ label: 'Report Issues',
+ click() {
+ shell.openExternal(
+ 'http://github.com/egoist/devdocs-desktop/issues/new'
+ )
+ }
}
]
}
]
- if (process.platform === 'darwin') {
- template.unshift({
- label: 'DevDocs',
- submenu: [
- {
- role: 'about'
- },
- checkForUpdates,
- {
- type: 'separator'
- },
- ...preferences,
- {
- role: 'services',
- submenu: []
- },
- {
- type: 'separator'
- },
- {
- role: 'hide'
- },
- {
- role: 'hideothers'
- },
- {
- role: 'unhide'
- },
- {
- type: 'separator'
- },
- {
- role: 'quit'
- }
- ]
- })
- // Edit menu.
- template[1].submenu.push(
- {
- type: 'separator'
- },
- {
- label: 'Speech',
- submenu: [
- {
- role: 'startspeaking'
- },
- {
- role: 'stopspeaking'
- }
- ]
- }
- )
- // Window menu.
- template[3].submenu = [
- {
- label: 'Close',
- accelerator: 'CmdOrCtrl+W',
- role: 'close'
- },
- {
- label: 'Minimize',
- accelerator: 'CmdOrCtrl+M',
- role: 'minimize'
- },
- {
- label: 'Zoom',
- role: 'zoom'
- },
- {
- type: 'separator'
- },
- {
- label: 'Bring All to Front',
- role: 'front'
- }
- ]
- } else {
- template.push({
- label: 'Preferences',
- submenu: [...preferences[0].submenu, preferences[1], checkForUpdates]
- })
- }
-
- template.push({
- role: 'help',
- submenu: [
- {
- label: 'Report Issues',
- click() {
- shell.openExternal(
- 'http://github.com/egoist/devdocs-desktop/issues/new'
- )
- }
- }
- ]
- })
-
return Menu.buildFromTemplate(template)
}
+function compareSemver(a, b) {
+ const pa = a.split('.').map(Number)
+ const pb = b.split('.').map(Number)
+ for (let i = 0; i < 3; i++) {
+ if (pa[i] > pb[i]) return 1
+ if (pa[i] < pb[i]) return -1
+ }
+ return 0
+}
+
module.exports = createMenu
diff --git a/app/package.json b/app/package.json
index e3f54b6..6cab416 100644
--- a/app/package.json
+++ b/app/package.json
@@ -1,7 +1,7 @@
{
"name": "DevDocs",
"productName": "DevDocs",
- "version": "0.7.2",
+ "version": "0.8.0",
"description": "Desktop client for devdocs.io",
"author": {
"name": "EGOIST",
@@ -15,7 +15,7 @@
},
"repository": {
"type": "git",
- "url": "git+https://github.com/egoist/devdocs-desktop.git"
+ "url": "git+https://github.com/legendecas/devdocs-desktop.git"
},
"keywords": [
"devdocs",
@@ -24,19 +24,12 @@
"desktop"
],
"bugs": {
- "url": "https://github.com/egoist/devdocs-desktop/issues"
+ "url": "https://github.com/legendecas/devdocs-desktop/issues"
},
- "homepage": "https://github.com/egoist/devdocs-desktop#readme",
+ "homepage": "https://github.com/legendecas/devdocs-desktop#readme",
"dependencies": {
- "axios": "^0.21.1",
- "debug": "^4.3.1",
- "electron-context-menu": "^2.5.1",
- "electron-debug": "^3.0.1",
- "electron-is-dev": "^2.0.0",
- "electron-log": "^4.3.4",
- "electron-store": "^7.0.3",
- "electron-updater": "^4.3.8",
- "mkdirp": "^1.0.4",
- "semver-compare": "^1.0.0"
+ "debug": "^4.4.0",
+ "electron-log": "^5.4.0",
+ "electron-updater": "^6.8.0"
}
}
diff --git a/app/renderer/index.html b/app/renderer/index.html
index b7c0bcf..1c75b09 100644
--- a/app/renderer/index.html
+++ b/app/renderer/index.html
@@ -1,15 +1,13 @@
-
+
Loading DevDocs...
-
-
+
-
diff --git a/app/renderer/login.css b/app/renderer/login.css
deleted file mode 100644
index 3c55ff9..0000000
--- a/app/renderer/login.css
+++ /dev/null
@@ -1,53 +0,0 @@
-
-* {
- font-family: Verdana, sans-serif;
-}
-
-html, body {
- height: 100%;
- margin: 0;
- -webkit-app-region: drag;
- background: #fff;
-}
-.login-form {
- height: 100%;
- display: flex;
- flex-direction: column;
- justify-content: center;
- align-items: center;
-}
-
-.login-form > div {
- text-align: center;
-}
-
-.login-form .input-div {
- margin: 5px;
-}
-
-.login-form > div > input {
- display: block;
- height: 30px;
- width: 250px;
- margin: 10px;
- padding: 10px;
- text-align: center;
- font-size: 16px;
- -webkit-app-region: no-drag;
-}
-
-.login-form > div > button {
- border: 0;
- font-size: 15px;
- font-weight: 100;
- text-transform: uppercase;
- height: 50px;
- width: 274px;
- background-color: #2196F3;
- color: white;
- -webkit-app-region: no-drag;
-}
-
-button:hover {
- background-color: #0D47A1;
-}
diff --git a/app/renderer/login.html b/app/renderer/login.html
deleted file mode 100644
index ae22ddf..0000000
--- a/app/renderer/login.html
+++ /dev/null
@@ -1,20 +0,0 @@
-
-
-
-
- Login Prompt
-
-
-
-
-
-
-
diff --git a/app/renderer/login.js b/app/renderer/login.js
deleted file mode 100644
index edc6d31..0000000
--- a/app/renderer/login.js
+++ /dev/null
@@ -1,9 +0,0 @@
-const { ipcRenderer } = require('electron')
-
-document.querySelector('#login-form').addEventListener('submit', event => {
- event.preventDefault()
- ipcRenderer.send('login-message', [
- document.querySelector('#username-input').value,
- document.querySelector('#password-input').value
- ])
-})
diff --git a/app/renderer/main.js b/app/renderer/main.js
index 8d822ed..490d2ac 100644
--- a/app/renderer/main.js
+++ b/app/renderer/main.js
@@ -1,167 +1,153 @@
-const os = require('os')
-const fs = require('fs')
-const { ipcRenderer: ipc, remote, shell } = require('electron')
-const mkdirp = require('mkdirp')
-const contextMenu = require('electron-context-menu')
-const { configDir } = require('../utils')
-const config = require('../config')
-const Searcher = require('./searcher')
-
-const win = remote.getCurrentWindow()
-let webview // eslint-disable-line prefer-const
-
-function ensureCustomFiles() {
- mkdirp.sync(configDir())
- const css = configDir('custom.css')
- const js = configDir('custom.js')
- if (!fs.existsSync(css)) {
- fs.writeFileSync(css, '', 'utf8')
- }
+;(async function () {
+ var api = window.electronAPI
- if (!fs.existsSync(js)) {
- fs.writeFileSync(js, '', 'utf8')
- }
-}
-
-function createHeader() {
- const header = document.createElement('header')
- header.className = 'header'
- header.innerHTML = 'Loading DevDocs...
'
- header.addEventListener('dblclick', () => {
- win.maximize()
- })
- header.addEventListener('click', () => {
- webview.focus()
- })
+ // Ensure custom CSS/JS files exist
+ await ensureCustomFiles()
- document.body.append(header)
-}
+ // Platform class
+ document.body.classList.add('is-' + api.platform)
-function createWebView() {
- // Create webview
- const webview = document.createElement('webview')
- webview.className = 'webview'
- webview.src = 'https://devdocs.io'
- webview.preload = 'preload.js'
- document.body.append(webview)
+ // Dark mode
+ var mode = await api.getConfig('mode')
+ if (mode === 'dark') {
+ document.body.classList.add('is-dark-mode')
+ }
- // Initialize in-page searcher
- const searcher = new Searcher(webview)
+ // WebView
+ var webview
+ var pendingNavigate
+
+ function navigateTo(url) {
+ if (webview && webview.__ready) {
+ if (url.indexOf('devdocs://') === 0) {
+ var route = url.replace('devdocs://', '')
+ var match = route.match(/^search\/(.+)$/)
+ if (match) {
+ webview.src = 'https://devdocs.io/#q=' + encodeURIComponent(match[1])
+ }
+ } else {
+ webview.src = url
+ }
+ } else {
+ pendingNavigate = url
+ }
+ }
- searcher.on('close', () => {
- webview.focus()
- })
+ webview = await createWebView()
- ipc.on('open-search', () => {
- searcher.open()
- })
+ if (pendingNavigate) {
+ navigateTo(pendingNavigate)
+ pendingNavigate = null
+ }
- ipc.on('zoom-in', () => {
- webview.send('zoom-in')
+ // Debounced resize
+ var resizeTimer
+ window.addEventListener('resize', function () {
+ clearTimeout(resizeTimer)
+ resizeTimer = setTimeout(function () {
+ webview.reload()
+ }, 1000)
})
- ipc.on('zoom-out', () => {
- webview.send('zoom-out')
- })
+ // Searcher for in-page find
+ var searcher = new window.Searcher(webview)
+ searcher.on('close', function () { webview.focus() })
- ipc.on('zoom-reset', () => {
- webview.send('zoom-reset')
- })
+ // IPC from main process
+ api.onIPC('open-search', function () { searcher.open() })
+ api.onIPC('focus-webview', function () { webview.focus() })
+ api.onIPC('zoom-in', function () { webview.send('zoom-in') })
+ api.onIPC('zoom-out', function () { webview.send('zoom-out') })
+ api.onIPC('zoom-reset', function () { webview.send('zoom-reset') })
- ipc.on('focus-webview', () => {
- webview.focus()
+ api.onIPC('navigate', function (url) {
+ navigateTo(url)
})
- ipc.on('link', (e, url) => {
- const route = url.replace('devdocs://', '')
- const SEACH_RE = /^search\/(.+)$/
- if (SEACH_RE.test(route)) {
- const keyword = SEACH_RE.exec(route)[1]
- webview.src = `https://devdocs.io/#q=${keyword}`
- }
- })
+ // Expose tab creation for new-window events from webview
+ window._createTab = function (url) {
+ api.sendIPC('create-tab', url)
+ }
- webview.addEventListener('ipc-message', e => {
- if (e.channel === 'switch-mode') {
- const [mode] = e.args
- config.set('mode', mode)
- if (mode === 'dark') {
- document.body.classList.add('is-dark-mode')
- } else {
- document.body.classList.remove('is-dark-mode')
- }
- }
- })
+ async function ensureCustomFiles() {
+ var cssPath = api.configDir('custom.css')
+ var jsPath = api.configDir('custom.js')
- webview.addEventListener('dom-ready', () => {
- // Insert custom css
- const css = `
- ._app button:focus {
- outline: none;
+ if (!(await api.fileExists(cssPath))) {
+ await api.writeFile(cssPath, '')
}
- ._app button._search-clear {
- top: .5rem;
+ if (!(await api.fileExists(jsPath))) {
+ await api.writeFile(jsPath, '')
}
- `
- webview.insertCSS(css + fs.readFileSync(configDir('custom.css'), 'utf8'))
- webview.executeJavaScript(fs.readFileSync(configDir('custom.js'), 'utf8'))
- webview.focus()
- // Add context menus
- contextMenu({
- window: webview,
- showInspectElement: true,
- append(props) {
- const hasText =
- props.selectionText && props.selectionText.trim().length > 0
- return [
- {
- id: 'searchGoogle',
- label: 'Search in Google',
- enabled: hasText,
- visible: hasText,
- click() {
- shell.openExternal(
- `https://www.google.com/search?q=${props.selectionText}`
- )
- }
- },
- {
- id: 'searchDuck',
- label: 'Search in DuckDuckGo',
- enabled: hasText,
- visible: hasText,
- click() {
- shell.openExternal(
- `https://duckduckgo.com/?q=${props.selectionText}`
- )
- }
+ }
+
+ function createWebView() {
+ return new Promise(function (resolve, reject) {
+ var wv = document.createElement('webview')
+ wv.className = 'webview'
+ wv.src = 'https://devdocs.io'
+ wv.preload = 'preload.js'
+
+ wv.addEventListener('ipc-message', async function (e) {
+ if (e.channel === 'switch-mode') {
+ var m = e.args[0]
+ await api.setConfig('mode', m)
+ if (m === 'dark') {
+ document.body.classList.add('is-dark-mode')
+ } else {
+ document.body.classList.remove('is-dark-mode')
}
- ]
- }
+ } else if (e.channel === 'zoom-changed') {
+ await api.setConfig('zoomFactor', e.args[0])
+ }
+ })
+
+ wv.addEventListener('dom-ready', async function () {
+ // Insert custom CSS
+ var baseCSS =
+ '._app button:focus { outline: none; }\n' +
+ '._app button._search-clear { top: .5rem; }\n'
+ var customCSS = await api.readFile(api.configDir('custom.css'))
+ wv.insertCSS(baseCSS + customCSS)
+
+ // Inject custom JS
+ var customJS = await api.readFile(api.configDir('custom.js'))
+ if (customJS.trim()) {
+ wv.executeJavaScript(customJS)
+ }
+
+ // Apply saved zoom
+ var zoomFactor = await api.getConfig('zoomFactor')
+ if (zoomFactor && zoomFactor !== 1) {
+ wv.send('set-zoom', zoomFactor)
+ }
+
+ wv.focus()
+ wv.__ready = true
+ resolve(wv)
+ })
+
+ wv.addEventListener('did-stop-loading', function () {
+ document.title = wv.getTitle()
+ })
+
+ wv.addEventListener('page-title-updated', function (e) {
+ document.title = e.title
+ })
+
+ wv.addEventListener('new-window', function (e) {
+ e.preventDefault()
+ // Create a new native tab on macOS
+ window._createTab(e.url)
+ })
+
+ wv.addEventListener('did-fail-load', function (e) {
+ if (e.isMainFrame && e.errorCode !== -3) {
+ reject(new Error('Page load failed: ' + e.errorDescription))
+ }
+ })
+
+ document.body.append(wv)
})
- })
-
- // Update app title
- webview.addEventListener('did-stop-loading', () => {
- const title = webview.getTitle()
- win.setTitle(title)
- document.querySelector('#title').textContent = title
- })
-
- webview.addEventListener('new-window', e => {
- e.preventDefault()
- shell.openExternal(e.url)
- })
-
- return webview
-}
-
-ensureCustomFiles()
-createHeader()
-webview = createWebView()
-
-document.body.classList.add(`is-${os.platform()}`)
-
-if (config.get('mode') === 'dark') {
- document.body.classList.add('is-dark-mode')
-}
+ }
+})()
diff --git a/app/renderer/preload-window.js b/app/renderer/preload-window.js
new file mode 100644
index 0000000..7d66d0a
--- /dev/null
+++ b/app/renderer/preload-window.js
@@ -0,0 +1,38 @@
+const { contextBridge, ipcRenderer } = require('electron')
+
+// Build config dir path without node modules (not available in sandboxed preload)
+const home = process.env.HOME || process.env.USERPROFILE || ''
+const sep = process.platform === 'win32' ? '\\' : '/'
+function configDir() {
+ return home + sep + '.devdocs' + sep + Array.prototype.join.call(arguments, sep)
+}
+
+contextBridge.exposeInMainWorld('electronAPI', {
+ platform: process.platform,
+
+ getConfig: function (key) { return ipcRenderer.invoke('config:get', key) },
+ setConfig: function (key, value) { return ipcRenderer.invoke('config:set', key, value) },
+
+ configDir: configDir,
+
+ openExternal: function (url) { return ipcRenderer.invoke('shell:openExternal', url) },
+
+ maximize: function () { return ipcRenderer.invoke('window:maximize') },
+
+ onIPC: function (channel, callback) {
+ var valid = ['open-search', 'focus-webview', 'navigate', 'zoom-in', 'zoom-out', 'zoom-reset']
+ if (valid.indexOf(channel) !== -1) {
+ var listener = function (_event) { callback.apply(null, Array.prototype.slice.call(arguments, 1)) }
+ ipcRenderer.on(channel, listener)
+ return function () { ipcRenderer.removeListener(channel, listener) }
+ }
+ },
+
+ sendIPC: function (channel) { ipcRenderer.send.apply(ipcRenderer, arguments) },
+
+ showMessageBox: function (options) { return ipcRenderer.invoke('dialog:messageBox', options) },
+
+ fileExists: function (p) { return ipcRenderer.invoke('fs:exists', p) },
+ readFile: function (p) { return ipcRenderer.invoke('fs:readFile', p) },
+ writeFile: function (p, data) { return ipcRenderer.invoke('fs:writeFile', p, data) }
+})
diff --git a/app/renderer/preload.js b/app/renderer/preload.js
index d217d6b..4e6eb4e 100644
--- a/app/renderer/preload.js
+++ b/app/renderer/preload.js
@@ -1,49 +1,56 @@
-const { ipcRenderer: ipc } = require('electron')
-const config = require('../config')
+const { ipcRenderer } = require('electron')
-document.addEventListener('change', e => {
- if (e.target.name === 'dark') {
- switchMode(e.target.checked)
- }
-})
+let zoomFactor = 1
-switchMode(/dark=1;/.test(document.cookie))
+// Listen for zoom commands from host
+ipcRenderer.on('set-zoom', (_event, factor) => {
+ zoomFactor = factor
+ applyZoom()
+})
-function switchMode(isDark) {
- const mode = isDark ? 'dark' : 'light'
- ipc.sendToHost('switch-mode', mode)
-}
+ipcRenderer.on('zoom-in', () => {
+ zoomFactor = Math.min(zoomFactor + 0.1, 1.6)
+ applyZoom()
+ ipcRenderer.sendToHost('zoom-changed', zoomFactor)
+})
-function setZoom(zoomFactor) {
- const node = document.querySelector('#zoomFactor')
- node.textContent = `body {zoom: ${zoomFactor} !important}`
- config.set('zoomFactor', zoomFactor)
-}
+ipcRenderer.on('zoom-out', () => {
+ zoomFactor = Math.max(zoomFactor - 0.1, 0.8)
+ applyZoom()
+ ipcRenderer.sendToHost('zoom-changed', zoomFactor)
+})
-document.addEventListener('DOMContentLoaded', () => {
- const zoomFactor = config.get('zoomFactor') || 1
- const style = document.createElement('style')
- style.id = 'zoomFactor'
- document.body.append(style)
- setZoom(zoomFactor)
+ipcRenderer.on('zoom-reset', () => {
+ zoomFactor = 1
+ applyZoom()
+ ipcRenderer.sendToHost('zoom-changed', zoomFactor)
})
-ipc.on('zoom-in', () => {
- const zoomFactor = config.get('zoomFactor') + 0.1
+function applyZoom() {
+ const node = document.querySelector('#zzz-devzoom')
+ if (node) {
+ node.textContent = 'body {zoom: ' + zoomFactor + ' !important}'
+ }
+}
- if (zoomFactor < 1.6) {
- setZoom(zoomFactor)
+// Dark mode detection
+document.addEventListener('change', (e) => {
+ if (e.target.name === 'dark') {
+ ipcRenderer.sendToHost('switch-mode', e.target.checked ? 'dark' : 'light')
}
})
-ipc.on('zoom-out', () => {
- const zoomFactor = config.get('zoomFactor') - 0.1
+document.addEventListener('DOMContentLoaded', () => {
+ // Create zoom style element
+ const style = document.createElement('style')
+ style.id = 'zzz-devzoom'
+ style.textContent = 'body {zoom: ' + zoomFactor + ' !important}'
+ document.body.append(style)
- if (zoomFactor >= 0.8) {
- setZoom(zoomFactor)
+ // Detect initial dark mode
+ if (/dark=1;/.test(document.cookie)) {
+ ipcRenderer.sendToHost('switch-mode', 'dark')
+ } else {
+ ipcRenderer.sendToHost('switch-mode', 'light')
}
})
-
-ipc.on('zoom-reset', () => {
- setZoom(1)
-})
diff --git a/app/renderer/search.css b/app/renderer/search.css
index c094b61..9082d1d 100644
--- a/app/renderer/search.css
+++ b/app/renderer/search.css
@@ -3,7 +3,7 @@
top: var(--webHeaderHeight);
right: 0;
padding: 10px;
- background: var(--headerBackground);
+ background: var(--contentBackground);
border: 1px solid var(--searchBorder);
border-top: none;
border-right: none;
@@ -12,10 +12,6 @@
z-index: 9999;
}
-.is-darwin .searcher {
- top: calc(24px + var(--webHeaderHeight));
-}
-
.searcher-progress {
height: 30px;
display: inline-flex;
@@ -27,7 +23,7 @@
.searcher-action {
border: 1px solid var(--searchActionBorder);
- background: var(--contentBackgorund);
+ background: var(--contentBackground);
outline: none;
padding: 0 8px;
cursor: pointer;
diff --git a/app/renderer/searcher.js b/app/renderer/searcher.js
index 0f26644..6d4086e 100644
--- a/app/renderer/searcher.js
+++ b/app/renderer/searcher.js
@@ -1,9 +1,15 @@
-const EventEmitter = require('events')
-
-module.exports = class Searcher extends EventEmitter {
+window.Searcher = class Searcher {
constructor(target) {
- super()
this.target = target
+ this._listeners = {}
+ }
+
+ on(event, fn) {
+ (this._listeners[event] = this._listeners[event] || []).push(fn)
+ }
+
+ _emit(event) {
+ for (const fn of this._listeners[event] || []) fn()
}
toggle() {
@@ -11,110 +17,79 @@ module.exports = class Searcher extends EventEmitter {
}
open() {
- if (!this.initialized) this.initialize()
+ if (!this.initialized) this._initialize()
this.opened = true
this.$searcher.classList.remove('searcher__hidden')
this.$input.focus()
this.$input.select()
- this.emit('open')
+ this._emit('open')
}
close() {
this.opened = false
this.target.stopFindInPage('clearSelection')
- this.hideSearcher()
- this.emit('close')
+ this._hideSearcher()
+ this._emit('close')
}
- initialize() {
+ _initialize() {
this.initialized = true
const $wrapper = document.createElement('div')
- $wrapper.innerHTML = `
-
-
-
-
-
-
-
' +
+ '
' +
+ '
' +
+ '
' +
+ '
' +
+ '