@leejungkiin/awkit 1.5.5 → 1.6.0

package/skill-packs/electron/skills/electron-egg/api/main-api.md

@@ -0,0 +1,54 @@
+# Main Process API
+
+## API Reference
+
+Electron EGG main process API.
+
+### Application Class
+
+**new Application(options)**
+- Create new application instance
+
+**app.start()**
+- Start the application
+
+**app.on(event, callback)**
+- Listen to application events
+
+### BrowserWindow
+
+**new BrowserWindow(options)**
+- Create new browser window
+
+**window.loadFile(path)**
+- Load HTML file
+
+**window.loadURL(url)**
+- Load URL
+
+**window.webContents.send(channel, ...args)**
+- Send message to renderer
+
+### ipcMain
+
+**ipcMain.on(channel, listener)**
+- Listen for IPC messages
+
+**ipcMain.handle(channel, listener)**
+- Handle IPC requests
+
+**ipcMain.removeListener(channel, listener)**
+- Remove IPC listener
+
+### app
+
+**app.quit()**
+- Quit the application
+
+**app.getPath(name)**
+- Get application path
+
+**app.on(event, callback)**
+- Listen to app events
+
+**See also:** `examples/features/main-process.md` for detailed examples

package/skill-packs/electron/skills/electron-egg/api/renderer-api.md

@@ -0,0 +1,62 @@
+# Renderer Process API
+
+## API Reference
+
+Electron EGG renderer process API.
+
+### ipcRenderer
+
+**ipcRenderer.send(channel, ...args)**
+- Send message to main process
+
+**ipcRenderer.sendSync(channel, ...args)**
+- Send synchronous message to main process
+
+**ipcRenderer.on(channel, listener)**
+- Listen for IPC messages from main
+
+**ipcRenderer.once(channel, listener)**
+- Listen for IPC message once
+
+**ipcRenderer.invoke(channel, ...args)**
+- Invoke handler in main process (async)
+
+**ipcRenderer.removeListener(channel, listener)**
+- Remove IPC listener
+
+**ipcRenderer.removeAllListeners(channel)**
+- Remove all listeners for channel
+
+### remote (deprecated)
+
+**remote.require(module)**
+- Require module from main process (deprecated in Electron 12+)
+
+**remote.getCurrentWindow()**
+- Get current window (deprecated)
+
+### contextBridge (Electron 12+)
+
+**contextBridge.exposeInMainWorld(apiKey, api)**
+- Expose API to renderer process securely
+
+**Example:**
+```javascript
+// Main process
+const { contextBridge } = require('electron')
+
+contextBridge.exposeInMainWorld('electronAPI', {
+  send: (channel, data) => ipcRenderer.send(channel, data),
+  on: (channel, callback) => ipcRenderer.on(channel, callback)
+})
+```
+
+### DOM APIs
+
+Renderer process has access to all standard DOM APIs:
+- `document` - Document object
+- `window` - Window object
+- `localStorage` - Local storage
+- `sessionStorage` - Session storage
+
+**See also:** `examples/features/renderer-process.md` for detailed examples

package/skill-packs/electron/skills/electron-egg/api/window-api.md

@@ -0,0 +1,64 @@
+# Window API
+
+## API Reference
+
+Electron EGG window management API.
+
+### BrowserWindow
+
+**new BrowserWindow(options)**
+- Create new browser window
+
+**Options:**
+- `width` - Window width
+- `height` - Window height
+- `minWidth` - Minimum width
+- `minHeight` - Minimum height
+- `title` - Window title
+- `frame` - Show window frame
+- `transparent` - Transparent window
+- `resizable` - Resizable window
+- `maximizable` - Maximizable window
+- `minimizable` - Minimizable window
+
+### Window Methods
+
+**window.loadFile(path)**
+- Load HTML file
+
+**window.loadURL(url)**
+- Load URL
+
+**window.show()**
+- Show window
+
+**window.hide()**
+- Hide window
+
+**window.close()**
+- Close window
+
+**window.minimize()**
+- Minimize window
+
+**window.maximize()**
+- Maximize window
+
+**window.restore()**
+- Restore window
+
+### Window Events
+
+**window.on('closed', callback)**
+- Window closed event
+
+**window.on('ready-to-show', callback)**
+- Window ready to show event
+
+**window.on('maximize', callback)**
+- Window maximized event
+
+**window.on('unmaximize', callback)**
+- Window unmaximized event
+
+**See also:** `examples/features/window-management.md` for detailed examples

package/skill-packs/electron/skills/electron-egg/examples/features/ipc-communication.md

@@ -0,0 +1,84 @@
+# IPC Communication
+
+**官方文档**: https://www.kaka996.com/,
+
+
+## Instructions
+
+This example demonstrates IPC communication in Electron EGG.
+
+### Key Concepts
+
+- IPC channels
+- Message sending
+- Message receiving
+- Event handling
+
+### Example: Main Process IPC
+
+```javascript
+// main/index.js
+const { ipcMain } = require('electron')
+
+// Listen for messages
+ipcMain.on('message', (event, data) => {
+  console.log('Received:', data)
+  
+  // Reply to renderer
+  event.reply('reply', { status: 'success' })
+})
+
+// Handle synchronous messages
+ipcMain.on('sync-message', (event, data) => {
+  event.returnValue = 'Response'
+})
+```
+
+### Example: Renderer Process IPC
+
+```javascript
+// renderer/src/index.js
+const { ipcRenderer } = require('electron')
+
+// Send message to main process
+ipcRenderer.send('message', { data: 'Hello' })
+
+// Listen for reply
+ipcRenderer.on('reply', (event, data) => {
+  console.log('Received:', data)
+})
+
+// Send synchronous message
+const result = ipcRenderer.sendSync('sync-message', { data: 'Hello' })
+console.log('Result:', result)
+```
+
+### Example: IPC Channels
+
+```javascript
+// Define IPC channels
+const IPC_CHANNELS = {
+  GET_DATA: 'get-data',
+  SET_DATA: 'set-data',
+  NOTIFY: 'notify'
+}
+
+// Main process
+ipcMain.on(IPC_CHANNELS.GET_DATA, (event) => {
+  event.reply(IPC_CHANNELS.GET_DATA, { data: 'value' })
+})
+
+// Renderer process
+ipcRenderer.send(IPC_CHANNELS.GET_DATA)
+ipcRenderer.on(IPC_CHANNELS.GET_DATA, (event, data) => {
+  console.log('Data:', data)
+})
+```
+
+### Key Points
+
+- Use ipcMain in main process
+- Use ipcRenderer in renderer process
+- Define IPC channels
+- Handle async and sync messages
+- Proper error handling

package/skill-packs/electron/skills/electron-egg/examples/features/main-process.md

@@ -0,0 +1,89 @@
+# Main Process
+
+**官方文档**: https://www.kaka996.com/,
+
+
+## Instructions
+
+This example demonstrates main process usage in Electron EGG.
+
+### Key Concepts
+
+- Main process entry
+- Application lifecycle
+- Window management
+- IPC handling
+
+### Example: Main Process Entry
+
+```javascript
+// main/index.js
+const { Application } = require('electron-egg')
+
+const app = new Application({
+  // Configuration
+})
+
+app.start()
+```
+
+### Example: Application Lifecycle
+
+```javascript
+// main/index.js
+const { Application } = require('electron-egg')
+
+const app = new Application()
+
+app.on('ready', () => {
+  console.log('Application ready')
+})
+
+app.on('window-all-closed', () => {
+  if (process.platform !== 'darwin') {
+    app.quit()
+  }
+})
+
+app.start()
+```
+
+### Example: Window Management
+
+```javascript
+// main/window/main.js
+const { BrowserWindow } = require('electron')
+
+function createWindow() {
+  const win = new BrowserWindow({
+    width: 1200,
+    height: 800
+  })
+
+  win.loadFile('renderer/index.html')
+  
+  return win
+}
+
+module.exports = { createWindow }
+```
+
+### Example: IPC Handling
+
+```javascript
+// main/index.js
+const { ipcMain } = require('electron')
+
+ipcMain.on('message', (event, data) => {
+  console.log('Received:', data)
+  event.reply('reply', 'Response')
+})
+```
+
+### Key Points
+
+- Main process runs in Node.js
+- Handle application lifecycle
+- Manage windows
+- Handle IPC communication
+- Access Node.js APIs

package/skill-packs/electron/skills/electron-egg/examples/features/renderer-process.md

@@ -0,0 +1,74 @@
+# Renderer Process
+
+**官方文档**: https://www.kaka996.com/,
+
+
+## Instructions
+
+This example demonstrates renderer process usage in Electron EGG.
+
+### Key Concepts
+
+- Renderer process entry
+- UI rendering
+- IPC communication
+- DOM manipulation
+
+### Example: Renderer Process Entry
+
+```html
+<!-- renderer/index.html -->
+<!DOCTYPE html>
+<html>
+<head>
+  <title>My App</title>
+</head>
+<body>
+  <div id="app"></div>
+  <script src="./src/index.js"></script>
+</body>
+</html>
+```
+
+### Example: UI Rendering
+
+```javascript
+// renderer/src/index.js
+document.addEventListener('DOMContentLoaded', () => {
+  const app = document.getElementById('app')
+  app.innerHTML = '<h1>Hello Electron EGG</h1>'
+})
+```
+
+### Example: IPC Communication
+
+```javascript
+// renderer/src/index.js
+const { ipcRenderer } = require('electron')
+
+// Send message to main process
+ipcRenderer.send('message', { data: 'Hello' })
+
+// Listen for reply
+ipcRenderer.on('reply', (event, data) => {
+  console.log('Received:', data)
+})
+```
+
+### Example: DOM Manipulation
+
+```javascript
+// renderer/src/index.js
+const button = document.getElementById('button')
+button.addEventListener('click', () => {
+  console.log('Button clicked')
+})
+```
+
+### Key Points
+
+- Renderer process runs in browser
+- Use HTML/CSS/JavaScript
+- Communicate via IPC
+- Access DOM APIs
+- Limited Node.js access

package/skill-packs/electron/skills/electron-egg/examples/guide/build.md

@@ -0,0 +1,77 @@
+# Build and Package
+
+**官方文档**: https://www.kaka996.com/,
+
+
+## Instructions
+
+This example demonstrates how to build and package Electron EGG applications.
+
+### Key Concepts
+
+- Build process
+- Package configuration
+- Platform-specific builds
+- Distribution
+
+### Example: Build Process
+
+```bash
+# Build for production
+npm run build
+
+# Build for specific platform
+npm run build:win
+npm run build:mac
+npm run build:linux
+```
+
+### Example: Package Configuration
+
+```json
+{
+  "build": {
+    "appId": "com.example.myapp",
+    "productName": "My App",
+    "directories": {
+      "output": "dist"
+    },
+    "files": [
+      "main/**/*",
+      "renderer/**/*",
+      "config/**/*"
+    ]
+  }
+}
+```
+
+### Example: Platform-Specific Builds
+
+```bash
+# Windows
+npm run build:win
+
+# macOS
+npm run build:mac
+
+# Linux
+npm run build:linux
+
+# All platforms
+npm run build:all
+```
+
+### Example: Distribution
+
+After building, distribution files are in the `dist` directory:
+- Windows: `.exe` installer
+- macOS: `.dmg` or `.pkg`
+- Linux: `.AppImage` or `.deb`
+
+### Key Points
+
+- Use npm run build for production
+- Configure build options
+- Support multiple platforms
+- Output to dist directory
+- Follow platform conventions

package/skill-packs/electron/skills/electron-egg/examples/guide/configuration.md

@@ -0,0 +1,88 @@
+# Configuration
+
+**官方文档**: https://www.kaka996.com/,
+
+
+## Instructions
+
+This example demonstrates how to configure Electron EGG.
+
+### Key Concepts
+
+- Configuration files
+- App info configuration
+- Window configuration
+- Plugin configuration
+
+### Example: Configuration Files
+
+```javascript
+// config/config.default.js
+module.exports = {
+  appInfo: {
+    name: 'my-app',
+    baseDir: __dirname,
+    env: 'local',
+    home: process.env.HOME,
+    root: process.cwd(),
+    appUserDataDir: ''
+  }
+}
+```
+
+### Example: App Info Configuration
+
+```javascript
+module.exports = {
+  appInfo: {
+    name: 'my-app',           // App name
+    baseDir: __dirname,        // Base directory
+    env: 'local',              // Environment
+    home: process.env.HOME,    // Home directory
+    root: process.cwd(),       // Root directory
+    appUserDataDir: ''        // User data directory
+  }
+}
+```
+
+### Example: Window Configuration
+
+```javascript
+module.exports = {
+  mainWindow: {
+    width: 1200,
+    height: 800,
+    minWidth: 800,
+    minHeight: 600,
+    title: 'My App',
+    frame: true,
+    transparent: false
+  }
+}
+```
+
+### Example: Plugin Configuration
+
+```javascript
+module.exports = {
+  addons: {
+    tray: {
+      enable: true
+    },
+    security: {
+      enable: true
+    },
+    autoUpdater: {
+      enable: false
+    }
+  }
+}
+```
+
+### Key Points
+
+- Configure in config files
+- Support multiple environments
+- Window configuration options
+- Plugin enable/disable
+- Environment-specific configs

package/skill-packs/electron/skills/electron-egg/examples/guide/installation.md

@@ -0,0 +1,66 @@
+# Installation
+
+**官方文档**: https://www.kaka996.com/,
+
+
+## Instructions
+
+This example demonstrates how to install Electron EGG.
+
+### Key Concepts
+
+- Environment requirements
+- Package installation
+- Project initialization
+- Dependencies
+
+### Example: Environment Requirements
+
+- Node.js >= 14.x
+- npm or yarn or pnpm
+- Go (optional, for Go business process)
+
+### Example: Package Installation
+
+```bash
+# Using npm
+npm install electron-egg
+
+# Using yarn
+yarn add electron-egg
+
+# Using pnpm
+pnpm add electron-egg
+```
+
+### Example: Project Initialization
+
+```bash
+# Clone demo repository
+git clone https://gitee.com/dromara/electron-egg.git
+
+# Install dependencies
+cd electron-egg
+npm install
+```
+
+### Example: Install Dependencies
+
+```bash
+# Install all dependencies
+npm install
+
+# Or using yarn
+yarn install
+
+# Or using pnpm
+pnpm install
+```
+
+### Key Points
+
+- Check Node.js version
+- Install dependencies properly
+- Use demo repository for quick start
+- Support npm, yarn, pnpm
+- Optional Go support

package/skill-packs/electron/skills/electron-egg/examples/guide/intro.md

@@ -0,0 +1,47 @@
+# Introduction
+
+**官方文档**: https://www.kaka996.com/,
+
+
+## Instructions
+
+This example provides an introduction to Electron EGG.
+
+### Key Concepts
+
+- What is Electron EGG
+- Framework architecture
+- Core features
+- Version information
+
+### Example: What is Electron EGG
+
+Electron EGG is a desktop application development framework based on Electron and Egg.js, providing a complete development toolchain and best practices.
+
+### Example: Framework Architecture
+
+Electron EGG uses a multi-process architecture:
+- **Main Process**: Main application process
+- **Renderer Process**: UI rendering process
+- **Business Process**: Optional business logic process (Python/Go)
+
+### Example: Core Features
+
+- **Multi-process Architecture**: Main, renderer, and business processes
+- **IPC Communication**: Inter-process communication
+- **Plugin System**: Extensible plugin architecture
+- **Hot Reload**: Development hot reload
+- **Build Tools**: Complete build and package tools
+- **Cross-platform**: Support Windows, macOS, Linux
+
+### Example: Version Information
+
+Electron EGG v4.x is the current stable version.
+
+### Key Points
+
+- Based on Electron and Egg.js
+- Multi-process architecture
+- Rich development tools
+- Plugin system support
+- Active development and maintenance