Tidy.js 项目教程

1. 项目目录结构及介绍

Tidy.js 项目的目录结构如下：

tidy/
├── .circleci/
│   └── config.yml
├── packages/
│   ├── tidy/
│   └── website/
├── .eslintrc.js
├── .gitignore
├── .prettierignore
├── .prettierrc
├── CHANGELOG.md
├── LICENSE
├── README.md
├── lerna.json
├── package.json
└── yarn.lock

目录结构介绍

• .circleci/: 包含 CircleCI 的配置文件 config.yml，用于持续集成和部署。
• packages/: 包含项目的子包，其中 tidy/ 是核心包，website/ 是项目文档网站。
• .eslintrc.js: ESLint 配置文件，用于代码风格检查。
• .gitignore: Git 忽略文件配置，指定哪些文件和目录不需要被 Git 跟踪。
• .prettierignore: Prettier 忽略文件配置，指定哪些文件不需要被 Prettier 格式化。
• .prettierrc: Prettier 配置文件，用于代码格式化。
• CHANGELOG.md: 项目变更日志，记录每个版本的更新内容。
• LICENSE: 项目许可证文件，这里是 MIT 许可证。
• README.md: 项目的主文档文件，包含项目的基本介绍、安装和使用说明。
• lerna.json: Lerna 配置文件，用于管理多包项目。
• package.json: 项目的 npm 配置文件，包含项目的依赖、脚本等信息。
• yarn.lock: Yarn 锁定文件，确保依赖版本的一致性。

2. 项目启动文件介绍

Tidy.js 项目的启动文件主要是 packages/tidy/src/index.js，这是项目的入口文件。它导出了 Tidy.js 的核心功能，包括数据处理的各种函数。

// packages/tidy/src/index.js
export { tidy, mutate, arrange, desc } from './tidy';

启动文件介绍

• tidy: 主函数，用于对数据进行一系列的转换操作。
• mutate: 用于添加或修改数据中的字段。
• arrange: 用于对数据进行排序。
• desc: 用于指定降序排序。

3. 项目的配置文件介绍

3.1 .eslintrc.js

ESLint 配置文件，用于定义代码风格和检查规则。

module.exports = {
  extends: 'eslint:recommended',
  rules: {
    // 自定义规则
  }
};

3.2 .prettierrc

Prettier 配置文件，用于定义代码格式化规则。

{
  "singleQuote": true,
  "trailingComma": "all"
}

3.3 lerna.json

Lerna 配置文件，用于管理多包项目。

{
  "packages": [
    "packages/*"
  ],
  "version": "independent"
}

3.4 package.json

项目的 npm 配置文件，包含项目的依赖、脚本等信息。

{
  "name": "@tidyjs/tidy",
  "version": "1.0.0",
  "scripts": {
    "build": "lerna run build",
    "test": "lerna run test"
  },
  "dependencies": {
    // 依赖包
  }
}

通过以上配置文件，可以确保项目的代码风格一致，并且能够方便地进行构建和测试。