JavaScript 练习项目使用文档

JavaScript 练习项目使用文档

javascript-exercises项目地址:https://gitcode.com/gh_mirrors/ja/javascript-exercises

本文档旨在帮助用户了解和使用 TheOdinProject/javascript-exercises 项目。我们将详细介绍项目的目录结构、启动文件和配置文件。

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

项目的目录结构如下：

javascript-exercises/
├── .github/
├── .gitignore
├── .prettierrc
├── babel.config.js
├── jest.config.js
├── package.json
├── README.md
├── src/
│   ├── 01_helloWorld/
│   │   ├── index.js
│   │   └── index.test.js
│   ├── 02_repeatString/
│   │   ├── index.js
│   │   └── index.test.js
│   ├── ...
│   └── 148_someExercise/
│       ├── index.js
│       └── index.test.js
└── yarn.lock

目录结构说明

• .github/: GitHub 相关配置文件。
• .gitignore: Git 忽略文件配置。
• .prettierrc: Prettier 代码格式化配置文件。
• babel.config.js: Babel 配置文件。
• jest.config.js: Jest 测试框架配置文件。
• package.json: 项目依赖和脚本配置文件。
• README.md: 项目说明文档。
• src/: 源代码目录，包含多个练习目录，每个练习目录包含一个 index.js 文件和一个 index.test.js 文件。
• yarn.lock: Yarn 包管理器生成的锁定文件。

2. 项目的启动文件介绍

项目的启动文件位于每个练习目录下的 index.js 文件。例如，src/01_helloWorld/index.js 是第一个练习的启动文件。

启动文件示例

// src/01_helloWorld/index.js

function helloWorld() {
  return 'Hello, World!';
}

module.exports = helloWorld;

每个 index.js 文件包含一个函数，该函数是练习的核心实现。用户需要完成这些函数的实现，并通过测试。

3. 项目的配置文件介绍

package.json

package.json 文件包含了项目的依赖、脚本和其他配置信息。

{
  "name": "javascript-exercises",
  "version": "1.0.0",
  "description": "A collection of JavaScript exercises",
  "main": "index.js",
  "scripts": {
    "test": "jest"
  },
  "dependencies": {
    "jest": "^27.0.0"
  },
  "devDependencies": {
    "babel-jest": "^27.0.0",
    "prettier": "^2.0.0"
  }
}

jest.config.js

jest.config.js 文件是 Jest 测试框架的配置文件。

module.exports = {
  testEnvironment: 'node',
  testMatch: ['**/__tests__/**/*.js?(x)', '**/?(*.)+(spec|test).js?(x)'],
  transform: {
    '^.+\\.js$': 'babel-jest'
  }
};

babel.config.js

babel.config.js 文件是 Babel 编译器的配置文件。

module.exports = {
  presets: ['@babel/preset-env']
};

通过以上文档，用户可以更好地理解和使用 TheOdinProject/javascript-exercises 项目。希望本文档对您有所帮助！

javascript-exercises项目地址:https://gitcode.com/gh_mirrors/ja/javascript-exercises