MIDI JSON Parser 项目教程
1. 项目的目录结构及介绍
midi-json-parser/
├── dist/
│ ├── index.d.ts
│ ├── index.js
│ ├── index.js.map
│ ├── index.mjs
│ ├── index.mjs.map
│ ├── worker.d.ts
│ ├── worker.js
│ ├── worker.js.map
│ ├── worker.mjs
│ └── worker.mjs.map
├── src/
│ ├── index.ts
│ └── worker.ts
├── test/
│ ├── index.spec.ts
│ └── worker.spec.ts
├── .editorconfig
├── .gitignore
├── .npmrc
├── .prettierrc
├── LICENSE
├── package.json
├── README.md
└── tsconfig.json
dist/
: 编译后的文件,包含 CommonJS 和 ES6 模块的版本。src/
: 源代码目录,包含主要的 TypeScript 文件。test/
: 测试文件目录,包含单元测试。.editorconfig
,.gitignore
,.npmrc
,.prettierrc
: 项目配置文件。LICENSE
: 项目许可证。package.json
: 项目依赖和脚本配置。README.md
: 项目说明文档。tsconfig.json
: TypeScript 配置文件。
2. 项目的启动文件介绍
项目的启动文件位于 src/index.ts
,这是项目的主入口文件。它导出了 MIDI 解析的主要功能,可以将 MIDI 数据解析为 JSON 格式。
// src/index.ts
export * from './worker';
3. 项目的配置文件介绍
package.json
: 包含了项目的依赖、脚本和其他元数据。
{
"name": "midi-json-parser",
"version": "1.0.0",
"description": "A parser for converting MIDI data to JSON.",
"main": "dist/index.js",
"module": "dist/index.mjs",
"types": "dist/index.d.ts",
"scripts": {
"build": "rollup -c",
"test": "jest"
},
"dependencies": {
"midi-file-parser": "^1.0.0"
},
"devDependencies": {
"@types/jest": "^26.0.0",
"jest": "^26.0.0",
"rollup": "^2.0.0",
"typescript": "^4.0.0"
}
}
tsconfig.json
: TypeScript 编译配置文件。
{
"compilerOptions": {
"target": "esnext",
"module": "esnext",
"moduleResolution": "node",
"declaration": true,
"outDir": "./dist",
"strict": true
},
"include": ["src"]
}
这些配置文件确保了项目的正确编译和运行。