Solita 项目教程

Solita 项目教程

solita Genrates an SDK API from solana contract IDL. 项目地址: https://gitcode.com/gh_mirrors/so/solita

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

Solita 项目的目录结构如下：

solita/
├── .github/
│   └── workflows/
├── assets/
├── src/
│   └── generated/
├── test/
├── .gitignore
├── .prettierrc
├── LICENSE
├── README.md
├── package.json
├── tsconfig.json
└── typedoc.json

目录结构介绍

• .github/workflows/: 包含 GitHub Actions 的工作流配置文件。
• assets/: 存放项目相关的静态资源文件。
• src/: 项目的源代码目录，其中 generated/ 子目录用于存放生成的 TypeScript SDK。
• test/: 存放项目的测试代码。
• .gitignore: Git 忽略文件配置。
• .prettierrc: Prettier 代码格式化配置文件。
• LICENSE: 项目的开源许可证文件。
• README.md: 项目的介绍和使用说明文档。
• package.json: 项目的 npm 配置文件，包含依赖项和脚本命令。
• tsconfig.json: TypeScript 编译配置文件。
• typedoc.json: TypeDoc 文档生成配置文件。

2. 项目的启动文件介绍

Solita 项目的主要启动文件是 package.json 中的脚本命令。以下是一些常用的启动命令：

{
  "scripts": {
    "solita": "solita",
    "build": "tsc",
    "test": "jest"
  }
}

启动命令介绍

• solita: 运行 Solita 生成 TypeScript SDK。
• build: 使用 TypeScript 编译器 (tsc) 编译项目。
• test: 使用 Jest 运行项目的测试。

3. 项目的配置文件介绍

3.1 .prettierrc

.prettierrc 文件用于配置 Prettier 代码格式化工具的规则。例如：

{
  "singleQuote": true,
  "trailingComma": "all"
}

3.2 tsconfig.json

tsconfig.json 文件用于配置 TypeScript 编译器的选项。例如：

{
  "compilerOptions": {
    "target": "es5",
    "module": "commonjs",
    "strict": true,
    "esModuleInterop": true
  }
}

3.3 typedoc.json

typedoc.json 文件用于配置 TypeDoc 文档生成工具的选项。例如：

{
  "inputFiles": ["./src"],
  "mode": "file",
  "out": "docs"
}

3.4 solitarc.js

solitarc.js 文件用于配置 Solita 生成 SDK 的选项。例如：

const path = require('path');

module.exports = {
  idlGenerator: 'shank',
  programName: 'mpl_token_vault',
  idlDir: path.join(__dirname, 'idl'),
  sdkDir: path.join(__dirname, 'src', 'generated'),
  binaryInstallDir: path.join(__dirname, 'crates'),
  programDir: path.join(__dirname, 'program')
};

以上是 Solita 项目的基本配置和使用介绍。通过这些配置文件和启动命令，您可以轻松地生成 TypeScript SDK 并进行项目开发和测试。

solita Genrates an SDK API from solana contract IDL. 项目地址: https://gitcode.com/gh_mirrors/so/solita