Wav2Bar 项目使用教程

1. 项目的目录结构及介绍

Wav2Bar 的目录结构如下：

• assets/: 存放项目所需的静态资源文件，如图标、图片等。
• dev_utils/: 开发工具相关文件。
• docs/: 项目文档。
• html/: HTML 文件。
• js/: JavaScript 文件，包括项目的主要逻辑。
• test/: 测试文件。
• user/: 用户配置文件。
• .eslintignore: ESLint 忽略配置文件。
• .eslintrc.js: ESLint 配置文件。
• .gitattributes: Git 属性配置文件。
• .gitignore: Git 忽略配置文件。
• AUTHORS.md: 项目贡献者名单。
• CHANGELOG.md: 项目更新日志。
• CODE_OF_CONDUCT.md: 项目行为准则。
• CONTRIBUTING.md: 贡献指南。
• LICENSE: 项目许可证信息。
• README.md: 项目说明文件。
• forge.config.js: Electron Forge 配置文件。
• index.html: 项目入口 HTML 文件。
• jsconfig.json: JavaScript 配置文件。
• main.js: 项目主 JavaScript 文件。
• package-lock.json: npm 包锁定文件。
• package.json: npm 包配置文件。
• style.css: 样式文件。

2. 项目的启动文件介绍

项目的启动主要通过 main.js 文件进行。以下是 main.js 文件的基本内容：

// 引入必要的模块和组件
const { app, BrowserWindow } = require('electron');
const path = require('path');

// 创建浏览器窗口
function createWindow () {
  // 创建一个浏览器窗口
  let win = new BrowserWindow({
    width: 800,
    height: 600,
    webPreferences: {
      nodeIntegration: true,
      contextIsolation: false,
    }
  });

  // 并加载应用的 index.html
  win.loadFile('index.html');
}

app.whenReady().then(createWindow);

// 当窗口关闭时退出应用
app.on('window-all-closed', () => {
  if (process.platform !== 'darwin') {
    app.quit();
  }
});

app.on('activate', () => {
  // 在 macOS 上，当点击 dock 图标并且没有其他窗口打开时，通常会在应用程序中重新创建一个窗口。
  if (BrowserWindow.getAllWindows().length === 0) {
    createWindow();
  }
});

这段代码负责创建和加载一个浏览器窗口，是应用启动的核心。

3. 项目的配置文件介绍

项目的配置主要通过 package.json 和 forge.config.js 文件进行。

• package.json: npm 包配置文件，其中定义了项目的名称、版本、描述、入口文件、依赖项等信息。以下是一个简化的 package.json 文件内容：

{
  "name": "wav2bar",
  "version": "0.1.0",
  "main": "main.js",
  "scripts": {
    "start": "electron ."
  },
  "dependencies": {
    "electron": "^13.1.7"
  }
}

• forge.config.js: Electron Forge 配置文件，用于配置项目的构建和打包过程。以下是一个简化的 forge.config.js 文件内容：

module.exports = {
  // 配置项
  makers: [
    {
      name: '@electron-forge/maker-squirrel',
      config: {
        // Windows 打包配置
      }
    },
    {
      name: '@electron-forge/maker-zip',
      platforms: ['win32', 'darwin']
    }
    // 更多打包配置...
  ]
};

这些配置文件是项目能够顺利运行和打包的关键。