开源项目Nx的安装与使用指南

开源项目Nx的安装与使用指南

nxSmart Monorepos · Fast CI项目地址:https://gitcode.com/gh_mirrors/nx/nx

目录结构及介绍

概览

当你通过npx create-nx-workspace或npx nx init初始化一个工作区并克隆了Nx仓库后，你会看到以下基本的目录结构：

.
├── .github/
│   └── workflows/
│       └── ci.yml
├── README.md
├── CODE_OF_CONDUCT.md
├── LICENSE
├── jest.config.js
├── jest.preset.js
├── nx.json
├── package.json
├── pnpm-lock.yaml
├── project.json
├── rust-toolchain
├── tsconfig.base.json
└── ...

主要目录说明

• .github/: 包含Github Action的定义，用于自动化测试、构建等CI/CD流程。
• jest.config.js 和 jest.preset.js: Jest测试框架的配置文件，用于控制测试行为。
• nx.json: Nx的核心配置文件，包含了任务调度、缓存策略以及项目依赖关系等重要设置。
• package.json: Node.js项目的元数据文件，包括项目描述、作者、版本、依赖库列表等信息。
• pnpm-lock.yaml: Pnpm包管理器的锁定文件，保证每次构建的一致性。
• project.json: 定义各个项目及其特定属性。
• rust-toolchain: 指定Rust编译器的工具链版本。
• tsconfig.base.json: TypeScript的基本配置文件，可以被其他项目级的tsconfig文件继承。

启动文件介绍

在Nx中，没有单一的概念上的“启动”文件，因为Nx设计用于支持多种应用程序类型，如React应用、Angular应用、Node.js服务等。每种应用程序类型都有其独特的入口点（比如main.ts/main.js）来运行应用。然而，在多项目环境中，你可以使用nx serve <app-name>命令来运行特定的应用程序，其中<app-name>是你的应用程序名称。

对于开发服务器的配置，例如在React项目中的start脚本，通常会在package.json中找到。例如：

"scripts": {
  "start": "react-scripts start",
}

在Angular项目中，则可能类似这样：

"scripts": {
  "serve": "ng serve"
}

这些脚本通常会被NX增强，以便支持更复杂的构建和开发环境需求。

配置文件介绍

nx.json

作用: 这个文件配置了整个工作空间的行为，如默认的执行器、全局共享资源和远程缓存的设置。

示例配置:

{
  "$schema": "./node_modules/@nrwl/workspace/schema.json",
  "projects": {},
  "executors": {},
  "generators": {},
  "defaultProject": null,
  "workspaceLayout": {
    "appsDir": "apps",
    "libsDir": "libs"
  },
  "affected": {
    "baseBranch": "master",
    "application": ["apps/*"],
    "library": ["libs/*"],
    "service": [],
    "packages": []
  }
}

jest.config.js 和 jest.preset.js

这两个文件主要用来配置Jest测试环境，使你可以通过nx test <project>命令自动进行端到端的测试分割、任务的检测和缓存分布。

// jest.config.js 示例
module.exports = {
  clearMocks: true,
  collectCoverage: true,
  coverageDirectory: 'coverage',
  coveragePathIgnorePatterns: ['/node_modules/', '/dist/'],
  // 更多配置...
};

// jest.preset.js 示例
module.exports = {
  globals: {
    'ts-jest': {
      tsConfig: '<rootDir>/tsconfig.spec.json'
    }
  }
};

tsconfig.base.json

这个文件提供了TypeScript的基础配置模板，大多数的项目都会从这里继承它们的tsconfig设置。

{
  "compilerOptions": {
    "target": "es6",
    "lib": [ "dom", "esnext" ],
    "sourceMap": true,
    "outDir": "./dist/out-tsc",
    // 更多编译选项...
  },
  "exclude": [
    "node_modules",
    "dist"
  ]
}

总结而言，Nx的设计理念强调的是高度可扩展性和灵活性，使得无论是大型企业还是个人开发者都可以利用Nx来优化他们的开发工作流，实现高效的代码管理和部署。希望这份指南能够帮助你在使用Nx的过程中更加得心应手!

nxSmart Monorepos · Fast CI项目地址:https://gitcode.com/gh_mirrors/nx/nx