svgson 开源项目教程

svgson 开源项目教程

svgsonTransform svg files to json notation 项目地址:https://gitcode.com/gh_mirrors/sv/svgson

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

svgson 项目的目录结构如下：

svgson/
├── bin/
├── dist/
├── examples/
├── src/
│   ├── index.js
│   ├── parse.js
│   ├── stringify.js
│   └── utils.js
├── test/
├── .babelrc
├── .editorconfig
├── .eslintrc
├── .gitignore
├── .npmignore
├── .travis.yml
├── LICENSE
├── package.json
├── README.md
└── yarn.lock

目录结构介绍

• bin/: 包含可执行文件。
• dist/: 包含编译后的文件。
• examples/: 包含示例代码。
• src/: 包含源代码文件。
  • index.js: 项目入口文件。
  • parse.js: 解析 SVG 文件的模块。
  • stringify.js: 将解析后的数据转换回 SVG 字符串的模块。
  • utils.js: 工具函数模块。
• test/: 包含测试文件。
• .babelrc: Babel 配置文件。
• .editorconfig: 编辑器配置文件。
• .eslintrc: ESLint 配置文件。
• .gitignore: Git 忽略文件配置。
• .npmignore: npm 忽略文件配置。
• .travis.yml: Travis CI 配置文件。
• LICENSE: 项目许可证。
• package.json: 项目依赖和脚本配置。
• README.md: 项目说明文档。
• yarn.lock: Yarn 锁定文件。

2. 项目的启动文件介绍

项目的启动文件是 src/index.js。这个文件是整个项目的入口点，负责导出主要的函数和模块。

// src/index.js

import parse from './parse';
import stringify from './stringify';

export { parse, stringify };

启动文件介绍

• parse: 导入自 parse.js，负责解析 SVG 字符串为 JSON 对象。
• stringify: 导入自 stringify.js，负责将 JSON 对象转换回 SVG 字符串。

3. 项目的配置文件介绍

package.json

package.json 文件包含了项目的元数据和依赖信息。以下是一些关键字段：

{
  "name": "svgson",
  "version": "4.1.1",
  "description": "Convert SVG files to JSON notation",
  "main": "dist/index.js",
  "scripts": {
    "build": "babel src --out-dir dist",
    "test": "jest"
  },
  "dependencies": {
    "css-select": "^4.1.3",
    "domhandler": "^4.2.0",
    "domutils": "^2.5.2",
    "htmlparser2": "^6.1.0"
  },
  "devDependencies": {
    "babel-cli": "^6.26.0",
    "babel-preset-env": "^1.7.0",
    "jest": "^26.6.3"
  }
}

.babelrc

.babelrc 文件用于配置 Babel 编译器。

{
  "presets": ["env"]
}

.eslintrc

.eslintrc 文件用于配置 ESLint 代码检查工具。

{
  "extends": "eslint:recommended",
  "parserOptions": {
    "ecmaVersion": 6,
    "sourceType": "module"
  },
  "env": {
    "node": true,
    "es6": true
  }
}

.editorconfig

.editorconfig 文件用于配置编辑器样式。

root = true

[*]
indent_style = space
indent_size = 2
end_of_line = lf
charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = true

.gitignore

.gitignore 文件用于指定 Git 忽略的文件和目录。

svgsonTransform svg files to json notation 项目地址:https://gitcode.com/gh_mirrors/sv/svgson