Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/xierenyuan/vayne

薇恩基于 vue-cli 的 webpack 通用封装, 更易简单的开始你的项目
https://github.com/xierenyuan/vayne

vayne vue vue-cil webpack

Last synced: 17 days ago
JSON representation

薇恩基于 vue-cli 的 webpack 通用封装, 更易简单的开始你的项目

Host: GitHub
URL: https://github.com/xierenyuan/vayne
Owner: xierenyuan
Created: 2017-11-19T06:06:07.000Z (almost 7 years ago)
Default Branch: dev
Last Pushed: 2018-01-12T07:40:27.000Z (almost 7 years ago)
Last Synced: 2024-10-23T03:11:13.792Z (23 days ago)
Topics: vayne, vue, vue-cil, webpack
Language: JavaScript
Homepage: https://vayne.js.org/
Size: 2.7 MB
Stars: 31
Watchers: 4
Forks: 5
Open Issues: 1
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

        


vayne



  vayne 基于 vue-cli 的 webpack 全局安装的命令行工具, 全局安装依赖，可以省去每个项目安装开发依赖 的麻烦。同时以避免多个项目需同时维护多个webpack 配置的痛苦, 同时会同步vue-cli 的webpack 配置，当有新的配置时只需 升级vayne 即可享受。当然核心是无需在关心繁琐的webpack 配置。几分钟开始你的项目开发



[![npm (scoped)](https://img.shields.io/npm/v/@vayne/cli.svg)](https://www.npmjs.com/package/@vayne/cli)

[![node](https://img.shields.io/node/v/vayne.svg)](https://nodejs.org/en/)

[![GitHub tag](https://img.shields.io/github/tag/xierenyuan/vayne.svg)](https://github.com/xierenyuan/vayne)

[![npm](https://img.shields.io/npm/l/@vayne/cli.svg)](https://www.npmjs.com/package/@vayne/cli)

[![Build Status](https://travis-ci.org/xierenyuan/vayne.svg?branch=develop)](https://travis-ci.org/xierenyuan/vayne)

## 演示



  



## Usage (使用)

```shell

# npm

npm i @vayne/cli -g

# yarn

yarn global add @vayne/cli

yarn add @vayne/cli -D --registry=https://registry.npm.taobao.org

```

### server (本地开发)

```shell

# 指定端口号

vayne serve --port=2000

```

### build （生成环境 打包）

``` shell

vayne build

# View the bundle analyzer report after build finishes

vayne build -r

```

## Like star (喜欢 请star 我😍）

[![GitHub stars](https://img.shields.io/github/stars/xierenyuan/vayne.svg?style=social&label=Stars)](https://github.com/xierenyuan/vayne)

## Documentation (文档)

* [documentation](https://vayne.js.org/) 文档看这里看这里

## Vayne Plugins(插件) [vayne](https://github.com/vaynejs)

* [vayne-plugin-vue](https://github.com/vaynejs/vayne-plugin-vue) 提供Vue 相关配置

* [vayne-plugin-angularjs](https://github.com/vaynejs/vayne-plugin-angularjs) 提供angularjs 相关配置 

* [vayne-plugin-stylelint](https://github.com/vaynejs/vayne-plugin-stylelint) stylelint 强验证 scss 

perset （预设）

* [stylelint-config-vayne](https://github.com/vaynejs/stylelint-config-vayne)

* [eslint-config-vayne](https://github.com/vaynejs/eslint-config-vayne)

* [babel-perset-vayne](https://github.com/vaynejs/babel-preset-vayne)

## Plan(计划)

- [ ] unit(引入了测试 但是keys 还没有编写)

- [x] 插件完善扩展 增加生命周期

- [x] 文档

## Examples (列子)

> 详见  __examples__  默认配置见 __lib/utils/vayne.config.js__ 

## 特性

### 自动重启

配置文件修改的修改会触发 vayne server的自动重启 会触发的文件有

* __.vaynerc__

* __.vaynerc.js__

* 或者 是vayne server --config 后边的文件

## 命令行参数

### vayne

```shell

$ vayne -h

  Usage: vayne [options] [command]

  Options:

    -V, --version  output the version number

    -h, --help     output usage information

  Commands:

    serve [options] [input]  启动开发调试模式.

    build [options] [input]  启动生产模式，生成最终的部署代码.

    help [command]           display help information for a command.

  Run:

  $ vayne help  for more information on specific commands.

  以上所有配置 均可在 vayne 配置文件中配置。

  详情见 http://vayne.js.org/

```

### vayne serve

``` shell

$ vayne serve -h

  Usage: serve [options] [input]

  启动开发调试模式.

  Options:

    -p, --port   设置服务器端口号. 如以在使用会自动往上累加。 默认是 9000

    -H, --host   host .

    -o, --open         在默认浏览器中打开.

    -c, --config       指定配置文件.

    -V, --version      output the version number.

    -h, --help         output usage information               显示帮助信息                                         [布尔]

```

### vayne build

``` shell

$ vayne build -h

  Usage: build [options] [input]

  启动生产模式，生成最终的部署代码.

  Options:

    -r, --report  View the bundle analyzer report after build finishes.

    -c, --config  指定配置文件.

    -h, --help    output usage information                                          [布尔]

```

## other

> 因为node-sass 安装过慢 所以在当前项目移除依赖 需在使用项目根路径手动安装 见

> 国内的小伙伴看这里 值像淘宝源

```shell

# npm 安装

SASS_BINARY_SITE=http://npm.taobao.org/mirrors/node-sass npm install node-sass -D

# yarn 指向淘宝镜像

yarn config set registry https://registry.npm.taobao.org -g

# yarn node-sass 安装

yarn config set sass_binary_site http://cdn.npm.taobao.org/dist/node-sass -g

```

## link

> 感谢这些优秀的开源项目

- [roadhog](https://github.com/sorrycc/roadhog)

- [Vue](https://github.com/vuejs/vue)

- [Vue-cli](https://github.com/vuejs/vue-cli)

- [Webpack](https://github.com/webpack/webpack)

- [POI](https://github.com/egoist/poi)

- [parcel](https://github.com/parcel-bundler/parcel)