@leejungkiin/awkit 1.5.5 → 1.5.6

package/skill-packs/electron/skills/electron/templates/main-process.md

@@ -0,0 +1,105 @@
+# Main Process Template | 主进程模板
+
+## Basic Main Process Template
+
+```javascript
+// main.js
+const { app, BrowserWindow } = require('electron')
+const path = require('path')
+
+let mainWindow
+
+function createWindow() {
+  mainWindow = new BrowserWindow({
+    width: 800,
+    height: 600,
+    webPreferences: {
+      preload: path.join(__dirname, 'preload.js'),
+      contextIsolation: true,
+      nodeIntegration: false
+    }
+  })
+
+  mainWindow.loadFile('index.html')
+  
+  // Open DevTools in development
+  if (process.env.NODE_ENV === 'development') {
+    mainWindow.webContents.openDevTools()
+  }
+  
+  mainWindow.on('closed', () => {
+    mainWindow = null
+  })
+}
+
+app.whenReady().then(() => {
+  createWindow()
+
+  app.on('activate', () => {
+    if (BrowserWindow.getAllWindows().length === 0) {
+      createWindow()
+    }
+  })
+})
+
+app.on('window-all-closed', () => {
+  if (process.platform !== 'darwin') {
+    app.quit()
+  }
+})
+```
+
+## With IPC Setup
+
+```javascript
+// main.js
+const { app, BrowserWindow, ipcMain } = require('electron')
+const path = require('path')
+
+let mainWindow
+
+function createWindow() {
+  mainWindow = new BrowserWindow({
+    width: 800,
+    height: 600,
+    webPreferences: {
+      preload: path.join(__dirname, 'preload.js'),
+      contextIsolation: true,
+      nodeIntegration: false
+    }
+  })
+
+  mainWindow.loadFile('index.html')
+  
+  mainWindow.on('closed', () => {
+    mainWindow = null
+  })
+}
+
+// IPC Handlers
+ipcMain.handle('get-app-version', () => {
+  return app.getVersion()
+})
+
+ipcMain.on('window-minimize', () => {
+  if (mainWindow) {
+    mainWindow.minimize()
+  }
+})
+
+app.whenReady().then(() => {
+  createWindow()
+})
+
+app.on('window-all-closed', () => {
+  if (process.platform !== 'darwin') {
+    app.quit()
+  }
+})
+
+app.on('activate', () => {
+  if (BrowserWindow.getAllWindows().length === 0) {
+    createWindow()
+  }
+})
+```

package/skill-packs/electron/skills/electron/templates/preload-script.md

@@ -0,0 +1,84 @@
+# Preload Script Template | Preload 脚本模板
+
+## Basic Preload Script
+
+```javascript
+// preload.js
+const { contextBridge, ipcRenderer } = require('electron')
+
+// Expose protected methods to renderer
+contextBridge.exposeInMainWorld('electronAPI', {
+  // Get app version
+  getVersion: () => ipcRenderer.invoke('get-app-version'),
+  
+  // Window controls
+  minimize: () => ipcRenderer.send('window-minimize'),
+  maximize: () => ipcRenderer.send('window-maximize'),
+  close: () => ipcRenderer.send('window-close'),
+  
+  // File operations
+  openFile: () => ipcRenderer.invoke('dialog:openFile'),
+  saveFile: (data) => ipcRenderer.invoke('dialog:saveFile', data),
+  
+  // Listen to main process
+  onUpdateAvailable: (callback) => {
+    ipcRenderer.on('update-available', (event, data) => callback(data))
+  },
+  
+  // Remove listeners
+  removeAllListeners: (channel) => {
+    ipcRenderer.removeAllListeners(channel)
+  }
+})
+```
+
+## Advanced Preload Script
+
+```javascript
+// preload.js
+const { contextBridge, ipcRenderer } = require('electron')
+
+// Expose API with error handling
+contextBridge.exposeInMainWorld('electronAPI', {
+  // Safe IPC invoke
+  invoke: async (channel, ...args) => {
+    const validChannels = [
+      'get-app-version',
+      'dialog:openFile',
+      'dialog:saveFile'
+    ]
+    
+    if (validChannels.includes(channel)) {
+      return await ipcRenderer.invoke(channel, ...args)
+    }
+    throw new Error(`Invalid channel: ${channel}`)
+  },
+  
+  // Safe IPC send
+  send: (channel, ...args) => {
+    const validChannels = [
+      'window-minimize',
+      'window-maximize',
+      'window-close'
+    ]
+    
+    if (validChannels.includes(channel)) {
+      ipcRenderer.send(channel, ...args)
+    }
+  },
+  
+  // Safe event listener
+  on: (channel, callback) => {
+    const validChannels = ['update-available', 'app-version']
+    
+    if (validChannels.includes(channel)) {
+      ipcRenderer.on(channel, (event, ...args) => callback(...args))
+    }
+  },
+  
+  // Remove listener
+  removeListener: (channel, callback) => {
+    ipcRenderer.removeListener(channel, callback)
+  }
+})
+```

package/skill-packs/electron/skills/electron-egg/LICENSE.txt

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/skill-packs/electron/skills/electron-egg/SKILL.md

@@ -0,0 +1,154 @@
+---
+name: electron-egg
+description: "Build desktop applications with the Electron EGG framework, covering project setup, main/renderer process communication, window management, plugin system, and build/packaging. Use when the user asks about Electron EGG, electron-egg, needs to create Electron applications with EGG, or work with Electron EGG patterns."
+license: Complete terms in LICENSE.txt
+---
+
+## When to use this skill
+
+Use this skill whenever the user wants to:
+- Install and set up Electron EGG in a project
+- Create Electron desktop applications
+- Use Electron EGG core features
+- Configure Electron EGG
+- Handle main process and renderer process communication
+- Use Electron EGG API methods
+- Build and package Electron applications
+- Troubleshoot Electron EGG issues
+
+## How to use this skill
+
+This skill is organized to match the Electron EGG official documentation structure (https://www.kaka996.com/, https://www.kaka996.com/pages/987b1c/, https://www.kaka996.com/pages/a99b72/). When working with Electron EGG:
+
+1. **Identify the topic** from the user's request:
+   - Installation/安装 → `examples/guide/installation.md`
+   - Quick Start/快速开始 → `examples/guide/quick-start.md`
+   - Features/功能特性 → `examples/features/`
+   - API/API 文档 → `api/`
+
+2. **Load the appropriate example file** from the `examples/` directory:
+
+   **Guide (使用文档)**:
+   - `examples/guide/intro.md` - Introduction to Electron EGG
+   - `examples/guide/installation.md` - Installation guide
+   - `examples/guide/quick-start.md` - Quick start guide
+   - `examples/guide/project-structure.md` - Project structure
+   - `examples/guide/configuration.md` - Configuration
+   - `examples/guide/build.md` - Build and package
+
+   **Features (功能特性)**:
+   - `examples/features/main-process.md` - Main process
+   - `examples/features/renderer-process.md` - Renderer process
+   - `examples/features/ipc-communication.md` - IPC communication
+   - `examples/features/window-management.md` - Window management
+   - `examples/features/menu.md` - Menu
+   - `examples/features/tray.md` - System tray
+   - `examples/features/auto-updater.md` - Auto updater
+   - `examples/features/plugin-system.md` - Plugin system
+
+3. **Follow the specific instructions** in that example file for syntax, structure, and best practices
+
+   **Important Notes**:
+   - Electron EGG is based on Electron and Egg.js
+   - Main process and renderer process separation
+   - IPC communication between processes
+   - Each example file includes key concepts, code examples, and key points
+
+4. **Reference API documentation** in the `api/` directory when needed:
+   - `api/main-api.md` - Main process API
+   - `api/renderer-api.md` - Renderer process API
+   - `api/ipc-api.md` - IPC API
+   - `api/window-api.md` - Window API
+   - `api/config-api.md` - Configuration API
+
+   **API Files:**
+   - `api/main-api.md` - Application class, BrowserWindow, ipcMain, app methods
+   - `api/renderer-api.md` - ipcRenderer, contextBridge, DOM APIs
+   - `api/ipc-api.md` - IPC communication methods and events
+   - `api/window-api.md` - Window creation and management
+   - `api/config-api.md` - Configuration options and environment variables
+
+5. **Use templates** from the `templates/` directory:
+   - `templates/installation.md` - Installation templates
+   - `templates/project-setup.md` - Project setup templates
+   - `templates/configuration.md` - Configuration templates
+
+### 1. Understanding Electron EGG
+
+Electron EGG is a desktop application development framework based on Electron and Egg.js, providing a complete development toolchain and best practices.
+
+**Key Concepts**:
+- **Electron**: Cross-platform desktop application framework
+- **Egg.js**: Node.js enterprise application framework
+- **Main Process**: Main application process
+- **Renderer Process**: UI rendering process
+- **IPC**: Inter-process communication
+- **Plugin System**: Extensible plugin architecture
+
+### 2. Installation
+
+**Using npm**:
+
+```bash
+npm install electron-egg
+```
+
+**Using yarn**:
+
+```bash
+yarn add electron-egg
+```
+
+**Using pnpm**:
+
+```bash
+pnpm add electron-egg
+```
+
+### 3. Basic Setup
+
+```javascript
+// main.js
+const { Application } = require('electron-egg')
+
+const app = new Application({
+  // Configuration
+})
+
+app.start()
+```
+
+
+### Doc mapping (one-to-one with official documentation)
+
+- `examples/` → https://www.kaka996.com/pages/987b1c/
+- `api/` → https://www.kaka996.com/pages/a99b72/
+
+## API Reference (`api/`)
+
+- `api/main-api.md` - Application class, BrowserWindow, ipcMain, lifecycle hooks
+- `api/renderer-api.md` - ipcRenderer, contextBridge, DOM APIs
+- `api/ipc-api.md` - IPC communication methods and channels
+- `api/window-api.md` - Window creation, management, events
+- `api/config-api.md` - Configuration options and environment variables
+
+## Best Practices
+
+1. **Separate processes**: Keep main process and renderer process code separate
+2. **Use IPC**: Use IPC for inter-process communication
+3. **Handle errors**: Properly handle errors in both processes
+4. **Security**: Follow Electron security best practices
+5. **Performance**: Optimize application performance
+6. **Build configuration**: Configure build and package properly
+7. **Plugin system**: Use plugin system for extensibility
+
+## Resources
+
+- **Official Documentation**: https://www.kaka996.com/
+- **Usage Guide**: https://www.kaka996.com/pages/987b1c/
+- **API Documentation**: https://www.kaka996.com/pages/a99b72/
+- **Gitee Repository**: https://gitee.com/dromara/electron-egg
+
+## Keywords
+
+Electron EGG, electron-egg, Electron, Egg.js, desktop application, 桌面应用, 主进程, 渲染进程, IPC, 进程间通信, 窗口管理, 菜单, 系统托盘, 自动更新, 插件系统, main process, renderer process, inter-process communication, window management, menu, system tray, auto updater, plugin system

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

@@ -0,0 +1,62 @@
+# Configuration API
+
+## API Reference
+
+Electron EGG configuration API.
+
+### Configuration Files
+
+Configuration files are in the `config/` directory:
+- `config.default.js` - Default configuration
+- `config.local.js` - Local development configuration
+- `config.prod.js` - Production configuration
+
+### App Info Configuration
+
+```javascript
+appInfo: {
+  name: string,           // App name
+  baseDir: string,        // Base directory
+  env: string,            // Environment
+  home: string,           // Home directory
+  root: string,           // Root directory
+  appUserDataDir: string  // User data directory
+}
+```
+
+### Window Configuration
+
+```javascript
+mainWindow: {
+  width: number,          // Window width
+  height: number,         // Window height
+  minWidth: number,       // Minimum width
+  minHeight: number,      // Minimum height
+  title: string,          // Window title
+  frame: boolean,         // Show frame
+  transparent: boolean    // Transparent window
+}
+```
+
+### Plugin Configuration
+
+```javascript
+addons: {
+  tray: {
+    enable: boolean       // Enable system tray
+  },
+  security: {
+    enable: boolean       // Enable security
+  },
+  autoUpdater: {
+    enable: boolean       // Enable auto updater
+  }
+}
+```
+
+### Environment Variables
+
+- `NODE_ENV` - Node environment
+- `ELECTRON_EGG_ENV` - Electron EGG environment
+
+**See also:** `examples/guide/configuration.md` for detailed examples

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

@@ -0,0 +1,55 @@
+# IPC API
+
+## API Reference
+
+Electron EGG IPC communication API.
+
+### Main Process (ipcMain)
+
+**ipcMain.on(channel, listener)**
+- Listen for IPC messages from renderer
+
+**ipcMain.once(channel, listener)**
+- Listen for IPC message once
+
+**ipcMain.handle(channel, listener)**
+- Handle IPC requests (async)
+
+**ipcMain.removeListener(channel, listener)**
+- Remove IPC listener
+
+**ipcMain.removeAllListeners(channel)**
+- Remove all listeners for channel
+
+### Renderer Process (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
+
+### Event Object
+
+**event.sender**
+- WebContents that sent the message
+
+**event.reply(channel, ...args)**
+- Reply to sender
+
+**event.returnValue**
+- Return value for synchronous messages
+
+**See also:** `examples/features/ipc-communication.md` for detailed examples