Iconoir 项目使用教程

1. 项目目录结构及介绍

Iconoir 是一个开源的图标库，提供了大量的 SVG 图标。项目的目录结构如下：

iconoir/
├── bin/
├── css/
├── docs/
├── examples/
├── iconoir.com/
├── icons/
├── packages/
├── eslintignore
├── eslintrc.cjs
├── gitignore
├── prettierignore
├── prettierrc.json
├── CODE_OF_CONDUCT.md
├── CONTRIBUTING.md
├── FUNDING.yml
├── LICENSE
├── NAMING_CONVENTION.md
├── README.md
├── analysis_options.yaml
├── package.json
├── pnpm-lock.yaml
├── pnpm-workspace.yaml

目录结构介绍

• bin/: 存放项目的可执行脚本文件。
• css/: 存放项目的 CSS 文件。
• docs/: 存放项目的文档文件。
• examples/: 存放项目的示例代码。
• iconoir.com/: 存放 Iconoir 官方网站的源代码。
• icons/: 存放项目的 SVG 图标文件。
• packages/: 存放项目的各个子包。
• eslintignore: ESLint 忽略文件配置。
• eslintrc.cjs: ESLint 配置文件。
• gitignore: Git 忽略文件配置。
• prettierignore: Prettier 忽略文件配置。
• prettierrc.json: Prettier 配置文件。
• CODE_OF_CONDUCT.md: 项目的行为准则。
• CONTRIBUTING.md: 项目的贡献指南。
• FUNDING.yml: 项目的资金支持配置。
• LICENSE: 项目的开源许可证。
• NAMING_CONVENTION.md: 项目的命名规范。
• README.md: 项目的介绍和使用说明。
• analysis_options.yaml: 项目的分析选项配置。
• package.json: 项目的 npm 配置文件。
• pnpm-lock.yaml: pnpm 的锁定文件。
• pnpm-workspace.yaml: pnpm 的工作区配置文件。

2. 项目的启动文件介绍

Iconoir 项目本身是一个图标库，没有传统意义上的“启动文件”。不过，如果你想要在本地运行 Iconoir 的官方网站，可以参考以下步骤：

1. 安装依赖: 在项目根目录下运行 pnpm install 安装所有依赖。
2. 启动开发服务器: 运行 pnpm start 启动开发服务器。

3. 项目的配置文件介绍

3.1 eslintrc.cjs

eslintrc.cjs 是 ESLint 的配置文件，用于定义代码风格和规则。以下是该文件的部分内容：

module.exports = {
  root: true,
  parser: '@typescript-eslint/parser',
  plugins: ['@typescript-eslint'],
  extends: [
    'eslint:recommended',
    'plugin:@typescript-eslint/recommended',
  ],
  rules: {
    // 自定义规则
  },
};

3.2 prettierrc.json

prettierrc.json 是 Prettier 的配置文件，用于格式化代码。以下是该文件的部分内容：

{
  "singleQuote": true,
  "trailingComma": "all",
  "printWidth": 80
}

3.3 package.json

package.json 是 npm 的配置文件，包含了项目的依赖、脚本等信息。以下是该文件的部分内容：

{
  "name": "iconoir",
  "version": "1.0.0",
  "scripts": {
    "start": "pnpm run dev",
    "build": "pnpm run build"
  },
  "dependencies": {
    "react": "^17.0.2",
    "react-dom": "^17.0.2"
  },
  "devDependencies": {
    "eslint": "^7.32.0",
    "prettier": "^2.4.1"
  }
}

通过以上配置文件，你可以了解项目的代码风格、依赖关系以及如何启动和构建项目。