solc-typed-ast 项目使用指南

1. 项目目录结构及介绍

solc-typed-ast 项目的目录结构如下：

├── .compiler_cache             # 缓存已下载的编译器
├── coverage                    # 测试覆盖率报告
├── dist                        # 生成的 JavaScript 源码，用于包分发
├── docs                        # 项目文档和 API 参考手册
├── src                         # 原始 TypeScript 源码
│   ├── ast                     # AST 相关定义和逻辑
│   │   ├── implementation      # 实现的通用 AST 节点
│   │   ├── legacy              # Solc 旧版（legacy）AST 处理器
│   │   ├── modern              # Solc 现代版（compact）AST 处理器
│   │   ├── postprocessing      # AST 后处理器
│   │   └── writing             # AST 写入相关

• .compiler_cache: 存储下载的编译器文件。
• coverage: 包含测试覆盖率报告。
• dist: 包含打包后用于分发的 JavaScript 文件。
• docs: 包含项目文档和 API 参考手册。
• src: 包含项目的 TypeScript 源代码。

2. 项目的启动文件介绍

项目的启动文件主要是 src 目录下的 TypeScript 文件。这些文件定义了 solc-typed-ast 的核心功能，包括编译器调用、AST 的读取和写入等。

以下是一个简单的示例，演示如何使用 solc-typed-ast 来编译 Solidity 源代码并获取编译结果：

import { CompileFailedError, CompileResult, compileSol } from "solc-typed-ast";

async function compileSoliditySource(sourcePath: string) {
  let result: CompileResult;
  try {
    result = await compileSol(sourcePath, "auto", []);
  } catch (e) {
    if (e instanceof CompileFailedError) {
      console.error("编译错误:", e.failures);
    } else {
      console.error(e.message);
    }
    return;
  }
  console.log(result);
}

在此示例中，compileSol 函数用于编译 Solidity 源代码文件，"auto" 参数用于自动选择编译器版本。

3. 项目的配置文件介绍

项目的配置文件包括：

• .eslintrc.json: ESLint 配置文件，用于定义 TypeScript 代码的语法规则和风格指南。
• .gitignore: Git 忽略文件，用于指定在 Git 仓库中应该被忽略的文件和目录。
• package.json: npm 包配置文件，定义了项目的依赖、脚本和元数据。
• tsconfig.json: TypeScript 配置文件，用于指定 TypeScript 编译器的选项。

例如，tsconfig.json 文件可能包含以下内容：

{
  "compilerOptions": {
    "target": "es5",
    "module": "commonjs",
    "strict": true,
    "esModuleInterop": true,
    "skipLibCheck": true,
    "forceConsistentCasingInFileNames": true
  },
  "include": ["src/**/*"],
  "exclude": ["node_modules", "**/*.spec.ts"]
}

在这个配置文件中，compilerOptions 指定了 TypeScript 编译器的各种选项，例如编译为 ES5 代码、使用 commonjs 模块系统等。include 和 exclude 字段定义了哪些文件应该被编译和哪些文件应该被排除在外。