use-editable 项目使用教程

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

use-editable 项目的目录结构如下：

use-editable/
├── github/workflows/
│   └── ...
├── src/
│   └── ...
├── .gitignore
├── CHANGELOG.md
├── LICENSE
├── README.md
├── package.json
├── rollup.config.js
├── tsconfig.json
├── use-editable-Hero.png
└── yarn.lock

目录结构介绍

• github/workflows/: 包含 GitHub Actions 的工作流配置文件。
• src/: 包含项目的源代码文件。
• .gitignore: 指定 Git 版本控制系统忽略的文件和目录。
• CHANGELOG.md: 记录项目版本变更的日志文件。
• LICENSE: 项目的开源许可证文件。
• README.md: 项目的介绍和使用说明文档。
• package.json: 项目的依赖和脚本配置文件。
• rollup.config.js: Rollup 打包工具的配置文件。
• tsconfig.json: TypeScript 编译器的配置文件。
• use-editable-Hero.png: 项目的图标文件。
• yarn.lock: Yarn 包管理器的锁定文件，确保依赖版本一致。

2. 项目的启动文件介绍

use-editable 项目的启动文件主要是 src/index.ts，该文件是项目的入口文件，负责导出主要的功能模块。

// src/index.ts
export { useEditable } from './useEditable';

启动文件介绍

• src/index.ts: 导出 useEditable 钩子函数，供外部使用。

3. 项目的配置文件介绍

use-editable 项目的主要配置文件包括 package.json 和 rollup.config.js。

package.json

package.json 文件包含了项目的元数据和依赖信息，以及一些脚本命令。

{
  "name": "use-editable",
  "version": "1.0.0",
  "description": "A small React hook to turn elements into fully renderable & editable content surfaces like code editors using contenteditable (and magic)",
  "main": "dist/index.js",
  "module": "dist/index.esm.js",
  "types": "dist/index.d.ts",
  "scripts": {
    "build": "rollup -c",
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "keywords": [
    "react",
    "hook",
    "contenteditable",
    "editable",
    "code",
    "editor"
  ],
  "author": "Formidable Labs",
  "license": "MIT",
  "dependencies": {
    "react": "^17.0.2"
  },
  "devDependencies": {
    "@types/react": "^17.0.2",
    "rollup": "^2.45.2",
    "rollup-plugin-typescript2": "^0.30.0",
    "typescript": "^4.2.3"
  }
}

rollup.config.js

rollup.config.js 文件是 Rollup 打包工具的配置文件，用于配置打包的输入、输出和其他选项。

import typescript from 'rollup-plugin-typescript2';

export default {
  input: 'src/index.ts',
  output: [
    {
      file: 'dist/index.js',
      format: 'cjs',
    },
    {
      file: 'dist/index.esm.js',
      format: 'esm',
    },
  ],
  plugins: [
    typescript({
      tsconfig: 'tsconfig.json',
    }),
  ],
};

配置文件介绍

• package.json: 包含项目的名称、版本、描述、入口文件、脚本命令、依赖和开发依赖等信息。
• rollup.config.js: 配置 Rollup 打包工具的输入、输出格式和插件等选项。