ExcellentExport 项目使用教程

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

excellentexport/
├── dist/
│   ├── excellentexport.js
│   └── excellentexport.min.js
├── src/
│   ├── excellentexport.ts
│   └── index.ts
├── examples/
│   ├── basic.html
│   ├── custom_format.html
│   └── ...
├── package.json
├── tsconfig.json
└── README.md

目录结构介绍

• dist/: 存放编译后的 JavaScript 文件，包括 excellentexport.js 和压缩版本 excellentexport.min.js。
• src/: 源代码目录，包含 TypeScript 文件 excellentexport.ts 和入口文件 index.ts。
• examples/: 示例文件目录，包含多个 HTML 文件，展示了如何使用 ExcellentExport 进行数据导出。
• package.json: 项目的配置文件，定义了项目的依赖、脚本等信息。
• tsconfig.json: TypeScript 配置文件，定义了 TypeScript 编译选项。
• README.md: 项目的说明文档，包含项目的简介、安装方法、使用示例等。

2. 项目的启动文件介绍

src/index.ts

index.ts 是项目的入口文件，负责初始化和导出主要的导出功能。以下是 index.ts 的主要内容：

import { ExcellentExport } from './excellentexport';

export default ExcellentExport;

src/excellentexport.ts

excellentexport.ts 是项目的主要逻辑文件，包含了数据导出到 Excel 和 CSV 的核心功能。以下是文件的主要结构：

export class ExcellentExport {
    static version(): string {
        return "3.9.5";
    }

    static excel(anchor: HTMLAnchorElement | string, table: HTMLTableElement, name: string): void {
        // 导出 Excel 文件的逻辑
    }

    static csv(anchor: HTMLAnchorElement | string, table: HTMLTableElement, delimiter: string, newLine: string): void {
        // 导出 CSV 文件的逻辑
    }

    static convert(options: ConvertOptions, sheets: SheetOptions[]): void {
        // 转换数据的逻辑
    }
}

3. 项目的配置文件介绍

package.json

package.json 是 Node.js 项目的配置文件，定义了项目的元数据、依赖、脚本等信息。以下是 package.json 的主要内容：

{
  "name": "excellentexport",
  "version": "3.9.5",
  "description": "A client side Javascript export to Excel",
  "main": "dist/excellentexport.js",
  "scripts": {
    "build": "tsc",
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "author": "Jordi Burgos",
  "license": "MIT",
  "devDependencies": {
    "typescript": "^4.0.0"
  }
}

tsconfig.json

tsconfig.json 是 TypeScript 项目的配置文件，定义了 TypeScript 编译选项。以下是 tsconfig.json 的主要内容：

{
  "compilerOptions": {
    "target": "es5",
    "module": "commonjs",
    "strict": true,
    "esModuleInterop": true,
    "skipLibCheck": true,
    "forceConsistentCasingInFileNames": true,
    "outDir": "./dist"
  },
  "include": ["src/**/*"]
}

通过以上配置文件，可以了解项目的编译选项和依赖关系，方便开发者进行项目的构建和调试。