@flun/windows 4.0.0 → 5.0.0

package/CHANGELOG.md

@@ -1,5 +1,29 @@
 # 变更日志
 
+## [5.0.0] - 2026-11-13 11:48
+### 破坏性变更
+- 命令行服务管理改为 `windows s <命令>`,`s` 可写全称 `service`;原 `windows install` 等形式不再支持;
+  动机:`windows` 既是包名又是平台名,直接跟子命令语义不清;
+- `win-service.config.js` 改为具名声明 `winServiceConfig`,并同时提供默认导出与命名导出;
+  `import x from` 与 `import { winServiceConfig } from` 均可用,但不再为匿名 `export default`;
+
+### 优化
+- 全包 JS 与 `.d.ts` 的导入、声明、导出顺序按规范统一;导入按项目外依赖在前、相对路径在后各自字母序;
+  导入花括号内按被导入项在源模块的类型分组;声明与导出按变量 > 函数 > 类分组;
+- JSDoc 补全 `@see`、`@param`、`@returns`,并使 `@see` 位于所有其它 `@` 条目前;
+
+### 修复
+- 各文件 JSDoc 示例中 `win-service.config.js` 的导入名与 `new Service(...)` 实参不一致;
+- `index.d.ts` 主聚合块的代码块、`@see`、`declare module` 导出三处顺序不一致,现同序;
+- `binaries.js` 的 `platform` JSDoc 在导入重排后与其声明分离,现随声明一同移动;
+
+### 文档
+- README 命令行章节同步为 `windows s <命令>` 形式,命令表、状态码说明、示例一并更新;
+
+## [4.0.1] - 2026-11-06 10:24
+### 优化
+- 优化了部分细节;
+
 ## [4.0.0] - 2026-11-03 22:34
 ### 破坏性变更
 - `Service#install()` 默认在安装成功后启动服务;旧行为只安装不启动,如需保持旧行为传 `autoStart = false`;
@@ -23,14 +47,4 @@
 ### 文档
 - README 新增「命令行」章节,含快速开始、命令表(按服务类与其它分组)、命令行参数、服务配置;
 - README 新增「参考配置」章节,逐字段说明含义与默认值;
-- README 函数方式示例改为导入 `win-service.config.js`,并补 `quiet` 说明;
-
-## [3.0.11] - 2026-10-25 15:57
-### 优化
-- 项目标点已改为以英文标点为主;
-- 行宽改为以 123 为主,部分超宽表格改为了列表;
-
-## [3.0.10] - 2026-09-29 19:29
-### 更改
-- 加固了拷贝文件的一些逻辑;
-- 升级了依赖;
+- README 函数方式示例改为导入 `win-service.config.js`,并补 `quiet` 说明;

package/README.md

@@ -33,8 +33,9 @@
 
 ```
 @flun/windows/
-├── index.js              库入口,导出 elevate / sudo / isAdminUser / kill / list / Service / EventLogger
-├── index.d.ts            类型声明
+├── bin/winsw/            winsw 可执行文件(内部资源,非命令)
+├── bin/cli.js            命令行入口
+├── bin/elevate.vbs       UAC 提权脚本(内部资源,非命令)
 ├── lib/binaries.js       外部二进制定位与提权调用
 ├── lib/cmd.js            进程列表与终止
 ├── lib/daemon.js         Windows 服务管理类
@@ -42,15 +43,14 @@
 ├── lib/winsw.js          winsw 配置生成
 ├── lib/wrapper.js        进程包装器
 ├── lib/shared.js         共享工具函数
-├── bin/winsw/            winsw 可执行文件(内部资源,非命令)
-├── bin/elevate.vbs       UAC 提权脚本(内部资源,非命令)
-├── bin/cli.js            命令行入口
-├── win-service.config.js 服务配置模板(全量字段,必填项带 *)
-├── copy-files.js         postinstall 复制二进制资源
-├── package.json          包配置
 ├── README.md             本文件
 ├── CHANGELOG.md          更新日志
-└── LICENSE               许可
+├── copy-files.js         postinstall 复制二进制资源
+├── index.js              库入口,导出 elevate / sudo / isAdminUser / kill / list / Service / EventLogger
+├── win-service.config.js 服务配置模板(全量字段,必填项带 *)
+├── index.d.ts            类型声明
+├── LICENSE               许可
+└── package.json          包配置
 ```
 
 ## 安装前准备
@@ -107,9 +107,9 @@ windows <命令> [--键 值]
 编辑`win-service.config.js`文件,填写带 `*` 的必填项 `name` 与 `script`;
 
 ```bash
-windows install # 按配置文件安装并启动服务
+windows s install # 按配置文件安装并启动服务
 
-windows install --name MyApp --script D:\app\main.js # 带参安装并启动
+windows s install --name MyApp --script D:\app\main.js # 带参安装并启动
 ```
 
 安装后默认启动服务;若只需安装,加 `--no-start`;
@@ -120,16 +120,16 @@ windows install --name MyApp --script D:\app\main.js # 带参安装并启动
 
 #### 服务类
 
-| 命令               | 说明                                          |
-| ------------------ | --------------------------------------------- |
-| `install`          | 安装服务,装完默认启动;`--no-start` 只装不启动 |
-| `uninstall`        | 卸载服务                                      |
-| `start`            | 启动服务                                      |
-| `stop`             | 停止服务                                      |
-| `restart`          | 重启服务                                      |
-| `status`           | 查询状态,输出 0-3                             |
-| `xml`              | 输出 winsw 配置 XML                           |
-| `exe [--dir 目录]` | 生成 winsw 可执行文件                         |
+| 命令                 | 说明                                          |
+| -------------------- | --------------------------------------------- |
+| `s install`          | 安装服务,装完默认启动;`--no-start` 只装不启动 |
+| `s uninstall`        | 卸载服务                                      |
+| `s start`            | 启动服务                                      |
+| `s stop`             | 停止服务                                      |
+| `s restart`          | 重启服务                                      |
+| `s status`           | 查询状态,输出 0-3                             |
+| `s xml`              | 输出 winsw 配置 XML                           |
+| `s exe [--dir 目录]` | 生成 winsw 可执行文件                         |
 
 #### 其它
 
@@ -143,7 +143,7 @@ windows install --name MyApp --script D:\app\main.js # 带参安装并启动
 | `example`              | 生成 `win-service.config.js` 模板到当前项目 |
 | `help`                 | 显示帮助                                    |
 
-`status` 输出状态码:`0` 不存在;`1` 有服务无文件;`2` 有文件无服务;`3` 完整存在;
+`s status` 输出状态码:`0` 不存在;`1` 有服务无文件;`2` 有文件无服务;`3` 完整存在;
 
 `log` 的级别取 `info`、`warn`、`error`、`success`、`failure`;`success` 与 `failure`
 分别对应 `auditSuccess` 与 `auditFailure`;可加 `--source <名>` 指定事件源,`--id <号>` 指定事件 ID;
@@ -154,13 +154,13 @@ windows install --name MyApp --script D:\app\main.js # 带参安装并启动
 # 前提:win-service.config.js 已提供 name 与 script;以下每条只覆盖部分字段
 
 # 1. 覆盖描述:装出的服务在服务管理器中显示为该描述
-windows install --description "我的服务"
+windows s install --description "我的服务"
 
 # 2. 覆盖 node 启动参数:服务以 --harmony 模式运行
-windows install --nodeOptions '["--harmony"]'
+windows s install --nodeOptions '["--harmony"]'
 
 # 3. 打开出错退出:脚本运行出错时进程直接退出(省略值即 true)
-windows install --abortOnError
+windows s install --abortOnError
 ```
 
 字符串值用双引号,JSON 值用单引号(避免 shell 解析方括号);值先按 JSON 解析,失败则按字符串处理;
@@ -175,9 +175,9 @@ windows install --abortOnError
 ```js
 // 创建并安装一个 Windows 服务:
 import { Service } from '@flun/windows';
-import config from './win-service.config.js';
+import winServiceConfig from './win-service.config.js';
 
-const svc = new Service(config);
+const svc = new Service(winServiceConfig);
 
 // 安装并自动启动服务(默认)
 svc.install();
@@ -209,9 +209,9 @@ svc.install();
 
 ```js
 import { Service } from '@flun/windows';
-import config from './win-service.config.js';
+import winServiceConfig from './win-service.config.js';
 
-const svc = new Service(config);
+const svc = new Service(winServiceConfig);
 
 // 安装并自动启动服务(默认)
 svc.install();
@@ -273,9 +273,9 @@ export default {
 
 ```js
 import { Service } from '@flun/windows';
-import config from './win-service.config.js';
+import winServiceConfig from './win-service.config.js';
 
-const svc = new Service(config);
+const svc = new Service(winServiceConfig);
 
 // 安装后指定特定用户或凭据以登录运行
 svc.logOnAs.domain = 'mydomain.local';
@@ -291,9 +291,9 @@ svc.logOnAs.mungeCredentialsAfterInstall = true; // 默认
 
 ```js
 import { Service } from '@flun/windows';
-import config from './win-service.config.js';
+import winServiceConfig from './win-service.config.js';
 
-const svc = new Service(config);
+const svc = new Service(winServiceConfig);
 svc.on('uninstall', ()=>{
   console.log('卸载完成');
   console.log('服务是否存在:', svc.exists);

package/bin/cli.js

@@ -1,11 +1,11 @@
 #!/usr/bin/env node
+import chalk from 'chalk';
+import { execSync } from 'child_process';
 import fs from 'fs';
 import path from 'path';
-import { execSync } from 'child_process';
 import { pathToFileURL } from 'url';
-import chalk from 'chalk';
-import { Service, kill, list, elevate, EventLogger } from '../index.js';
 import { copyFile } from '../copy-files.js';
+import { elevate, kill, list, EventLogger, Service } from '../index.js';
 
 const [, , sub, ...args] = process.argv,
   /**
@@ -122,19 +122,19 @@ const [, , sub, ...args] = process.argv,
    * 输出用法;
    */
   printHelp = () => {
-    const cmd = (name, desc) => `    ${chalk.cyanBright(name.padEnd(26))}${chalk.gray(desc)}`;
+    const cmd = (name, desc) => `      ${chalk.cyanBright(name.padEnd(26))}${chalk.gray(desc)}`;
     console.log([
-      `${chalk.blueBright('用法:')} windows <命令> [--键 值]`, '',
-      `  ${chalk.cyan('服务类')} ${chalk.gray('(默认读当前目录 win-service.config.js,--键 值 覆盖)')}`,
-      cmd('install', '安装服务,装完默认启动;--no-start 关闭自动启动'),
-      cmd('uninstall', '卸载服务'),
-      cmd('start', '启动服务'),
-      cmd('stop', '停止服务'),
-      cmd('restart', '重启服务'),
-      cmd('status', '查询状态,输出 0 不存在 1 有服务无文件 2 有文件无服务 3 完整'),
-      cmd('xml', '输出 winsw 配置 XML'),
-      cmd('exe', '生成 winsw 可执行文件;--dir 指定输出目录,默认脚本目录下 daemon'), '',
-      `  ${chalk.cyan('其它')}`,
+      `  ${chalk.blueBright('用法:')} windows <命令> [--键 值]`, '',
+      `    ${chalk.cyan('服务')} ${chalk.gray('(windows s|service;读 win-service.config.js)')}`,
+      cmd('s install', '安装服务,装完默认启动;--no-start 关闭自动启动'),
+      cmd('s uninstall', '卸载服务'),
+      cmd('s start', '启动服务'),
+      cmd('s stop', '停止服务'),
+      cmd('s restart', '重启服务'),
+      cmd('s status', '查询状态;0 不存在 1 有服务无文件 2 有文件无服务 3 完整'),
+      cmd('s xml', '输出 winsw 配置 XML'),
+      cmd('s exe', '生成 winsw 可执行文件;--dir 指定输出目录,默认 daemon'), '',
+      `    ${chalk.cyan('其它')}`,
       cmd('example', '生成 win-service.config.js 模板到当前项目'),
       cmd('list', '列出运行中的进程;--verbose 显示详细信息'),
       cmd('kill', '结束进程,参数为进程 PID;例如 kill 1234,--force 强制结束'),
@@ -150,6 +150,30 @@ const [, , sub, ...args] = process.argv,
    */
   main = async () => {
     if (!sub || sub === 'help' || sub === '-h' || sub === '--help') return printHelp(), process.exit(0);
+    if (sub === 's' || sub === 'service') {
+      const [svcCmd, ...svcArgs] = args;
+      if (!svcCmd || svcCmd === 'help' || svcCmd === '-h' || svcCmd === '--help') return printHelp(), process.exit(0);
+      if (svcCmd === 'xml') {
+        const { svc } = await buildService(svcArgs);
+        return console.log(svc.toXml()), process.exit(0);
+      }
+      if (svcCmd === 'exe') {
+        const { svc, flags } = await buildService(svcArgs);
+        try { await svc.toExe(flags.dir), console.log(chalk.green('✓ 已生成: ') + svc.root), process.exit(0) }
+        catch (e) { console.error(chalk.red('✗ ') + e.message), process.exit(1) }
+      }
+      if (svcCmd === 'status') {
+        const { svc } = await buildService(svcArgs), code = svc.exists,
+          color = code === 3 ? chalk.green : code === 0 ? chalk.red : chalk.yellow;
+        return console.log(chalk.gray('状态码: ') + color(code)), process.exit(0);
+      }
+      if (['install', 'uninstall', 'start', 'stop', 'restart'].includes(svcCmd)) {
+        try { await runService(svcCmd, svcArgs), process.exit(0) }
+        catch (e) { console.error(chalk.red('✗ ') + e.message), process.exit(1) }
+      }
+      console.error(chalk.red('✗ 未知服务命令: ') + chalk.yellow(svcCmd));
+      console.log(''), printHelp(), process.exit(1);
+    }
     if (sub === 'example') return copyFile() ? process.exit(0) : process.exit(1);
     if (sub === 'is-admin') {
       try {
@@ -185,8 +209,10 @@ const [, , sub, ...args] = process.argv,
       const { flags, rest } = parseFlags(args), [level, ...msgParts] = rest,
         methodMap = { info: 'info', warn: 'warn', error: 'error', success: 'auditSuccess', failure: 'auditFailure' },
         method = methodMap[level];
-      if (!method)
-        return console.error(chalk.red('✗ ') + `未知级别: ${level};可用:info|warn|error|success|failure`), process.exit(1);
+      if (!method) {
+        console.error(chalk.red('✗ ') + `未知级别: ${level};可用:info|warn|error|success|failure`);
+        process.exit(1);
+      }
       if (!msgParts.length) return console.error(chalk.red('✗ ') + '缺少消息'), process.exit(1);
       const logger = new EventLogger(flags.source ? { source: flags.source } : {});
       return logger[method](msgParts.join(' '), flags.id ?? 1000, err => {
@@ -194,24 +220,6 @@ const [, , sub, ...args] = process.argv,
         console.log(chalk.green('✓ ') + chalk.greenBright('已写入')), process.exit(0);
       });
     }
-    if (sub === 'xml') {
-      const { svc } = await buildService(args);
-      return console.log(svc.toXml()), process.exit(0);
-    }
-    if (sub === 'exe') {
-      const { svc, flags } = await buildService(args);
-      try { await svc.toExe(flags.dir), console.log(chalk.green('✓ 已生成: ') + svc.root), process.exit(0) }
-      catch (e) { console.error(chalk.red('✗ ') + e.message), process.exit(1) }
-    }
-    if (sub === 'status') {
-      const { svc } = await buildService(args), code = svc.exists,
-        color = code === 3 ? chalk.green : code === 0 ? chalk.red : chalk.yellow;
-      return console.log(chalk.gray('状态码: ') + color(code)), process.exit(0);
-    }
-    if (['install', 'uninstall', 'start', 'stop', 'restart'].includes(sub)) {
-      try { await runService(sub, args), process.exit(0) }
-      catch (e) { console.error(chalk.red('✗ ') + e.message), process.exit(1) }
-    }
     console.error(chalk.red('✗ 未知命令: ') + chalk.yellow(sub)), console.log(''), printHelp(), process.exit(1);
   };
 

package/copy-files.js

@@ -1,3 +1,4 @@
+import chalk from 'chalk';
 import fs from 'fs';
 import path from 'path';
 import { fileURLToPath } from 'url';
@@ -13,19 +14,19 @@ const __filename = fileURLToPath(import.meta.url), __dirname = path.dirname(__fi
  * @returns {boolean} - 复制是否成功
  */
 const copyFile = () => {
-    console.log(`🔍 检查 ${fileName} 文件...`), console.log(`📁 项目根目录:${targetDir}`);
+    console.log(chalk.gray('项目根目录: ') + targetDir);
     try {
         // 目标目录不是 Node 项目 || 包自身的 npm install(开发调试)→ 跳过
         if (!fs.existsSync(path.join(targetDir, 'package.json'))) return true;
         if (targetDir === path.resolve(__dirname, '..')) return true;
         if (fs.existsSync(targetFile)) return true;  // 目标文件已存在 → 直接返回
-        console.log(`⚠️ 在项目根目录未找到 ${fileName} 文件,正在创建...`);
+        console.log(chalk.cyan('· ') + `未找到 ${fileName},正在创建...`);
 
         fs.copyFileSync(sourceFile, targetFile);     // 复制源文件到项目根目录
-        console.log(`✓ 已创建 ${fileName} 示例文件:${targetFile}`);
+        console.log(chalk.green('✓ ') + chalk.greenBright(`已生成 ${fileName}: `) + chalk.gray(targetFile));
         return true;
     } catch (error) {
-        console.error(`✗ 创建 ${fileName} 文件失败:`, error.message);
+        console.error(chalk.red('✗ ') + `创建 ${fileName} 失败: ` + error.message);
         return false;
     }
 };

package/index.d.ts

@@ -1,22 +1,22 @@
-import { elevate, sudo, isAdminUser, platform } from './lib/binaries.js';
+import { platform, elevate, isAdminUser, sudo } from './lib/binaries.js';
 import { kill, list } from './lib/cmd.js';
 import { Service } from './lib/daemon.js';
 import { EventLogger } from './lib/eventlog.js';
 import {
-    exec, execSync, fork, promisify, execPromise, path, fs, EventEmitter, isPermissionError, getDirname
+    EventEmitter, exec, execSync, fork, fs, path, promisify, execPromise, getDirname, isPermissionError
 } from './lib/shared.js';
-import { generateXml, createExe } from './lib/winsw.js';
+import { createExe, generateXml } from './lib/winsw.js';
 
 // =================================== lib/binaries.js ===================================
 /**
  * ```js
  * // 文件导出内容
+ * platform();    // 获取操作系统平台字符串,用于判断当前运行环境是否为Windows
  * elevate();     // 提升当前进程权限(Windows UAC)
- * sudo();        // 使用sudo.exe提升权限(适用于Windows 10及以上版本)
  * isAdminUser(); // 检查当前用户是否拥有管理员权限
- * platform();    // 获取操作系统平台字符串,用于判断当前运行环境是否为Windows
+ * sudo();        // 使用sudo.exe提升权限(适用于Windows 10及以上版本)
  * ```
- * >查看定义:@see {@link elevate}、{@link sudo}、{@link isAdminUser}、{@link platform}
+ * >查看定义:@see {@link platform}、{@link elevate}、{@link isAdminUser}、{@link sudo}
  */
 declare module './lib/binaries.js' {
     export * from './lib/binaries.js';
@@ -63,22 +63,22 @@ declare module './lib/eventlog.js' {
 /**
  * 共享模块,导出在多个文件中使用的常用函数和模块
  * ```js
- * // 外部包函数
+ * // 外部包参数
+ * class EventEmitter{}; // Node.js内置模块,提供事件驱动编程的功能,允许对象之间进行事件通信
  * exec();               // 子进程执行命令的函数,提供回调和Promise两种接口
  * execSync;             // 子进程执行命令的同步函数,返回命令输出结果
  * fork();               // 创建一个新的Node.js子进程来运行指定的模块,提供与父进程的通信通道
+ * fs;                   // Node.js内置模块,提供文件系统操作功能
+ * path;                 // Node.js内置模块,提供文件路径处理功能
  * promisify();          // 将Node.js回调风格的函数转换为返回Promise的函数
- * 模块:
- * path, fs;             // Node.js内置模块,提供文件路径处理、文件系统操作等功能
- * class EventEmitter{}; // Node.js内置模块,提供事件驱动编程的功能,允许对象之间进行事件通信
- * // 自定义函数:
+ * // 自定义变量:
  * execPromise();        // 基于exec函数的Promise版本,用于执行命令并以Promise方式获取结果
- * isPermissionError();  // 检查错误对象是否表示权限错误的函数,用于判断操作失败是否由于权限不足引起
+ * // 自定义函数:
  * getDirname();         // 获取当前模块目录路径的函数,用于在ES模块环境中替代__dirname变量的功能
+ * isPermissionError();  // 检查错误对象是否表示权限错误的函数,用于判断操作失败是否由于权限不足引起
  * ```
- * >查看定义:@see {@link exec}、{@link execSync}、{@link fork}、{@link promisify}、{@link path}、
- * {@link fs}、{@link EventEmitter}
- * - 自定义函数:{@link execPromise}、{@link isPermissionError}、{@link getDirname}
+ * >查看定义:@see {@link EventEmitter}、{@link exec}、{@link execSync}、{@link fork}、{@link fs}、{@link path}、
+ * {@link promisify}、{@link execPromise}、{@link getDirname}、{@link isPermissionError}
  */
 declare module './lib/shared.js' {
     export * from './lib/shared.js';
@@ -88,10 +88,10 @@ declare module './lib/shared.js' {
 /**
  * ```js
  * // 文件导出内容
- * generateXml(); // 生成 winsw 配置文件的 XML;
  * createExe();   // 创建 winsw 可执行文件,将 XML 配置文件和 Node.js 脚本打包成一个独立的 Windows 服务可执行文件;
+ * generateXml(); // 生成 winsw 配置文件的 XML;
  * ```
- * >查看定义:@see {@link generateXml}、{@link createExe}
+ * >查看定义:@see {@link createExe}、{@link generateXml}
  */
 declare module './lib/winsw.js' {
     export * from './lib/winsw.js';
@@ -101,23 +101,23 @@ declare module './lib/winsw.js' {
 /**
  * Windows功能模块 主要功能:
  * ```js
- * Service{};           // 服务管理类
- * EventLogger{};       // 事件日志记录器类
  * elevate();           // 权限提升(机制:ShellExecute + "runas")
- * sudo();              // 权限提升(机制:sudo.exe)
  * isAdminUser();       // 检查当前用户是否拥有管理员权限
+ * sudo();              // 权限提升(机制:sudo.exe)
  * kill();              // 结束指定PID进程
  * list();              // 列出服务器上正在运行的进程
+ * Service{};           // 服务管理类
+ * EventLogger{};       // 事件日志记录器类
  * ```
  * ---
- * >查看定义:@see {@link Service}、{@link EventLogger}、{@link elevate}、{@link sudo}、{@link isAdminUser}、
- * {@link kill}、{@link list}
+ * >查看定义:@see {@link elevate}、{@link isAdminUser}、{@link sudo}、{@link kill}、{@link list}、
+ * {@link Service}、{@link EventLogger}
  * @example
  *  // 基础示例
  *  import { Service } from '@flun/windows';
- *  import config from './win-service.config.js';
+ *  import winServiceConfig from './win-service.config.js';
  *
- *  const svc = new Service(config);
+ *  const svc = new Service(winServiceConfig);
  *
  *  // 安装并自动启动服务(默认)
  *  svc.install();
@@ -127,7 +127,7 @@ declare module './lib/winsw.js' {
  *
  */
 declare module './index.js' {
-    export { elevate, sudo, isAdminUser } from './lib/binaries.js';
+    export { elevate, isAdminUser, sudo } from './lib/binaries.js';
     export { kill, list } from './lib/cmd.js';
     export { Service } from './lib/daemon.js';
     export { EventLogger } from './lib/eventlog.js';

package/index.js

@@ -3,7 +3,7 @@ import { platform } from './lib/binaries.js';
 // 平台检查
 if (!platform().startsWith('win')) throw new Error('@flun/windows 仅支持在Windows系统上运行');
 
-export { elevate, sudo, isAdminUser } from './lib/binaries.js';
+export { elevate, isAdminUser, sudo } from './lib/binaries.js';
 export { kill, list } from './lib/cmd.js';
 export { Service } from './lib/daemon.js';
 export { EventLogger } from './lib/eventlog.js';

package/lib/binaries.js

@@ -1,10 +1,10 @@
-import { path, fs, exec, getDirname } from './shared.js';
 /**
  * 从 Node.js `os` 模块导入的 `platform` 函数,用于获取操作系统平台字符串;
  * >查看定义:@see {@link platform}
  * @type {() => string}
  */
 import { platform, tmpdir } from 'os';
+import { exec, fs, path, getDirname } from './shared.js';
 
 const __dirname = getDirname(import.meta.url), vbsPath = path.resolve(__dirname, '../bin/elevate.vbs'),
     /** 参数处理函数,用于标准化 options 和 callback 参数 */
@@ -80,6 +80,25 @@ const elevate = (cmd, options, callback) => {
     });
 };
 
+/**
+ * 检查当前用户是否拥有管理员权限
+ * >查看定义:@see {@link isAdminUser}
+ * @param {(isAdmin: boolean) => void} callback - 回调函数,接收布尔值表示是否为管理员
+ * @returns {void}
+ * @example
+ * import { isAdminUser  } from '@flun/windows';
+ * isAdminUser(isAdmin => {
+ *   if (isAdmin) console.log('当前用户是管理员');
+ *   else console.log('当前用户不是管理员');
+ * });
+ */
+const isAdminUser = callback => {
+    exec('NET SESSION', (err, so, se) => {
+        if (se.length !== 0) elevate('NET SESSION', (_err, _so, _se) => callback(_se.length === 0));
+        else callback(true);
+    });
+};
+
 /**
  * 使用 sudo 方式提升权限(与 elevate 相似但体验更好)
  * >查看定义:@see {@link sudo}
@@ -112,23 +131,4 @@ const sudo = (cmd, options, callback) => {
     exec(`sudo ${cmd}`, p.options, p.callback);
 };
 
-/**
- * 检查当前用户是否拥有管理员权限
- * >查看定义:@see {@link isAdminUser}
- * @param {(isAdmin: boolean) => void} callback - 回调函数,接收布尔值表示是否为管理员
- * @returns {void}
- * @example
- * import { isAdminUser  } from '@flun/windows';
- * isAdminUser(isAdmin => {
- *   if (isAdmin) console.log('当前用户是管理员');
- *   else console.log('当前用户不是管理员');
- * });
- */
-const isAdminUser = callback => {
-    exec('NET SESSION', (err, so, se) => {
-        if (se.length !== 0) elevate('NET SESSION', (_err, _so, _se) => callback(_se.length === 0));
-        else callback(true);
-    });
-};
-
-export { elevate, sudo, isAdminUser, platform };
+export { platform, elevate, isAdminUser, sudo };

package/lib/daemon.js

@@ -1,7 +1,7 @@
-import { execSync, execPromise, promisify, path, fs, EventEmitter, isPermissionError, getDirname } from './shared.js';
 import { elevate, sudo } from './binaries.js';
-import { generateXml, createExe } from './winsw.js';
 import { EventLogger } from './eventlog.js';
+import { EventEmitter, execSync, fs, path, promisify, execPromise, getDirname, isPermissionError } from './shared.js';
+import { createExe, generateXml } from './winsw.js';
 
 const __dirname = getDirname(import.meta.url), writeFileAsync = promisify(fs.writeFile), mkdirAsync = promisify(fs.mkdir),
   daemonDir = 'daemon', wrapper = path.resolve(path.join(__dirname, './wrapper.js')), nameRegex = /[<>:"\\/|?*]/g;
@@ -13,9 +13,9 @@ const __dirname = getDirname(import.meta.url), writeFileAsync = promisify(fs.wri
  * {@link restart}、{@link exists}
  * @example
  *  import { Service } from '@flun/windows';
- *  import config from './win-service.config.js';
+ *  import winServiceConfig from './win-service.config.js';
  *
- *  const svc = new Service(config);
+ *  const svc = new Service(winServiceConfig);
  *  // 安装并自动启动服务(默认)
  *  svc.install();
  *
@@ -248,9 +248,9 @@ class Service extends EventEmitter {
    * @event error - 在错误发生时触发
    * @example
    *  import { Service } from '@flun/windows';
-   *  import config from './win-service.config.js';
+   *  import winServiceConfig from './win-service.config.js';
    *
-   *  const svc = new Service(config);
+   *  const svc = new Service(winServiceConfig);
    *
    *  // 安装并在完成后自动启动(默认)
    *  svc.install();
@@ -290,9 +290,9 @@ class Service extends EventEmitter {
    * @event uninstall - 当卸载过程完成时触发
    * @example
    * import { Service } from '@flun/windows';
-   * import config from './win-service.config.js';
+   * import winServiceConfig from './win-service.config.js';
    *
-   * const svc = new Service(config);
+   * const svc = new Service(winServiceConfig);
    *
    * svc.on('uninstall', ()=>{
    *   console.log('卸载完成');
@@ -326,9 +326,9 @@ class Service extends EventEmitter {
    * @event start - 当服务启动时触发
    * @example
    *  import { Service } from '@flun/windows';
-   *  import config from './win-service.config.js';
+   *  import winServiceConfig from './win-service.config.js';
    *
-   *  const svc = new Service(config);
+   *  const svc = new Service(winServiceConfig);
    *
    * svc.on('start', ()=>{
    *   console.log('服务已启动');
@@ -357,9 +357,9 @@ class Service extends EventEmitter {
    * @event alreadystopped - 当服务已经停止时触发
    * @example
    *  import { Service } from '@flun/windows';
-   *  import config from './win-service.config.js';
+   *  import winServiceConfig from './win-service.config.js';
    *
-   *  const svc = new Service(config);
+   *  const svc = new Service(winServiceConfig);
    * svc.on('stop', ()=>{
    *   console.log('服务已停止');
    * });
@@ -381,9 +381,9 @@ class Service extends EventEmitter {
    * @returns {Promise<void>}
    * @example
    * import { Service } from '@flun/windows';
-   * import config from './win-service.config.js';
+   * import winServiceConfig from './win-service.config.js';
    *
-   * const svc = new Service(config);
+   * const svc = new Service(winServiceConfig);
    *
    * svc.restart();
    */

package/lib/eventlog.js

@@ -1,5 +1,5 @@
-import { execPromise, execSync, isPermissionError } from './shared.js';
 import { elevate } from './binaries.js';
+import { execSync, execPromise, isPermissionError } from './shared.js';
 
 const eventLogs = ['APPLICATION', 'SYSTEM', 'SECURITY'],
     validTypes = ['ERROR', 'WARNING', 'INFORMATION', 'SUCCESSAUDIT', 'FAILUREAUDIT'];

package/lib/shared.js

@@ -1,14 +1,14 @@
 /**
  * 共享模块,导出在多个文件中使用的常用函数和模块
- * >查看定义:@see {@link exec}、{@link execSync}、{@link fork}、{@link promisify}、{@link path}、
- * {@link fs}、{@link EventEmitter}
+ * >查看定义:@see {@link exec}、{@link execSync}、{@link fork}、{@link EventEmitter}、{@link fs}、{@link path}、
+ * {@link promisify}}
  */
 import { exec, execSync, fork } from 'child_process';
-import { promisify } from 'util';
-import path from 'path';
-import fs from 'fs';
 import { EventEmitter } from 'events';
+import fs from 'fs';
+import path from 'path';
 import { fileURLToPath } from 'url';
+import { promisify } from 'util';
 
 /**
  * 将 child_process.exec 包装成 Promise
@@ -17,6 +17,14 @@ import { fileURLToPath } from 'url';
  */
 const execPromise = promisify(exec);
 
+/**
+ * 获取当前模块所在目录的路径(类似 CommonJS 的 __dirname)
+ * >查看定义:@see {@link getDirname}
+ * @param {string} metaUrl - 传入 `import.meta.url`
+ * @returns {string} 当前模块的目录路径
+ */
+const getDirname = metaUrl => path.dirname(fileURLToPath(metaUrl));
+
 /**
  * 检查错误是否为权限不足的错误
  * >查看定义:@see {@link isPermissionError}
@@ -32,12 +40,4 @@ const isPermissionError = error => {
     return permissionErrors.some(keyword => lowerMessage.includes(keyword.toLowerCase()));
 }
 
-/**
- * 获取当前模块所在目录的路径(类似 CommonJS 的 __dirname)
- * >查看定义:@see {@link getDirname}
- * @param {string} metaUrl - 传入 `import.meta.url`
- * @returns {string} 当前模块的目录路径
- */
-const getDirname = metaUrl => path.dirname(fileURLToPath(metaUrl));
-
-export { exec, execSync, fork, execPromise, promisify, path, fs, EventEmitter, isPermissionError, getDirname };
+export { EventEmitter, exec, execSync, fork, fs, path, promisify, execPromise, getDirname, isPermissionError };

package/lib/winsw.js

@@ -1,10 +1,10 @@
-import { fs, path, getDirname } from './shared.js';
 import xmlBuilder from 'xml';
+import { fs, path, getDirname } from './shared.js';
 
 
 const __dirname = getDirname(import.meta.url);
 /**
- * @method generateXml 生成 winsw 配置文件的 XML;
+ * 生成 winsw 配置文件的 XML
  * >查看定义:@see {@link generateXml}
  * @param {Object} config - 配置对象,必须包含以下必需属性:
  *   - *id* 服务的标识符,只能包含字母和数字,不能有空格
@@ -87,13 +87,13 @@ const generateXml = config => {
 };
 
 /**
- * @method createExe 创建 winsw 可执行文件及其配置文件
-  * >查看定义:@see {@link createExe}
+ * 创建 winsw 可执行文件及其配置文件
+ * >查看定义:@see {@link createExe}
  * @param {string} name - 可执行文件名称(不含扩展名);
  * @param {string} dir - 输出目录(默认:当前工作目录)
  * @param {() => void} [callback] - 完成后的回调函数
- * @description 将 winsw.exe 的安装版本复制为根据服务id重命名的特定版本,
- * 并复制 .exe.config 文件以支持 .NET 4+ 运行时环境;
+ * @returns {void} 无返回值
+ * @description 将 winsw.exe 的安装版本复制为根据服务id重命名的特定版本,并复制 .exe.config 文件以支持 .NET 4+ 运行时环境;
  */
 const createExe = (name, dir, callback) => {
   if (!name || !dir) throw "createExe 方法需要 name 和 dir 两个参数!";
@@ -110,4 +110,4 @@ const createExe = (name, dir, callback) => {
   callback?.();
 };
 
-export { generateXml, createExe };
+export { createExe, generateXml };

package/lib/wrapper.js

@@ -21,11 +21,11 @@
  *   -s, --stopparentfirst: 是否允许优雅退出
  *   --scriptoptions: 传递给脚本的选项
  */
-import { path, fs, fork } from './shared.js';
 import { createServer } from 'net';
-import yargs from 'yargs/yargs';
 import { hideBin } from 'yargs/helpers';
+import yargs from 'yargs/yargs';
 import { EventLogger } from './eventlog.js';
+import { fork, fs, path } from './shared.js';
 
 // 时间窗口(秒),默认时间窗口内最大重启次数,默认重启等待时间(秒),默认等待时间增长系数
 const timeWindow = 60, defaultMaxRestarts = 3, defaultWaitTime = 1, defaultGrowth = 0.25,

package/package.json

@@ -1,62 +1,66 @@
-{
-  "name": "@flun/windows",
-  "version": "4.0.0",
-  "description": "支持 Windows 服务、事件日志、UAC 以及多种与操作系统交互的辅助方法",
-  "keywords": [
-    "windows",
-    "service",
-    "daemon",
-    "logging",
-    "event",
-    "event logging",
-    "elevate",
-    "sudo",
-    "task"
-  ],
-  "author": "flun <open@flun.top>",
-  "publishConfig": {
-    "access": "public"
-  },
-  "type": "module",
-  "types": "index.d.ts",
-  "exports": {
-    ".": "./index.js"
-  },
-  "main": "index.js",
-  "bin": {
-    "windows": "bin/cli.js"
-  },
-  "files": [
-    "lib",
-    "bin",
-    "index.d.ts",
-    "index.js",
-    "win-service.config.js",
-    "copy-files.js",
-    "CHANGELOG.md",
-    "README.md",
-    "LICENSE"
-  ],
-  "preferGlobal": true,
-  "dependencies": {
-    "chalk": "^6.0.1",
-    "xml": "1.0.1",
-    "yargs": "^18.2.0"
-  },
-  "engines": {
-    "node": ">=22.12.0",
-    "npm": ">=10.0.0"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/OpenFlun/windows.git"
-  },
-  "homepage": "https://github.com/OpenFlun/windows#readme",
-  "bugs": {
-    "url": "https://github.com/OpenFlun/windows/issues"
-  },
-  "license": "ISC",
-  "scripts": {
-    "postinstall": "node copy-files.js 2>&1"
-  }
+{
+  "name": "@flun/windows",
+  "version": "5.0.0",
+  "description": "支持 Windows 服务、事件日志、UAC 以及多种与操作系统交互的辅助方法",
+  "keywords": [
+    "windows",
+    "service",
+    "daemon",
+    "logging",
+    "event",
+    "event logging",
+    "elevate",
+    "sudo",
+    "task"
+  ],
+  "author": "flun <open@flun.top>",
+  "publishConfig": {
+    "access": "public"
+  },
+  "type": "module",
+  "types": "index.d.ts",
+  "exports": {
+    ".": "./index.js"
+  },
+  "main": "index.js",
+  "bin": {
+    "windows": "bin/cli.js"
+  },
+  "files": [
+    "bin",
+    "lib",
+    "CHANGELOG.md",
+    "README.md",
+    "copy-files.js",
+    "index.d.ts",
+    "index.js",
+    "win-service.config.js",
+    "LICENSE"
+  ],
+  "preferGlobal": true,
+  "dependencies": {
+    "chalk": "^6.0.1",
+    "xml": "1.0.1",
+    "yargs": "^18.2.0"
+  },
+  "engines": {
+    "node": ">=22.12.0",
+    "npm": ">=10.0.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/OpenFlun/windows.git"
+  },
+  "gitee": {
+    "type": "git",
+    "url": "git+https://gitee.com/openflun/windows.git"
+  },
+  "homepage": "https://github.com/OpenFlun/windows#readme",
+  "bugs": {
+    "url": "https://github.com/OpenFlun/windows/issues"
+  },
+  "license": "ISC",
+  "scripts": {
+    "postinstall": "node copy-files.js 2>&1"
+  }
 }

package/win-service.config.js

@@ -1,16 +1,17 @@
 /**
  * Windows 服务配置模板
  * 带 * 的为必填项,其余可删除或按需保留;
- * 本配置既支持命令行方式(如 windows install),
- * 也支持在函数方式中导入:import config from './win-service.config.js';
+ * 本配置既支持命令行方式(如 windows s install),
+ * 也支持在函数方式中导入:import winServiceConfig from './win-service.config.js';
  * 具体用法见 README 的「命令行」与「函数方式」章节;
  *
  * 关于 quiet:默认 false,各方法执行后会在终端打印结果(如"服务安装完成;");
  * 若本包嵌入到自己的生产项目,终端输出会混入宿主日志,此时设为 true,
  * 库只发事件不打印,由宿主自行监听 install/start/stop/uninstall/error 等事件;
  * 命令行方式恒为 quiet,不受此字段影响;
+ * >查看定义:@see {@link winServiceConfig}
  */
-export default {
+const winServiceConfig = {
   // * 服务名称,用于服务管理与注册表标识;不能含 <>:"\/|?*
   name: 'MyApp',
   // * 启动服务的入口脚本绝对路径
@@ -65,4 +66,6 @@ export default {
 
   // 为 true 时不打印执行结果,只发事件;嵌入生产项目时建议开启
   quiet: false,
-};
+};
+
+export { winServiceConfig, winServiceConfig as default };