ng-morph 项目教程

ng-morph 项目教程

ng-morph Code mutations in your project or schematics were never easier than now. 项目地址: https://gitcode.com/gh_mirrors/ng/ng-morph

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

ng-morph 项目的目录结构如下：

ng-morph/
├── apps/
│   └── demo/
├── libs/
│   └── ng-morph/
├── .editorconfig
├── .gitignore
├── .release-it.js
├── CHANGELOG.md
├── LICENSE
├── README.md
├── jest.preset.js
├── nx.json
├── package-lock.json
├── package.json
└── tsconfig.json

目录结构介绍

• apps/: 包含项目的演示应用。
  • demo/: 演示应用的代码。
• libs/: 包含项目的核心库。
  • ng-morph/: ng-morph 库的代码。
• .editorconfig: 编辑器配置文件，用于统一代码风格。
• .gitignore: Git 忽略文件配置，指定哪些文件或目录不需要被 Git 管理。
• .release-it.js: 发布工具的配置文件。
• CHANGELOG.md: 项目变更日志，记录每次发布的变更内容。
• LICENSE: 项目许可证文件，ng-morph 使用 Apache-2.0 许可证。
• README.md: 项目说明文件，包含项目的简介、安装方法、使用说明等。
• jest.preset.js: Jest 测试框架的预设配置文件。
• nx.json: Nx 工作区的配置文件，用于管理多个应用和库。
• package-lock.json: npm 包锁定文件，确保依赖版本一致性。
• package.json: 项目的 npm 配置文件，包含项目的依赖、脚本等信息。
• tsconfig.json: TypeScript 配置文件，用于配置 TypeScript 编译选项。

2. 项目的启动文件介绍

ng-morph 项目的启动文件主要是 package.json 中的脚本配置。以下是一些常用的启动脚本：

{
  "scripts": {
    "start": "nx serve demo",
    "build": "nx build ng-morph",
    "test": "nx test ng-morph",
    "lint": "nx lint ng-morph",
    "release": "release-it"
  }
}

启动文件介绍

• start: 启动演示应用，使用 nx serve demo 命令。
• build: 构建 ng-morph 库，使用 nx build ng-morph 命令。
• test: 运行测试，使用 nx test ng-morph 命令。
• lint: 运行代码检查，使用 nx lint ng-morph 命令。
• release: 发布新版本，使用 release-it 命令。

3. 项目的配置文件介绍

ng-morph 项目中有多个配置文件，以下是一些关键配置文件的介绍：

3.1 .editorconfig

root = true

[*]
indent_style = space
indent_size = 2
end_of_line = lf
charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = true

• indent_style: 缩进风格，使用空格。
• indent_size: 缩进大小，使用 2 个空格。
• end_of_line: 换行符，使用 LF。
• charset: 字符集，使用 UTF-8。
• trim_trailing_whitespace: 去除行尾空格。
• insert_final_newline: 文件末尾插入空行。

3.2 .gitignore

node_modules/
dist/
coverage/

• node_modules/: 忽略 node_modules 目录，避免将依赖包提交到版本控制。
• dist/: 忽略构建输出目录，避免将构建结果提交到版本控制。
• coverage/: 忽略测试覆盖率报告目录。

3.3 tsconfig.json

{
  "compilerOptions": {
    "target": "es2015",
    "module": "commonjs",
    "strict": true,
    "esModuleInterop": true,
    "skipLibCheck": true,
    "forceConsistentCasingInFileNames": true
  },
  "include": ["**/*.ts"]
}

• target: 编译目标，使用 ES2015。
• module: 模块系统，使用 CommonJS。
• strict: 启用严格模式。
• esModuleInterop: 启用 ES 模块互操作。
• skipLibCheck: 跳过库文件的类型检查。
• forceConsistentCasingInFileNames: 强制文件名大小写一致。
• include: 包含所有 TypeScript 文件。

3.4 nx.json

{
  "npmScope": "ng-morph",
  "affected": {
    "defaultBase": "main"
  },
  "tasksRunnerOptions": {
    "default": {
      "runner": "@nrwl/workspace/tasks-runners/default",
      "options": {
        "cacheableOperations": ["build", "test", "lint"]
      }
    }
  }
}

• npmScope: npm 作用域，使用 ng-morph。
• affected: 默认分支，使用 main。
• tasksRunnerOptions: 任务运行器选项，使用默认任务运行器，缓存 build、test、lint 操作。

通过以上介绍，您可以更好地理解 ng-morph 项目的目录结构、启动文件和配置文件。

ng-morph Code mutations in your project or schematics were never easier than now. 项目地址: https://gitcode.com/gh_mirrors/ng/ng-morph