# @davestewart/outliner 中文文档 规范地址：https://npmcn.com/package/%40davestewart/outliner/ 版本：1\.2\.0 npm 元数据更新时间：2022-04-05T03:05:22.795Z 中文译文更新时间：2026-11-11T15:46:27.042Z 软件包许可：ISC 本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。 原始 npm 页面：https://www.npmjs.com/package/%40davestewart/outliner 原文对照：https://npmcn.com/package/%40davestewart/outliner/?lang=original ## 关键信息（来自 npm 元数据） - 包体积（解压后）：24.8 kB，13 个文件 - 模块格式：CommonJS - TypeScript 类型：未声明 - 运行依赖：7 个 - 首次发布：2021-09-17T00:50:17.563Z - 最新版本发布：2021-09-18T13:39:06.676Z - 近 30 天下载量：141767（2026-10-12 至 2026-11-10，npm 官方下载统计） - 已发布版本数：5（近 12 个月 0 个） ## 中文简介 作为填充的 SVG 缩写节点包 ## 安装 ```sh npm install @davestewart/outliner ``` 也可以使用：`pnpm add @davestewart/outliner`、`yarn add @davestewart/outliner`、`bun add @davestewart/outliner` ## README # 大纲 ![outliner logo](https://raw.githubusercontent.com/davestewart/outliner/master/assets/artwork/outliner-logo.png) ## 介绍 外观是将 SVG 中键转换成外观填充的节点包 _出口后_ 进程 : ![process](https://raw.githubusercontent.com/davestewart/outliner/master/assets/artwork/process.png) 软件中保留中风有几个原因,例如: [图片](https://twitter.com/figmadesign) 或者说 [缩写](https://twitter.com/sketch) 最好是: - 来调整苍蝇上的宽度和角线 - 列出对象后无法更改 - 联盟操作员关闭打开路径( Sketch) 或创建重输出( Figma) 该工具旨在: - 图标创建者; 不再锁定这些曲线, 失去矢量扭矩! - 开发者; 使用干净的 SVG 转换和操作代码中的属性 ## 开始 要使用大纲, 您需要 [节点](https://nodejs.org/en/) 建立了国家预防机制. 安装后,有两种方法使用外观: - 作为 **[服务](https://npmcn.com/package/%40davestewart/outliner/#readme-running-as-a-service)**,在您导出源文件夹时查看源文件夹并转换文件 - 作为 **[依赖性](https://npmcn.com/package/%40davestewart/outliner/#readme-running-as-a-dependency)**,在您使用转换函数时,提纲器会在您自己的工程中曝光 如果你想从机器上的任何地方运行外观,请安装 **全球** 运行为 **服务**。 。 。 . ## 作为服务运行 ### 作为全球服务 > 最好的设计者单独工作 打开终端提示并在全球安装软件包 : ```bash npm install @davestewart/outliner --global ``` 要开始转换,请拨打 `outliner` 服务通过 `source` 和(可选) `target` 路径 : ``` node outliner ``` 说明: - 路径可以是相对的或绝对的 - 如果你省略 `target`、 `source` 文件将覆盖到原地 - 要删除 `width` 财务报告和审定财务报表 `height` 信息(故调整大小)通过 `--autosize` 旗帜 : ``` node outliner --autosize ``` ### 作为项目服务 > 最佳设计者团队工作 您也可以以服务方式运行大纲 **在内部** aJavaScript项目. 这样就简单了 _谁都行_ 与项目来源合作更新资产. 这次安装外观 _当地_数字 : ```bash npm install @davestewart/outliner --save-dev ``` 然后,在您的项目中添加脚本条目 `package.json`,例如: ```json { "scripts": { "outline-icons": "node outliner --autosize" } } ``` 然后您可以像这样运行大纲服务 : ```bash npm run outline-icons ``` 大纲将启动并监视您指定的文件夹 `` 输出到 ``。 。 。 . ### 日志 一旦服务运行, 大纲将开始转换文件和日志结果 : ![logging](https://raw.githubusercontent.com/davestewart/outliner/master/assets/artwork/cli.png) 该服务将继续观看 `source` 文件夹,并自动检测、转换和登录任何进一步的导出. 一个好的终端应该使路径成为可点击的链接,从而容易打开更新后的文件. 为了参考,记录如下: | 状态 | 说明 | | --- | --- | | 无文件 | 源文件不存在 | | 无数据 | 源文件未包含数据 | | 无写入 | 没有写入目标文件, 只返回输出( 只有 API) | | 无变动 | 输出和目标之间没有变化,所以目标没有更新 | | 更新 | 新输出与旧不同, 因此目标更新 | | 复制 | 源文件在目标文件夹中不存在, 因此被复制 | ## 作为依赖性运行 > 对需要操作 SVG 的开发者来说最好 外观是您像其他软件包一样安装和使用的一种典型的依赖. 如常安装 : ```bash npm i @davestewart/outliner --save-dev ``` 暴露了两种功能: - `outlineFile()` - 装入文件、 大纲、 返回或保存结果 - `outlineSvg()` - 只概述 SVG 文本 文件转换应直截了当: ```js // import dependencies import { outlineFile, outlineSvg } from '@davestewart/outliner' // convert a file and save a copy outlineFile('./assets/src/star.svg', './assets/trg/star.svg') // convert a file and save in place outlineFile('./assets/src/star.svg') // get the converted output but don't save const output = outlineFile('./assets/src/star.svg', false) // convert existing SVG text const output = outlineSvg(input) ``` 请注意,您还可以通过几个额外的参数: - 更改大纲的处理方式 - 日志任务信息 例如: ```js // variables const tasks = ['outline'] // outline but don't strip width and height const log = {} // object to collect logging info // convert outlineFile('./assets/src/star.svg', './assets/trg/star.svg', tasks, log) // debug console.log(log) ``` 日志对象将被运行的每个任务所覆盖 : ``` { paths: 1, autosize: true, state: 'updated' } ``` 注意您也可以通过自定义函数作为 `tasks`数字 : ```js function replaceColor (svg, log) { log.replaceColor = true return svg.replace(/#000000/g, 'currentColor') } outlineSvg(svg, ['outline', replaceColor], log) ``` 检查 `tests/index.js` 用于工作代码的文件. ## API 密码 #### 大纲文件 > 大纲源文件并覆盖或将结果写入新文件 签署: ```ts outlineFile(src: string, trg?: string | false | null, tasks?: Array, log?: object) ``` 参数: - `src`: 源文件夹的相对或绝对路径 - `trg`: 目标文件夹的可选相对或绝对路径 - 通过 `undefined` 用于相同的 `src` - 过 `false` 或者说 `null` 以跳过写入并返回输出 - `tasks`: 要运行的一系列任务, 默认为 `['outline', 'autosize']` - 字符串任务应该是其中之一 `'outline'` 或者说`'autosize'` - 函数的格式 `(svg: string, log: object) => {}: string` - `log`: 可选 `{}` 接收日志信息的对象 #### 大纲 SVG > 大纲 SVG 文本并返回结果 签署: ```js outlineSvg(svg: string, tasks?: Array, log?: object) ``` 参数: - `svg`: 有效的 SVG 文本 - `tasks`: 要运行的一系列任务, 默认为 `['outline', 'autosize']` - 字符串任务应该是其中之一 `'outline'` 或者说`'autosize'` - 函数的格式 `(svg: string, log: object) => {}: string` - `log`: 可选 `{}` 接收日志信息的对象 #### 状态 > 常数对象比较 这个 `log.state` 每个文件操作将包含其中的一个值: ```js State.NO_FILE = 'no file' State.NO_DATA = 'no data' State.NO_WRITE = 'no write' State.NO_CHANGE = 'no change' State.UPDATED = 'updated' State.COPIED = 'copied' ``` ## 演示文稿 > 如果您复制了Repo,您就可以与演示一起玩. 以 : ``` npm run demo ``` 你可以比较一下 `source` 财务报告和审定财务报表 `target` 输出在 Figma、 Sketch 或文本编辑器中. 如果您想要调整并再导出源文件, 大纲器会每次导出时都会取出任何更改并更新目标文件夹 . ## 常见问题 ### @davestewart/outliner 是什么？ 作为填充的 SVG 缩写节点包 ### 如何安装 @davestewart/outliner？ 在项目目录运行 npm install @davestewart/outliner，或使用 pnpm add / yarn add / bun add。它还提供命令行工具 outliner，可以用 npx outliner 直接运行。 ### @davestewart/outliner 支持 TypeScript 吗？ 该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/davestewart\_\_outliner 是否存在。 ### @davestewart/outliner 支持 ESM 还是 CommonJS？ 以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。 ### @davestewart/outliner 可以商用吗？ @davestewart/outliner 使用 ISC 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。 ### @davestewart/outliner 的下载量有多少？ 根据 npm 官方下载统计，@davestewart/outliner 在 2026/10/12 – 2026/11/10 这 30 天内被下载 141,767 次，日均约 4,726 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。 ### @davestewart/outliner 还在维护吗？ 最新版本 1\.2\.0 发布于 2021/09/18（5 年前）；至今共发布 5 个版本，其中过去 12 个月发布了 0 个；首次发布于 2021/09/17。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。