html2sketch 项目教程

html2sketch 项目教程

html2sketchparser HTML to Sketch JSON项目地址:https://gitcode.com/gh_mirrors/ht/html2sketch

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

html2sketch 项目的目录结构如下：

html2sketch/
├── README.zh-CN.md
├── package.json
├── src/
│   ├── index.ts
│   ├── utils/
│   ├── types/
│   ├── ...
├── tests/
│   ├── ...
├── tsconfig.json
└── ...

目录结构介绍

• README.zh-CN.md: 项目的中文介绍文档。
• package.json: 项目的依赖管理文件。
• src/: 项目的源代码目录。
  • index.ts: 项目的入口文件。
  • utils/: 工具函数目录。
  • types/: 类型定义目录。
• tests/: 测试文件目录。
• tsconfig.json: TypeScript 配置文件。

2. 项目的启动文件介绍

项目的启动文件是 src/index.ts。该文件是项目的入口点，负责初始化并导出主要的功能模块。

// src/index.ts

export { nodeToLayer } from './nodeToLayer';
export { nodeToGroup } from './nodeToGroup';
export { nodeToSymbol } from './nodeToSymbol';

启动文件功能介绍

• nodeToLayer: 将 DOM 节点转换为 Sketch 对象，不处理节点的子级。
• nodeToGroup: 将 DOM 节点及其子级整体转换为 Sketch 的 Group 对象。
• nodeToSymbol: 将 DOM 节点转换为 Sketch 的 Symbol 对象。

3. 项目的配置文件介绍

项目的配置文件主要是 tsconfig.json 和 package.json。

tsconfig.json

tsconfig.json 是 TypeScript 的配置文件，用于配置 TypeScript 编译器的行为。

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

package.json

package.json 是 Node.js 项目的配置文件，包含了项目的依赖、脚本等信息。

{
  "name": "html2sketch",
  "version": "1.0.0",
  "description": "A module that transform HTML into Sketch JSON",
  "main": "dist/index.js",
  "scripts": {
    "build": "tsc",
    "test": "jest"
  },
  "dependencies": {
    "typescript": "^4.0.0"
  },
  "devDependencies": {
    "jest": "^26.0.0"
  }
}

配置文件功能介绍

• tsconfig.json: 配置 TypeScript 编译选项，如目标 ECMAScript 版本、输出目录等。
• package.json: 管理项目的依赖和脚本，如构建命令 npm run build 和测试命令 npm run test。

html2sketchparser HTML to Sketch JSON项目地址:https://gitcode.com/gh_mirrors/ht/html2sketch