NTypewriter 项目使用教程

NTypewriter 项目使用教程

NTypewriter File/code generator using Scriban text templates populated with C# code metadata from Roslyn API. 项目地址: https://gitcode.com/gh_mirrors/nt/NTypewriter

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

NTypewriter 是一个基于 Scriban 模板引擎和 Roslyn API 的代码生成工具。以下是项目的目录结构及各部分的简要介绍：

NTypewriter/
├── .github/              # GitHub 工作流程和文档
├── NTypewriter.CodeModel/ # 包含代码模型相关的类库
├── NTypewriter.Editor/    # Visual Studio 编辑器扩展
├── NTypewriter.Online/    # 在线演示的 Blazor 客户端
├── NTypewriter.Runtime/   # 运行时库，用于创建能够渲染 *.nt 模板的解决方案
├── NTypewriter.SourceGenerator/ # Roslyn 源代码生成器，用于编译时渲染 *.nt 模板
├── Tests/                # 测试项目和资产
├── documentation/        # 文档
├── license.md            # 许可证信息
├── readme.md            # 项目说明文件
└── NTypewriter.sln       # 解决方案文件

• .github/: 包含了项目的 GitHub 工作流程和文档。
• NTypewriter.CodeModel/: 这个目录包含了代码模型相关的类库，用于分析和操作 C# 代码。
• NTypewriter.Editor/: Visual Studio 编辑器扩展，用于增强对 .nt 模板文件的支持。
• NTypewriter.Online/: 一个在线演示的 Blazor 客户端，展示了 NTypewriter 的功能。
• NTypewriter.Runtime/: 运行时库，允许用户创建可以在运行时渲染 .nt 模板的解决方案。
• NTypewriter.SourceGenerator/: 一个 Roslyn 源代码生成器，允许在编译时渲染 .nt 模板。
• Tests/: 包含了测试项目和测试所需的资产。
• documentation/: 项目的文档。
• license.md: 项目的 MIT 许可证信息。
• readme.md: 项目的说明文件。
• NTypewriter.sln: 解决方案文件，用于在 Visual Studio 中管理项目。

2. 项目的启动文件介绍

NTypewriter 项目的启动文件取决于你希望运行的项目部分。例如：

• 如果你想运行 Visual Studio 扩展，你需要在 Visual Studio 中打开 .sln 文件，并启动 NTypewriter.Editor 项目。
• 如果你想运行在线演示，你需要构建 NTypewriter.Online 项目，并在支持 Blazor 的服务器上运行它。

对于大多数用户来说，主要的启动点将是 NTypewriter.sln，它将加载所有必要的项目，并允许你从 Visual Studio 中构建和运行整个解决方案。

3. 项目的配置文件介绍

NTypewriter 的配置主要通过以下文件进行：

• appsettings.json: 这个文件通常用于存储应用程序的配置设置，例如数据库连接字符串、API 密钥等。在 NTypewriter 中，它可能用于配置编辑器扩展或在线演示的特定设置。
• .csproj 文件: 每个项目的 .csproj 文件包含了该项目的构建配置，包括引用的库、编译器和生成器选项等。

以下是一个 .csproj 文件的基本结构示例：

<Project Sdk="Microsoft.NET.Sdk">

  <PropertyGroup>
    <TargetFramework>net5.0</TargetFramework>
  </PropertyGroup>

  <ItemGroup>
    <PackageReference Include="Scriban" Version="6.4.0" />
  </ItemGroup>

</Project>

在这个文件中，<TargetFramework> 指定了项目的目标框架（例如 net5.0），而 <ItemGroup> 下的 <PackageReference> 指定了项目依赖的 NuGet 包。

确保在使用 NTypewriter 之前，你已经正确配置了所有必要的环境和依赖项。

NTypewriter File/code generator using Scriban text templates populated with C# code metadata from Roslyn API. 项目地址: https://gitcode.com/gh_mirrors/nt/NTypewriter