D3-render 项目启动与配置文档

1. 项目目录结构及介绍

D3-render 是一个开源项目，旨在提供一种声明式和可重用的 D3.js 使用方式。该项目通过一个函数 render 来替代 D3.js 中的 select, append, data, join, enter, exit, transition 等操作，使代码更加简洁和易于理解。

项目目录结构如下：

d3-render/
├── .github/
│   └── workflows/
├── example/
├── src/
├── test/
├── .gitignore
├── CHANGELOG.md
├── LICENSE
├── README.md
├── package-lock.json
├── package.json
└── tsconfig.json

• .github/workflows/：GitHub Actions 工作流配置文件所在目录。
• example/：示例代码目录。
• src/：项目源代码目录。
• test/：测试代码目录。
• .gitignore：Git 忽略文件配置。
• CHANGELOG.md：项目更新日志。
• LICENSE：项目许可协议。
• README.md：项目说明文档。
• package-lock.json：npm 依赖版本锁定文件。
• package.json：项目配置文件。
• tsconfig.json：TypeScript 配置文件。

2. 项目的启动文件介绍

项目的启动文件为 src/index.ts，该文件导出了 render 函数。在使用 D3-render 时，需要先导入 render 函数。

import render from 'd3-render';

3. 项目的配置文件介绍

项目的配置文件为 package.json，该文件包含了项目的基本信息、依赖项、脚本等信息。

{
  "name": "d3-render",
  "version": "0.3.0",
  "description": "Declarative and reusable D3. Replace select, append, data and more with one function.",
  "main": "dist/index.js",
  "module": "dist/index.esm.js",
  "types": "dist/index.d.ts",
  "repository": {
    "type": "git",
    "url": "git+https://github.com/unkleho/d3-render.git"
  },
  "author": "unkleho",
  "license": "MIT",
  "bugs": {
    "url": "https://github.com/unkleho/d3-render/issues"
  },
  "homepage": "https://github.com/unkleho/d3-render#readme",
  "peerDependencies": {
    "d3-selection": "^2",
    "d3-transition": "^2"
  },
  "devDependencies": {
    "@types/node": "^10.12.0",
    "@typescript-eslint/eslint-plugin": "^3.10.1",
    "@typescript-eslint/parser": "^3.10.1",
    "eslint": "^7.14.0",
    "tsdx": "^0.13.0",
    "typescript": "^4.0.5"
  },
  "scripts": {
    "build": "tsdx build",
    "start": "tsdx watch",
    "test": "tsdx test",
    "lint": "eslint --ext .ts src/ test/"
  },
  "keywords": [
    "d3",
    "declarative",
    "data-visualization"
  ]
}

• name：项目名称。
• version：项目版本号。
• description：项目描述。
• main：项目入口文件。
• module：ESM 模块入口文件。
• types：TypeScript 类型定义文件。
• repository：项目仓库信息。
• author：项目作者。
• license：项目许可协议。
• bugs：项目 bug 反馈地址。
• homepage：项目主页地址。
• peerDependencies：项目依赖的其他 npm 包。
• devDependencies：项目开发所需的 npm 包。
• scripts：项目构建、启动、测试等脚本。
• keywords：项目关键词。