Svelte-Feather-Icons 项目教程

1. 项目目录结构及介绍

Svelte-Feather-Icons 是一个基于 Svelte 的图标库，它提供了 Feather 图标集合的 Svelte 组件。项目目录结构如下：

svelte-feather-icons/
├── .gitignore             # Git 忽略文件列表
├── README.md             # 项目说明文件
├── LICENSE               # 项目许可证文件
├── package.json          # 项目配置文件
├── rollup.config.js       # Rollup 打包配置文件
├── build.js              # 构建脚本文件
├── src/                  # 源代码目录
│   ├── components/       # Svelte 组件目录
│   └── utils/            # 工具函数目录
└── .github/              # GitHub 工作流目录
    └── workflows/        # GitHub 工作流文件

• .gitignore：指定 Git 应该忽略的文件和目录。
• README.md：提供项目的基本信息和用法指南。
• LICENSE：项目遵循的许可证信息。
• package.json：定义了项目的元数据、脚本和依赖关系。
• rollup.config.js：Rollup 打包工具的配置文件，用于将 Svelte 组件打包成可用的格式。
• build.js：构建脚本，用于构建项目。
• src/：源代码目录，包含了所有 Svelte 组件和工具函数。
• .github/：包含 GitHub 工作流的配置文件，用于自动化项目的一些操作。

2. 项目的启动文件介绍

在 Svelte-Feather-Icons 项目中，并没有直接的启动文件，因为该项目是一个库，它被设计为作为其他项目的依赖项使用。如果你想在自己的 Svelte 项目中使用这个图标库，你需要在你的项目中安装它，并按照以下方式导入和使用图标：

// 在你的 Svelte 组件中
<script>
  import { AirplayIcon } from 'svelte-feather-icons';
</script>

<AirplayIcon size="24" />

3. 项目的配置文件介绍

项目的主要配置文件是 package.json 和 rollup.config.js。

• package.json：这个文件包含了项目的元数据，例如项目的名称、版本、描述、作者、许可证以及依赖关系。它还包含了构建和测试的脚本。

{
  "name": "svelte-feather-icons",
  "version": "4.2.0",
  "description": "Feather icons for Svelte",
  "main": "dist/svelte-feather-icons.js",
  "scripts": {
    "build": "rollup -c rollup.config.js"
  },
  "dependencies": {
    "feather-icons": "^4.29.0"
  },
  "devDependencies": {
    "rollup": "^2.70.0",
    "svelte": "^3.44.0"
  },
  "license": "MIT",
  "repository": {
    "type": "git",
    "url": "git+https://github.com/dylanblokhuis/svelte-feather-icons.git"
  }
}

• rollup.config.js：这个文件用于配置 Rollup 打包工具，它定义了输入文件、输出文件以及其他打包选项。

import svelte from 'rollup-plugin-svelte';
import commonjs from '@rollup/plugin-commonjs';
import resolve from '@rollup/plugin-node-resolve';

export default {
  input: 'src/index.js',
  output: {
    file: 'dist/svelte-feather-icons.js',
    format: 'umd',
    name: 'SvelteFeatherIcons',
    sourcemap: true
  },
  plugins: [
    svelte({
      include: 'src/**/*.svelte'
    }),
    commonjs(),
    resolve()
  ]
};

这个配置文件确保了当运行 npm run build 命令时，会使用 Rollup 将 Svelte 组件打包成 UMD 格式的模块，这样就可以在其他的 Svelte 项目中使用了。