Injectable-ts 项目使用教程

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

Injective-ts 是一个 TypeScript 的 monorepo，它包含了多个用于与 Injective Chain 交互的包。以下是项目的目录结构及其简要介绍：

injective-ts/
├── .gitbook/             # GitBook 配置和资源
├── .github/              # GitHub 工作流和配置
├── .husky/               # Husky 配置文件，用于 Git 钩子
├── .vscode/              # VSCode 配置文件
├── docs/                 # 文档资源
├── etc/                  # 额外的配置文件或脚本
├── packages/             # 包含所有的 TypeScript 包
├── proto/                # Protocol 相关的文件
├── .editorconfig          # EditorConfig 配置
├── .eslintignore         # ESLint 忽略配置
├── .eslintrc.js          # ESLint 配置
├── .gitbook.yaml         # GitBook 配置
├── .gitignore            # Git 忽略配置
├── .markdownlint.json    # Markdown Lint 配置
├── .prettierrc.js        # Prettier 配置
├── CHANGELOG.md          # 更改日志
├── CONTRIBUTING.md       # 贡献指南
├── LICENSE               # 许可证信息
├── NOTICE.md             # 通知信息
├── README.md             # 项目说明文件
├── babel.config.js       # Babel 配置
├── commitlint.config.js  # Commit Lint 配置
├── jest.config.js        # Jest 配置
├── lerna.json            # Lerna 配置
├── package.json          # 项目包配置
├── tsconfig.build.json   # TypeScript 构建配置
├── tsconfig.json         # TypeScript 配置
├── typedoc.json          # TypeDoc 配置
└── yarn.lock             # Yarn 锁文件

2. 项目的启动文件介绍

在 packages 目录中，你可以找到具体的 TypeScript 包。每个包通常都有自己的入口文件，例如 index.ts，这是你开始使用包的地方。以下是一个示例：

// packages/injective-example/index.ts
export * from './src';

在实际使用中，你需要根据具体的包来引入和使用相应的模块。

3. 项目的配置文件介绍

项目的配置文件分布在项目的各个部分，以下是一些主要的配置文件及其作用：

• .editorconfig：定义了代码编辑器的配置，如缩进和换行符，以确保不同开发者的代码风格一致。

• .eslintrc.js：ESLint 配置文件，用于定义代码质量规则，确保代码遵循一定的风格和规范。

• .prettierrc.js：Prettier 配置文件，用于格式化代码，保证代码的可读性。

• tsconfig.json：TypeScript 配置文件，定义了 TypeScript 编译器的选项。

• package.json：项目包配置文件，包含了项目的元数据、依赖项、脚本等信息。

了解这些配置文件的内容和作用，有助于你更好地维护和开发项目。