maxrects-packer 开源项目教程

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

maxrects-packer 项目的目录结构如下：

maxrects-packer/
├── bin/
├── examples/
├── lib/
├── src/
├── test/
├── .gitignore
├── .npmignore
├── .travis.yml
├── LICENSE
├── package.json
├── README.md
└── tsconfig.json

目录介绍

• bin/: 包含可执行文件。
• examples/: 包含示例代码，展示如何使用 maxrects-packer。
• lib/: 包含编译后的 JavaScript 文件。
• src/: 包含 TypeScript 源代码。
• test/: 包含测试文件。
• .gitignore: Git 忽略文件列表。
• .npmignore: npm 忽略文件列表。
• .travis.yml: Travis CI 配置文件。
• LICENSE: 项目许可证。
• package.json: 项目依赖和脚本配置。
• README.md: 项目说明文档。
• tsconfig.json: TypeScript 编译配置。

2. 项目的启动文件介绍

maxrects-packer 的启动文件位于 src/ 目录下，主要的启动文件是 index.ts。这个文件导出了项目的主要功能和类。

// src/index.ts
export { MaxRectsPacker, IMaxRectsPackerOptions } from './MaxRectsPacker';
export { Bin, IBin, IRectangle } from './Bin';

启动文件功能

• MaxRectsPacker: 主类，用于打包矩形。
• Bin: 用于管理打包后的矩形容器。
• IRectangle: 矩形接口定义。

3. 项目的配置文件介绍

maxrects-packer 的配置文件主要是 package.json 和 tsconfig.json。

package.json

package.json 文件包含了项目的元数据和依赖信息。

{
  "name": "maxrects-packer",
  "version": "2.6.0",
  "description": "A 2D bin packing library based on the MAXRECTS algorithm",
  "main": "lib/index.js",
  "types": "lib/index.d.ts",
  "scripts": {
    "build": "tsc",
    "test": "jest",
    "prepublishOnly": "npm run build"
  },
  "keywords": [
    "bin packing",
    "maxrects",
    "2d",
    "rectangle",
    "packer"
  ],
  "author": "Yun Yuan",
  "license": "MIT",
  "devDependencies": {
    "@types/jest": "^26.0.20",
    "jest": "^26.6.3",
    "ts-jest": "^26.5.1",
    "typescript": "^4.1.3"
  }
}

tsconfig.json

tsconfig.json 文件包含了 TypeScript 编译配置。

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

配置文件功能

• package.json: 定义了项目的名称、版本、依赖、脚本等。
• tsconfig.json: 定义了 TypeScript 编译选项，包括目标 ECMAScript 版本、输出目录等。