# yung

> a vite mulit-page cli use vue3.0 and typescript

Latest version **0.33.0** (published 2026-08-11) · ISC license · 0 weekly downloads

## Install

```sh
npm install yung
pnpm add yung
yarn add yung
bun add yung
```

Provides the command `yung`.

## Health

**Score 60/100 (C)** — status: active.

Positive: has types; no vulnerabilities; recently updated; high maintenance score.

Warnings: low downloads; no esm support; pre 1.0.

## Facts

| | |
|---|---|
| Version | 0.33.0 |
| Published | 2026-08-11 |
| First published | 2021-07-25 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | >=18.0.0 |
| Dependencies | 2 |
| Unpacked size | 156.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 4 |
| Author | maYunLaoXi |
| Maintainers | mayunlaoxi |
| Keywords | yung, vite, vue3 |

## Links

- npm: https://www.npmjs.com/package/yung
- Repository: https://github.com/maYunLaoXi/yung
- Issues: https://github.com/maYunLaoXi/yung/issues
- npm.io page: https://npm.io/package/yung

## Dependencies (2)

- [ssh2](https://npm.io/package/ssh2.md) ^1.17.0
- [esbuild](https://npm.io/package/esbuild.md) 0.27.1

## Alternatives

- [raw-loader](https://npm.io/package/raw-loader.md) — 4.3M weekly downloads
- [plop](https://npm.io/package/plop.md) — 1.4M weekly downloads
- [webpack-deadcode-plugin](https://npm.io/package/webpack-deadcode-plugin.md) — 80.3K weekly downloads
- [@storybook/preact-vite](https://npm.io/package/@storybook/preact-vite.md) — 54.2K weekly downloads
- [vite-plugin-transform](https://npm.io/package/vite-plugin-transform.md) — 2.4K weekly downloads

## Recent versions

- 0.33.0 (latest) — 2026-08-11
- 0.31.0 — 2026-03-09
- 0.2.6 — 2024-10-22
- 0.2.5 — 2022-10-10
- 0.2.4 — 2022-10-10
- 0.2.3 — 2021-08-04
- 0.2.2 — 2021-08-04
- 0.2.1 — 2021-08-04
- 0.2.0 — 2021-08-04
- 0.1.0 — 2021-07-27
- 0.0.4 — 2021-07-27
- 0.0.3 — 2021-07-27
- 0.0.2 — 2021-07-25
- 0.0.1 — 2021-07-25

## README

# yung
## 简介

* 极简的前端构建工具，基于vite@2.4.3的封装，支持动态入口（多页面）模式。

* API不多，使用`yung dev`，和`yung build`即可愉快开发。

* 继承vite的任意配置和插件，但`root`和`base`会被工具动态替换，从而实现动态入口模式。

* 有别于类官网的多页面模式，yung每次只启动或构建一个页面，从而开发不同需求的项目，但其中已封装的工具或组件是可以复用的。有效的提升开发和维护的效率。

目前仅支持`typeScript`的vite配置文件

> 注： ~~有关vite的配置请写在项目根目录的`vite.config.ts`文件内。~~
> v0.2.0版开始改为使用项目本身的`vite`进行构建，接收`vite`原生命令行参数，但`root`和`base`会被替换。

## 使用

```
npm install yung -g           # 全局
npm install yung --save-dev   # 本地
```
### 推荐参考或使用模板`yung-vue3-starter`

see: [yung-vue3-starter](https://github.com/maYunLaoXi/yung-vue3-starter)
### 基本目录结构

```
- src/
  - page1
    - main.ts                 # page1的脚本入口
    - index.thml              # page1的入口文件
  - page2
    - main.ts                 # page2的脚本入口
    - index.thml              # page2的入口文件
  ... 其他页面
  - main.ts                   # 默认脚本入口
- index.html                  # 默认入口html（遵循vite）
- vite.config.ts              # vite的配置
```
### 启动

本地开发和打包

```
# 全局安装用法：
yung dev                      # 单页模式（vite默认入口）
yung dev page                 # 启动页面page（开发）
yung dev page2                # 启动页面page2（开发）

yung build                    # 构建生产代码（vite默认入口)
yung build page               # 构建page生产代码
yung build page2              # 构建page2生产代码

# 本地安装用法：
npx yung dev                  # 单页模式（vite默认入口）
npx yung dev page             # 启动页面page（开发）
...

npx yung build                # 构建生产代码（vite默认入口)
npx yung build page           # 构建page生产代码
...
```

本地预览生产代码
```
yung preview                  # 预览默认页面（单页模式）
yung preview page             # 预览页面page
```

> 注： 如需在构建生产前进行typescript的类型检查，可先执行`tsc --noEmit`或使用`vue-tsc`。see: [https://vitejs.bootcss.com/guide/features.html#npm-dependency-resolving-and-pre-bundling](https://vitejs.bootcss.com/guide/features.html#npm-dependency-resolving-and-pre-bundling)

## 上传构建的代码到服务器

yung支持将构建后的代码发布到服务器，假如你的代码各个页面都发布到同一基路径下，布页面刚好就是其子路径，即可使用命令`yung deploy page1 --servece prod`将page1下的dist上内上传到prod服务器下的page1目录下。

在项目跟目录下新增`yung`配置文件`yung.config.ts`，配置文件目前仅支持使用ESM语法的.ts文件。

```typescript
// yung.config.ts
export default function(mode) {
  return {
    service: {
      lan: {
      	// 必传,远程代码的跟地址
        baseDir: '/home/liangyh/www',
        // codeDir如果不传，会使用page的名称,不可设为 /
        // codeDir: '/',
        backupDir: '/home/liangyh/backup/yung',
        ssh: {
          host: '192.168.1.108',
          port: 22,
          username: 'liangyh',
          // 或使用privateKey
          // privateKey: fs.readFileSyec('./key')
          password: 'lyh'
        }
      },
      prod: {
      	...
      },
      ...other service
    }
  }
}
```

执行deploy前，请选执行build命令对项目进行构建。

```shell
yung build page1
# 将page1下的dist上传到 lan
yung deploy page1 --service lan
```



## TODO

* 构建生产代码时可以转入多个页面
  ```
  yung build page1 page2
  ```
* 代码跟据目录发布到服务器指定目录

---
_Source: https://npm.io/package/yung · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._