# @forsakringskassan/vite-lib-config 中文文档

规范地址：https://npmcn.com/package/%40forsakringskassan/vite-lib-config/

版本：5\.15\.2
npm 元数据更新时间：2026-11-06T05:05:38.979Z
中文译文更新时间：2026-11-15T09:29:50.362Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40forsakringskassan/vite-lib-config
原文对照：https://npmcn.com/package/%40forsakringskassan/vite-lib-config/?lang=original
项目主页：https://github.com/Forsakringskassan/vite-lib-config
源码仓库：https://github.com/Forsakringskassan/vite-lib-config

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

- 包体积（解压后）：906 kB，29 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：^22\.12\.0 \|\| \>= 24
- 运行依赖：3 个
- peer 依赖：vue ^3\.0\.0，vite ^5\.0\.0 \|\| ^6\.0\.0 \|\| ^7\.0\.0 \|\| ^8\.0\.0，prettier ^3\.0\.0，typescript ^5\.0\.2 \|\| ^6\.0\.2 \|\| ^7\.0\.0，vue-router ^5\.0\.0，@babel/core ^7\.22\.0，@fkui/tsconfig \>= 6\.3\.0，@forsakringskassan/apimock-express ^1\.1\.0 \|\| ^2\.0\.0 \|\| ^3\.0\.0 \|\| ^4\.0\.0，@babel/plugin-transform-nullish-coalescing-operator ^7\.22\.0
- 首次发布：2024-03-11T14:10:20.973Z
- 最新版本发布：2026-11-06T05:05:38.597Z
- 近 30 天下载量：26379（2026-10-16 至 2026-11-14，npm 官方下载统计）
- 已发布版本数：139（近 12 个月 82 个）

## 中文简介

Försäkringskassan 用 Vite 构建库的工具链

## 安装

```sh
npm install @forsakringskassan/vite-lib-config
```

也可以使用：`pnpm add @forsakringskassan/vite-lib-config`、`yarn add @forsakringskassan/vite-lib-config`、`bun add @forsakringskassan/vite-lib-config`

## README

# `@forsakringskassan/vite-lib-config`

Vue框架库建设工具链.

-   混合无害环境管理/CJS包.
-   与巴贝尔相传.
-   支持单发.
-   可选:构建页面对象,选择器,并进行模拟.
-   可选:共享打字配置.

## 配置

使用 `fk-write-config` 将锅炉板配置文件写入仓库:

```
fk-write-config
```

API 提取器是选项a,必须启用 `--with-api-extractor`。 。 。 .

默认是假设 `vitest` 用作测试跑道,使用 `--with-jest` 或者说 `--with-vitest` 明确设置试跑者.

### 捆绑的依赖关系

默认情况下所有依附关系( E)`dependencies` 财务报告和审定财务报表 `peerDependencies`)被标记为外部,而不在输出文件中捆绑. 此选项可通过设置被覆盖 `externalDependencies` 内 `package.json`数字 :

```diff
     "dependencies": {
         "lodash": "^4.17.20"
     },
+    "externalDependencies": [
+        "lodash"
+    ],
```

## 使用量

### `babel.config.js`

```js
module.exports = {
    presets: ["@forsakringskassan/vite-lib-config/babel"],
};
```

### `vite.config.ts`

```ts
import { defineConfig } from "@forsakringskassan/vite-lib-config/vite";

export default defineConfig();
```

除了常规 Vite 配置外, 您还可以通过可选 `fk` 属性 :

```
export interface FKConfig {
    /** path to component to mount by default (default `src/dev-vite/app.vue`) */
    entrypoint?: string;
    /** mocks to configure with apimock-express (default `[]`) */
    mocks?: MockEntry[] | Mock[]
}
```

### `package.json`

```json
{
    "scripts": {
        "build": "fk-build-vue-lib"
    }
}
```

### 可选: API 提取器

```diff
 {
     "scripts": {
         "build": "fk-build-vue-lib",
+        "postbuild": "fk-api-extractor api-extractor.json",
     }
 }
```

多个文件或 globs 可以给出 :

> fk-api-extractor api-extractor. \*.json) 互联网档案馆的存檔,存档日期2013-12-02

确定全球模块增强用途:

> fk-api-extractor -- patch-augments (英语)

使用 `--help` 可以看到完整的描述.

### 可选:构建页面对象和选择器

```diff
 {
     "scripts": {
         "build": "fk-build-vue-lib",
+        "build:selectors": "fk-build-selectors",
     }
 }
```

若为 `src/selectors/index.ts` 它将被建造到 `dist/${format}/selectors.${cjs,mjs}`。 。 。 .

若为 `src/cypress/index.ts` 它将被建造到 `dist/${format}/cypress.${cjs,mjs}`。 。 。 .

### 可选:构建模拟器

```diff
 {
     "scripts": {
         "build": "fk-build-vue-lib --mocks",
     }
 }
```

这个构筑 `src/mocks/index.ts` 改为 `dist/${format}/mocks.${cjs,mjs}`文件必须导出类型的模拟列表 [`apimock-express`](https://github.com/Forsakringskassan/apimock-express) (单位:千美元)`MockEntry[]` 或者说 `Mock[]`) (中文(简体) ).

**市场/市场/指数**

```typescript
import { type Mock } from "@forsakringskassan/apimock-express";

const mocks: Mock[] = [...];
export default mocks;
```

### 开发服务器

```json
{
    "scripts": {
        "start": "vite"
    }
}
```

创建 `src/local.{ts,mts,mjs,js}` 导出单个函数 `setup`数字 :

```
import { createApp } from "vue";
import { type SetupOptions } from "@forsakringskassan/vite-lib-config";

export function setup(options: SetupOptions): void {
    const { rootComponent, selector } = options;
    const app = createApp(rootComponent);
    app.mount(selector);
}
```

如果 `setup` 函数是async(即返回 a) `Promise`在继续之前将等待它.

创建 `src/vite-dev/app.vue` 包含要用作开发环境的根组件.

在 Dev 模式下运行时,可以指定一个可选文件名(或文件名的一部分)来运行,而不是默认 `src/vite-dev/app.vue`数字 :

```
vite -- MyAwesomeExample
```

将搜索 `.vue` 匹配这些文件夹中给定模式(模糊)的文件 :

-   `**/docs`
-   `**/examples`
-   `**/test`

### 辅助插件

如果您需要在库中使用自定义插件, 请记住包含默认插件, 否则这些插件会被覆盖 .

#### `vite.config.ts`

```ts
import {
    defineConfig,
    defaultPlugins,
} from "@forsakringskassan/vite-lib-config/vite";

export default defineConfig({
    plugins: [...defaultPlugins, myFancyPlugin],
});
```

## 常见问题

### @forsakringskassan/vite-lib-config 是什么？

Försäkringskassan 用 Vite 构建库的工具链

### 如何安装 @forsakringskassan/vite-lib-config？

在项目目录运行 npm install @forsakringskassan/vite-lib-config，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：vue（^3\.0\.0）、vite（^5\.0\.0 \|\| ^6\.0\.0 \|\| ^7\.0\.0 \|\| ^8\.0\.0）、prettier（^3\.0\.0）、typescript（^5\.0\.2 \|\| ^6\.0\.2 \|\| ^7\.0\.0）、vue-router（^5\.0\.0）、@babel/core（^7\.22\.0）、@fkui/tsconfig（\>= 6\.3\.0）、@forsakringskassan/apimock-express（^1\.1\.0 \|\| ^2\.0\.0 \|\| ^3\.0\.0 \|\| ^4\.0\.0）、@babel/plugin-transform-nullish-coalescing-operator（^7\.22\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。它还提供命令行工具 fk-write-config、fk-api-extractor、fk-build-vue-lib、fk-build-selectors，可以用 npx fk-write-config 直接运行。

### @forsakringskassan/vite-lib-config 支持 TypeScript 吗？

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

### @forsakringskassan/vite-lib-config 支持 ESM 还是 CommonJS？

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

### @forsakringskassan/vite-lib-config 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js ^22\.12\.0 \|\| \>= 24。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @forsakringskassan/vite-lib-config 可以商用吗？

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

### @forsakringskassan/vite-lib-config 的下载量有多少？

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

### @forsakringskassan/vite-lib-config 还在维护吗？

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