# gitee-ent-view

> 码云企业版视图库

Latest version **1.4.2** (published 2019-12-12) · AGPL-3.0-or-later license · 0 weekly downloads

## Install

```sh
npm install gitee-ent-view
pnpm add gitee-ent-view
yarn add gitee-ent-view
bun add gitee-ent-view
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; large bundle.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.4.2 |
| Published | 2019-12-12 |
| First published | 2019-11-14 |
| Weekly downloads | 0 |
| License | AGPL-3.0-or-later |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 13 |
| Unpacked size | 16 MB |
| Known vulnerabilities | 0 (+2 in 2 direct dependencies) |
| Install scripts | no |
| Author | Gitee |
| Maintainers | lc-soft, zhanqingsheng |

## Links

- npm: https://www.npmjs.com/package/gitee-ent-view
- Repository: git@gitee.com:gitee-frontend/gitee-ent-view
- npm.io page: https://npm.io/package/gitee-ent-view

## Dependencies (13)

- [vue](https://npm.io/package/vue.md) ^2.6.10
- [js-md5](https://npm.io/package/js-md5.md) ^0.7.3
- [core-js](https://npm.io/package/core-js.md) ^3.4.2
- [vue-meta](https://npm.io/package/vue-meta.md) ^2.3.1
- [sortablejs](https://npm.io/package/sortablejs.md) ^1.10.1
- [vue-router](https://npm.io/package/vue-router.md) ^3.1.3
- [gitee-intro](https://npm.io/package/gitee-intro.md) ^1.6.0
- [vue-context](https://npm.io/package/vue-context.md) ^4.1.1
- [highlight.js](https://npm.io/package/highlight.js.md) ^9.16.2
- [monaco-editor](https://npm.io/package/monaco-editor.md) ^0.15.1
- [osc-element-ui](https://npm.io/package/osc-element-ui.md) ^2.8.4-beta.2
- [remove-markdown](https://npm.io/package/remove-markdown.md) ^0.3.0
- [vue-virtual-scroller](https://npm.io/package/vue-virtual-scroller.md) ^1.0.0-rc.2

## Recent versions

- 1.4.2 (latest) — 2019-12-12
- 1.4.3-pr2.0 (alpha) — 2019-12-19
- 1.4.3-beta.8 (beta) — 2019-12-19
- 1.4.3-beta.7 — 2019-12-19
- 1.4.3-beta.6 — 2019-12-19
- 1.4.3-beta.4 — 2019-12-18
- 1.4.3-beta.3 — 2019-12-17
- 1.4.3-beta.2 — 2019-12-17
- 1.4.3-beta.1 — 2019-12-17
- 1.4.3-beta.0 — 2019-12-16
- 1.4.1 — 2019-12-11
- 1.4.0 — 2019-12-06
- 1.3.0 — 2019-12-05
- 1.2.0 — 2019-11-25
- 1.1.0 — 2019-11-21
- … 3 more at https://npm.io/package/gitee-ent-view/versions

## README

# gitee-ent-view

[![npm](https://img.shields.io/npm/v/gitee-ent-view.svg)](https://gitee.com/gitee-frontend/gitee-ent-view/releases)
[![gitee-release-cli](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-gitee--release-blueviolet.svg)](https://gitee.com/gitee-frontend/gitee-reelase-cli/blob/master/LICENSE)

## 介绍

码云企业版视图库，用于向主仓库提供已预构建好的 js 及资源文件，减少主仓库的 webpack 构建时间。

## 开发

**gitee-ent-view 仓库**

```bash
# 克隆本仓库
git clone git@gitee.com:gitee-frontend/gitee-ent-view.git

# 进入仓库目录
cd gitee-ent-view

# 安装依赖
npm install

# 将 gitee-ent-view 链接到全局 node_modules 目录里
npm link

# 指定主仓库的路径
export GITEE_REPO_PATH=/path/to/gitee-repo

# 开始构建资源（development 模式）
npm start
```

**主仓库:**

```bash
# 将全局 node_modules 目录中的 gitee-ent-view 链接链接到当前 node_moudles 目录中
npm link gitee-ent-view

# 构建资源（development 模式）
npm run dev
```

**注意：** 在主仓库中每次运行 `npm install` 后 gitee-ent-view 目录的软链接会被解除，需要重新运行 `npm link gitee-ent-view`。

### 使用 Webpack Dev Server

修改主仓库中的开发环境配置文件 `config/development.rb`，在最底下加上一项：

```
config.webpack.public_path = ''
```

在 gitee-ent-view 仓库中启动 Webpack Dev Server：

```
npm run dev-server
```

**注意：** 修改配置后，你将只能访问企业版页面的资源，访问手机版、个人中心、企业注册等页面时会显示 `Can't find entry point 'xxxxxx' in webpack manifest` 的错误。

## 发布

先决条件：

- 已在 [npmjs.org](http://npmjs.org/) 上注册了账号
- 账号已经加入 gitee 组织，且有权限管理 gitee-ent-view 包
- 已用 `npm login` 命令登录了这个账号
- 测试无问题

之后在命令行中运行：

``` bash
# 创建 beta 预发行版
npm run release-beta

# 发布测试版
npm publish --tag=beta

# 创建正式发行版
npm run release

# 发布正式版
npm publish
```

主仓库：

```bash
# 安装刚刚发布的测试版
npm install gitee-ent-view@beta

# 或者安装最新正式版
npm install gitee-ent-view@latest

# 构建资源
npm run build
```

## 规范

### 目录结构

- **`dist`**: 包含用于发布的已构建的资源文件
- **`scripts`**: 包含一些构建相关的脚本
- **`src`**: 包含源码
    - **`lib`**: 包含公共类库源码
    - **`mixins`**: 包含组件通用混入方法的源码
    - **`components`**: 包含通用组件源码
    - **`pages`**: 包含各个页面的源码

### 文件命名规范

- **js 文件**：属于类的.js文件，除 index.js 外，使用单词大写开头 (PascalBase) 风格。其他类型的 .js 文件则使用横线连接 (kebab-case) 风格。
- **vue 文件**：使用单词大写开头 (PascalCase) 风格，详细规范可参考：[Vue 风格指南](https://cn.vuejs.org/v2/style-guide/index.html#%E5%8D%95%E6%96%87%E4%BB%B6%E7%BB%84%E4%BB%B6%E6%96%87%E4%BB%B6%E7%9A%84%E5%A4%A7%E5%B0%8F%E5%86%99-%E5%BC%BA%E7%83%88%E6%8E%A8%E8%8D%90)

### JavaScript 规范

遵循码云前端的 [ESLint](https://gitee.com/mayun-team/eslint-config-gitee) 即可。

### 提交信息规范

参考[Git 提交信息规范](COMMIT_CONVENTION.md)文档。

### 开发流程规范

1. 基于 master 创建一个新分支，然后在该分支上开发
1. 开发完后，向 master 分支提交 Pull Request
1. 当 Pull Request 被合并后，由管理员打包发布测试版本
1. 在主仓库中安装这一测试版本，本地测试无问题后再按主仓库的开发流程提交 Pull Request
1. 如果测试版本还存在问题，需要继续修改，请重复上述流程

上线后的处理：

- **出现小问题**：重复上述流程即可
- **出现严重问题且无法快速修复**：回退主仓库中涉及 gitee-ent 版本更新的所有 Pull Requests
- **一切正常**：第二天由管理员发布稳定版本，并向主仓库提交 Pull Request

### 私有化版本开发流程

- 新建一个分支作为私有化版本的主干分支，例如：premium
- 对比 master 分支差异，选取需要的改动合并进 premium 分支
- 为私有化版本分配版本号，以与线上使用的版本区分开来，例如从 4.0.0 版本开始
- 更新版本号并构建用于发行的资源：`npm version 4.x.x -m "chore(release): 4.x.x"`
- 发布包并标记该版本为码云私有化版本的专用版 (premium)：`npm publish --tag=premium`
- 在私有化版本的码云仓库中安装刚刚发布的包：`npm install gitee-ent-view@premium`

**注意：** 初次切换到使用 gitee-ent-view 时，请对比线上版本差异，然后在私有化版本分支上做相应的调整，后续更新只需要对比此仓库的 master 分支的差异。

### 版本号

版本号应该遵循[语义化版本控制规范](https://semver.org/lang/zh-CN/)，格式为：`1.x.x-beta.x`。每当发布新版本时，应该先发布 beta 版本，等上线测试无问题后再更新为正式版。如果当天有多次更新，则应该只递增 beta 后面的编号。

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