# @cardog-icons/core 中文文档

规范地址：https://npmcn.com/package/%40cardog-icons/core/

版本：1\.2\.0
npm 元数据更新时间：2026-03-14T23:03:45.969Z
中文译文更新时间：2026-11-09T04:16:29.645Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40cardog-icons/core
原文对照：https://npmcn.com/package/%40cardog-icons/core/?lang=original

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：4.1 MB，415 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：2 个
- 首次发布：2025-03-11T05:14:09.559Z
- 最新版本发布：2026-03-14T23:03:45.860Z
- 近 30 天下载量：34243（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：5（近 12 个月 3 个）

## 中文简介

Cardog 图标的核心功能 - SVG 优化和处理

## 安装

```sh
npm install @cardog-icons/core
```

也可以使用：`pnpm add @cardog-icons/core`、`yarn add @cardog-icons/core`、`bun add @cardog-icons/core`

## README

# @ cardog- icons/ 核心

在Cardog图标库中用于SVG优化和处理的核心功能.

## 特征

-   使用 SVGO 优化 SVG
-   批量处理 SVG 文件的公用事业
-   处理品牌名称和缩略语
-   PascalCase 组件名称转换

## 安装

```bash
npm install @cardog-icons/core
# or
yarn add @cardog-icons/core
# or
pnpm add @cardog-icons/core
```

## 使用量

### 优化 SVG

```typescript
import { optimizeSvg, batchOptimizeSvgs } from "@cardog-icons/core";
import path from "path";

// Optimize a single SVG
await optimizeSvg("./path/to/input.svg", "./path/to/output.svg", {
  precision: 2,
  removeIds: true,
});

// Batch optimize multiple SVGs
const svgFiles = ["file1.svg", "file2.svg", "file3.svg"].map((file) =>
  path.resolve("./path/to/svgs", file)
);

await batchOptimizeSvgs(
  svgFiles,
  "./path/to/output",
  { precision: 2 },
  10 // batch size
);
```

### 工具函数

```typescript
import {
  toPascalCase,
  processBrandName,
  findSvgFiles,
  ensureDirectoryExists,
} from "@cardog-icons/core";

// Convert a filename to PascalCase
const componentName = toPascalCase("bmw_logo");
// Result: "BMWLogo"

// Process a brand name (preserving acronyms)
const brandName = processBrandName("BMW Group");
// Result: "BMWGroup"

// Find all SVG files in a directory
const svgFiles = await findSvgFiles("./path/to/svgs");

// Ensure a directory exists
ensureDirectoryExists("./path/to/output");
```

## 许可证

麻省理工学院

## 常见问题

### @cardog-icons/core 是什么？

Cardog 图标的核心功能 - SVG 优化和处理

### 如何安装 @cardog-icons/core？

在项目目录运行 npm install @cardog-icons/core，或使用 pnpm add / yarn add / bun add。

### @cardog-icons/core 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @cardog-icons/core 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @cardog-icons/core 可以商用吗？

@cardog-icons/core 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @cardog-icons/core 的下载量有多少？

根据 npm 官方下载统计，@cardog-icons/core 在 2026/10/09 – 2026/11/07 这 30 天内被下载 34,243 次，日均约 1,141 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @cardog-icons/core 还在维护吗？

最新版本 1\.2\.0 发布于 2026/03/15（7 个月前）；至今共发布 5 个版本，其中过去 12 个月发布了 3 个；首次发布于 2025/03/11。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。