learn-generators 项目教程
1. 项目的目录结构及介绍
learn-generators/
├── exercises/
│ ├── exercise1/
│ ├── exercise2/
│ └── ...
├── i18n/
│ ├── en/
│ ├── fr/
│ └── ...
├── .gitignore
├── LICENSE
├── README.md
├── credits.js
├── credits.txt
├── exercise.js
├── learn-generators.jpg
├── learn-generators.js
├── package.json
├── start.js
└── wrap.js
- exercises/: 包含各个练习的目录,每个练习一个子目录。
- i18n/: 包含多语言支持的文件,如英文和法文。
- .gitignore: Git 忽略文件配置。
- LICENSE: 项目许可证文件。
- README.md: 项目说明文档。
- credits.js: 项目贡献者信息。
- credits.txt: 项目贡献者信息。
- exercise.js: 练习相关脚本。
- learn-generators.jpg: 项目图片。
- learn-generators.js: 项目主脚本。
- package.json: 项目依赖和配置文件。
- start.js: 项目启动脚本。
- wrap.js: 项目包装脚本。
2. 项目的启动文件介绍
start.js:
// start.js 文件内容示例
const workshopper = require('workshopper-adventure');
const path = require('path');
const learnGenerators = workshopper({
appDir: __dirname,
languages: ['en', 'fr'],
header: require('workshopper-adventure/default/header'),
footer: require('workshopper-adventure/default/footer')
});
learnGenerators.addAll([
{
name: 'Introduction',
fn: function() {
const file = path.join(__dirname, 'exercises', 'introduction');
return { file: file, solution: file, tpl: file };
}
}
// 其他练习
]);
module.exports = learnGenerators;
start.js
文件是项目的启动脚本,负责初始化和配置 workshopper 框架,并加载各个练习。
3. 项目的配置文件介绍
package.json:
{
"name": "learn-generators",
"version": "1.0.0",
"description": "JavaScript ES(6|2015) generators workshopper",
"main": "learn-generators.js",
"scripts": {
"start": "node start.js"
},
"dependencies": {
"workshopper-adventure": "^6.0.0"
},
"author": "Ruslan Ismagilov",
"license": "BSD-3-Clause"
}
- name: 项目名称。
- version: 项目版本。
- description: 项目描述。
- main: 项目主入口文件。
- scripts: 项目脚本命令,如启动命令。
- dependencies: 项目依赖包。
- author: 项目作者。
- license: 项目许可证。
以上是 learn-generators
项目的目录结构、启动文件和配置文件的介绍。希望这份文档能帮助你更好地理解和使用该项目。