pptx-automizer 使用教程

1. 项目目录结构及介绍

pptx-automizer 是一个基于 Node.js 的 PowerPoint (.pptx) 文件自动化处理工具。以下是项目的主要目录结构及其介绍：

pptx-automizer/
├── .github/                      # GitHub 工作流和相关配置文件
├── .idea/                        # IntelliJ IDEA 项目配置文件
├── __tests__/                    # 测试文件和示例
├── docs/                         # 文档目录
├── src/                          # 源代码目录
│   ├── .eslintrc.json            # ESLint 配置文件
│   ├── . prettierrc              # Prettier 配置文件
│   ├── jest.config.ts            # Jest 配置文件
│   ├── package.json              # npm 包配置文件
│   ├── tsconfig.json             # TypeScript 配置文件
│   └── typedoc.json              # TypeDoc 配置文件
├── .gitignore                    # Git 忽略文件
├── .nodemonignore                # nodemon 忽略文件
├── LICENSE                       # MIT 许可证文件
├── README.md                     # 项目说明文件
└── yarn.lock                     # Yarn 锁文件

2. 项目的启动文件介绍

项目的启动主要通过 package.json 文件中的脚本进行。以下是主要的启动脚本：

• yarn install 或 npm install: 安装项目依赖。
• yarn dev: 启动开发服务器，通常用于本地调试和测试。
• yarn build: 构建项目，生成可在生产环境中使用的文件。

在 src/ 目录下，Automizer.ts 或类似的文件通常是主要的启动文件，它包含创建 Automizer 实例和配置项目的逻辑。

// 示例代码：Automizer.ts
import Automizer from 'pptx-automizer';

const automizer = new Automizer({
  templateDir: 'my/pptx/templates',
  templateFallbackDir: 'my/pptx/fallback-templates',
  outputDir: 'my/pptx/output',
  // 其他配置...
});

// 执行操作...

3. 项目的配置文件介绍

项目的配置主要通过 package.json 和其他相关配置文件进行管理。

• package.json: 定义了项目的依赖、脚本和元数据。它包含项目的启动脚本，例如 start、build 和 test。

  {
    "scripts": {
      "dev": "node src/dev.ts",
      "build": "tsc && node dist/bundle.js",
      // 其他脚本...
    }
  }
  

• .eslintrc.json: ESLint 配置文件，用于定义代码风格和规则。

• .prettierrc: Prettier 配置文件，用于定义代码格式化规则。

• tsconfig.json: TypeScript 配置文件，用于配置 TypeScript 编译选项。

• jest.config.ts: Jest 配置文件，用于配置单元测试。

通过这些配置文件，开发者可以确保代码质量和项目结构的一致性。