GaiaMeasure 项目使用教程

GaiaMeasure 项目使用教程

GaiaMeasure 该库是Sketch插件中的【导出标注】功能的一部分，通过此项目生成标注模板，产物集成在设计师插件中，通过和插件导出设计稿的数据，生成可供开发参考的标注文件 项目地址: https://gitcode.com/gh_mirrors/ga/GaiaMeasure

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

GaiaMeasure 项目的目录结构如下：

GaiaMeasure/
├── docs/
├── public/
├── src/
│   ├── env/
│   ├── gitignore
│   ├── LICENSE
│   ├── README.md
│   ├── README_en.md
│   ├── package.json
│   ├── tsconfig.json
│   └── yarn.lock

目录介绍：

• docs/: 存放项目文档的目录。
• public/: 存放公共资源文件的目录。
• src/: 存放项目源代码的目录。
  • env/: 存放环境配置文件的目录。
  • gitignore: Git 忽略文件配置。
  • LICENSE: 项目开源许可证文件。
  • README.md: 项目介绍和使用说明的 Markdown 文件。
  • README_en.md: 项目介绍和使用说明的英文 Markdown 文件。
  • package.json: 项目依赖和脚本配置文件。
  • tsconfig.json: TypeScript 配置文件。
  • yarn.lock: Yarn 包管理器的锁定文件。

2. 项目的启动文件介绍

项目的启动文件主要是 src/index.ts 或 src/index.js，具体取决于项目使用的编程语言。该文件通常是项目的入口文件，负责初始化应用并启动服务。

示例代码：

// src/index.ts
import React from 'react';
import ReactDOM from 'react-dom';
import App from './App';

ReactDOM.render(<App />, document.getElementById('root'));

3. 项目的配置文件介绍

3.1 package.json

package.json 文件包含了项目的依赖、脚本命令和其他元数据。以下是一些关键配置项：

{
  "name": "GaiaMeasure",
  "version": "1.0.0",
  "scripts": {
    "start": "react-scripts start",
    "build": "react-scripts build",
    "test": "react-scripts test",
    "eject": "react-scripts eject"
  },
  "dependencies": {
    "react": "^17.0.2",
    "react-dom": "^17.0.2",
    "react-scripts": "4.0.3"
  },
  "devDependencies": {
    "@types/react": "^17.0.3",
    "@types/react-dom": "^17.0.3"
  }
}

3.2 tsconfig.json

tsconfig.json 文件是 TypeScript 项目的配置文件，用于指定编译选项。以下是一些常见的配置项：

{
  "compilerOptions": {
    "target": "ES6",
    "module": "commonjs",
    "strict": true,
    "esModuleInterop": true,
    "skipLibCheck": true,
    "forceConsistentCasingInFileNames": true
  },
  "include": ["src/**/*"],
  "exclude": ["node_modules", "build"]
}

3.3 .env

.env 文件用于存储环境变量，通常包含敏感信息或特定环境下的配置。以下是一个示例：

REACT_APP_API_URL=https://api.example.com
REACT_APP_ENV=development

通过以上配置，您可以顺利启动和配置 GaiaMeasure 项目。

GaiaMeasure 该库是Sketch插件中的【导出标注】功能的一部分，通过此项目生成标注模板，产物集成在设计师插件中，通过和插件导出设计稿的数据，生成可供开发参考的标注文件 项目地址: https://gitcode.com/gh_mirrors/ga/GaiaMeasure