开源项目 `lyric-parser` 使用教程

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

lyric-parser 项目的目录结构如下：

lyric-parser/
├── build/
├── demo/
├── src/
├── .babelrc
├── .editorconfig
├── .eslintignore
├── .eslintrc.js
├── .gitignore
├── LICENSE
├── README.md
├── package.json

目录介绍

• build/: 存放构建生成的文件。
• demo/: 包含项目的演示代码。
• src/: 项目的源代码文件夹。
• .babelrc: Babel 配置文件。
• .editorconfig: 编辑器配置文件，用于统一代码风格。
• .eslintignore: ESLint 忽略文件配置。
• .eslintrc.js: ESLint 配置文件。
• .gitignore: Git 忽略文件配置。
• LICENSE: 项目许可证文件。
• README.md: 项目说明文档。
• package.json: 项目的依赖和脚本配置文件。

2. 项目的启动文件介绍

项目的启动文件主要是 src/ 目录下的文件。具体来说，主要的启动文件是 src/index.js，它包含了 Lyric 类的定义和相关方法。

// src/index.js
import Lyric from 'lyric-parser';
let lyric = new Lyric(lyricStr, handler);
function handler([lineNum, txt]) {
  // 当 lineNum 变化时调用此处理函数
}

3. 项目的配置文件介绍

.babelrc

Babel 配置文件，用于配置 JavaScript 的转译规则。

{
  "presets": ["@babel/preset-env"]
}

.editorconfig

编辑器配置文件，用于统一代码风格。

root = true

[*]
indent_style = space
indent_size = 2
end_of_line = lf
charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = true

.eslintrc.js

ESLint 配置文件，用于代码检查。

module.exports = {
  "extends": "eslint:recommended",
  "parserOptions": {
    "ecmaVersion": 2018,
    "sourceType": "module"
  },
  "env": {
    "browser": true,
    "node": true
  }
};

package.json

项目的依赖和脚本配置文件。

{
  "name": "lyric-parser",
  "version": "1.0.0",
  "description": "A lyric parser base on javascript",
  "main": "src/index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "author": "ustbhuangyi",
  "license": "MIT",
  "dependencies": {
    "babel-core": "^6.26.3",
    "babel-preset-env": "^1.7.0"
  }
}

以上是 lyric-parser 项目的基本使用教程，涵盖了项目的目录结构、启动文件和配置文件的介绍。希望这些信息能帮助你更好地理解和使用该项目。