Malloy 项目教程

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

Malloy 项目的目录结构如下：

malloy/
├── github/
│   └── workflows/
├── vscode/
├── cloudbuild/
├── demo/
├── packages/
├── samples/
├── scripts/
├── test/
├── vscode-extension/
├── .editorconfig
├── .eslintignore
├── .eslintrc.json
├── .git-blame-ignore-revs
├── .gitignore
├── .node-version
├── .npmrc
├── .prettierrc.js
├── CHANGELOG.md
├── CONTRIBUTING.md
├── LICENSE
├── README.md
├── code_of_conduct.md
├── default.nix
├── developing.md
├── jest.config.ts
├── lerna.json
├── package-lock.json
├── package.json
├── tsconfig.compile-no-emit.json
├── tsconfig.docs.json
├── tsconfig.json
├── tsconfig.packages.json

目录结构介绍

• github/workflows/: 包含 GitHub Actions 的工作流配置文件。
• vscode/: 包含与 Visual Studio Code 相关的文件和配置。
• cloudbuild/: 包含与云构建相关的文件和配置。
• demo/: 包含项目的演示和示例代码。
• packages/: 包含项目的各个包和模块。
• samples/: 包含项目的示例数据和代码。
• scripts/: 包含项目的脚本文件，用于自动化任务。
• test/: 包含项目的测试文件和配置。
• vscode-extension/: 包含 Visual Studio Code 扩展的源代码和配置。
• .editorconfig: 编辑器配置文件，用于统一代码风格。
• .eslintignore: ESLint 忽略文件列表。
• .eslintrc.json: ESLint 配置文件。
• .git-blame-ignore-revs: Git 忽略的提交列表。
• .gitignore: Git 忽略文件列表。
• .node-version: Node.js 版本配置文件。
• .npmrc: npm 配置文件。
• .prettierrc.js: Prettier 配置文件。
• CHANGELOG.md: 项目变更日志。
• CONTRIBUTING.md: 贡献指南。
• LICENSE: 项目许可证。
• README.md: 项目介绍和使用说明。
• code_of_conduct.md: 行为准则。
• default.nix: Nix 配置文件。
• developing.md: 开发指南。
• jest.config.ts: Jest 测试框架配置文件。
• lerna.json: Lerna 多包管理工具配置文件。
• package-lock.json: npm 包锁定文件。
• package.json: npm 包配置文件。
• tsconfig.compile-no-emit.json: TypeScript 编译配置文件，不生成输出文件。
• tsconfig.docs.json: TypeScript 文档生成配置文件。
• tsconfig.json: TypeScript 主配置文件。
• tsconfig.packages.json: TypeScript 包配置文件。

2. 项目的启动文件介绍

Malloy 项目的启动文件主要集中在 scripts/ 目录下，用于执行各种自动化任务。以下是一些关键的启动文件：

• scripts/start.js: 项目的启动脚本，通常用于启动开发服务器或执行初始化任务。
• scripts/build.js: 项目的构建脚本，用于编译和打包项目代码。
• scripts/test.js: 项目的测试脚本，用于运行测试用例。

3. 项目的配置文件介绍

Malloy 项目的配置文件主要用于定义项目的各种设置和行为。以下是一些关键的配置文件：

• .eslintrc.json: ESLint 配置文件，用于定义代码风格和规则。
• .prettierrc.js: Prettier 配置文件，用于格式化代码。
• jest.config.ts: Jest 测试框架配置文件，用于定义测试环境和规则。
• lerna.json: Lerna 多包管理工具配置文件，用于管理多个 npm 包。
• package.json: npm 包配置文件，包含项目的依赖、脚本和其他元数据。
• tsconfig.json: TypeScript 主配置文件，定义 TypeScript 编译选项。

这些配置文件共同作用，确保项目在开发、测试和构建过程中的一致性和可维护性。