Skip to content

Commit

Permalink
feat: init FrameWork
Browse files Browse the repository at this point in the history
  • Loading branch information
lq782655835 committed Apr 16, 2020
0 parents commit 3bcb0f0
Show file tree
Hide file tree
Showing 176 changed files with 52,573 additions and 0 deletions.
2 changes: 2 additions & 0 deletions .browserslistrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
last 2 versions
not ie <= 11
4 changes: 4 additions & 0 deletions .eslintignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
dist/
node_modules
ts.out/
types/
35 changes: 35 additions & 0 deletions .eslintrc.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
module.exports = {
root: true,
env: {
node: true,
},
settings: {
'import/resolver': {
node: {
extensions: ['.js', '.jsx', '.ts', '.tsx', '.vue'],
},
},
},
extends: [
'plugin:vue/essential',
'@vue/airbnb',
'@vue/typescript',
],
rules: {
'no-param-reassign': 0,
'class-methods-use-this': 0,
'no-underscore-dangle': 0,
'import/no-extraneous-dependencies': 0,
'import/no-unresolved': [
'error',
{
ignore: ['@/'],
},
],
'no-console': ['error', { allow: ['warn', 'error'] }],
'import/extensions': [0],
},
parserOptions: {
parser: '@typescript-eslint/parser',
},
};
13 changes: 13 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
node_modules
.docker
.docs
.rde
.tmp
.vscode/
.idea/
.cache/
dist/
ts.out/
types/
package-lock.json
.history/
1 change: 1 addition & 0 deletions .yarnrc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
registry "http://rnpm.hz.netease.com"
322 changes: 322 additions & 0 deletions CHANGELOG.md

Large diffs are not rendered by default.

107 changes: 107 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,107 @@
## vuele

基于ElementUI上的业务组件库

### Install

``` bash
# 安装
npm i vuele -S

```

### Usage(全局)

``` javascript
import Vue from 'vue';
import ElementUI from 'element-ui'
import 'element-ui/lib/theme-chalk/index.css';
Vue.use(ElementUI)

import vuele from 'vuele';
import 'vuele/dist/vuele.css';

Vue.use(vuele, {
// 传入项目级配置
selectUrl() {
return './test'; // 通用下拉url配置函数,需返回字符串类型
},
resolveCommonReturn(res) {
// 处理通用下拉接口的返回函数,更多使用可参见KSSelectMixin
},
remoteSelectUrl() {
return '/remote'; // 远程搜索下拉组件的通用url配置函数,需返回字符串类型
},
authUrl: '', // 系统级的获取权限接口,更多使用可参见KSAuthMixin文档
unauthorizedUrl: '', // 系统级的无权限页
transferAuthResult() {
// 权限接口返回值的处理函数,更多使用可参见KSAuthMixin文档
}
})
```

### Usage(按需引用)

``` javascript
// mixins在页面级使用
import { listMixin as list } from 'vuele';

export default {
//...
mixins: [list],
//...
}

```

### 注意事项
- vuele组件库依赖elementUI,需单独引入

### 本地开发组件库
本地开发组件库。

``` bash
npm i
# 本地开发命令
npm run serve
# 在src/components目录下根据组件用途分为基础组件和复杂组件,复杂组件主要供物料使用。开发完成需在对应目录index.ts中注册。
# 在__demo__文件夹可以写预览示例。

```

### git commit msg 规范

``` bash
$ git commit -m 'feat: add feature'
```

- feat: 表示新增了一个功能
- fix: 表示修复了一个 bug
- docs: 表示只修改了文档
- style: 表示修改格式、书写错误、空格等不影响代码逻辑的操作
- refactor: 表示修改的代码不是新增功能也不是修改 bug,比如代码重构
- perf: 表示修改了提升性能的代码
- test: 表示修改了测试代码
- build: 表示修改了编译配置文件
- chore: 无 src 或 test 的操作
- revert: 回滚操作

### 可使用npm run cm 提交

``` bash
$ npm run cm
```

### 组件库打包及发布

``` bash
# 发布命令,运行后自动打包
npm publish
```

``` bash
npm i
# 本地开发
npm run docs:dev
# 在 docs目录下rds-components中可书写相关文档
```
1 change: 1 addition & 0 deletions _config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
theme: jekyll-theme-tactile
11 changes: 11 additions & 0 deletions babel.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
module.exports = {
presets: [
'@vue/app',
[
'@vue/babel-preset-jsx',
{
injectH: false,
},
],
],
};
3 changes: 3 additions & 0 deletions commitlint.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
module.exports = {
extends: ['@commitlint/config-conventional'],
};
108 changes: 108 additions & 0 deletions docs/.vuepress/config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,108 @@
module.exports = {
title: 'vuele业务组件库库',
description: 'component lib',
base: '/vuele/',
theme: 'antdocs',
themeConfig: {
repo: 'https://github.com/lq782655835/vuele',
docsRepo: 'https://github.com/lq782655835/vuele',
docsDir: 'docs',
docsBranch: 'master',
nav: [
{ text: '📃首页', link: '/' },
{ text: '📢组件库', link: '/quickstart' },
],
sidebar: [
{
title: '指导',
collapsable: false,
children: [
'quickstart.md',
]
},
{
title: '基础组件',
collapsable: false,
children: [
'base/Clipboard.md',
'base/ImagePreview.md',
'base/OperationLog.md',
'base/DetailHeader.md',
'base/Process.md',
'base/ImportFile.md',
'base/TreeSelect.md',
// 'base/Dialog.md',
]
},
{
title: '指令',
collapsable: false,
children: [
'resource/Int.md',
'resource/StickyFooter.md'
]
},
],
backToTop: true,
ads:{
style: 2,
speed: 2000,
items:[
{
text: 'Ads details here',
image:'https://cn.bing.com/th?id=OHR.LoughriggTarn_ZH-CN1404327665_1920x1080.jpg',
link: 'https://vuepress.vuejs.org/'
},
{
text: 'Ads details here',
image:'https://cn.bing.com/th?id=OHR.MetamorphicRocks_ZH-CN9753251368_1920x1080.jpg',
link: 'https://vuepress.vuejs.org/'
},
{
text: 'Ads details here',
image:'https://cn.bing.com/th?id=OHR.KeichitsuCrocuse_ZH-CN1061292366_1920x1080.jpg',
link: 'https://vuepress.vuejs.org/'
}
]
},
},
plugins: [
'leo-demo-block',
require('./lib')
],
// configureWebpack: {
// plugins: [
// new require('awesome-typescript-loader').TsConfigPathsPlugin({ configFileName: '../../tsconfig.json' })
// ]
// },
chainWebpack: (config, isServer) => {
// 设置scss
function addStyleResource(rule) {
rule
.use("style-resource")
.loader("style-resources-loader")
.options({
patterns: [
require('path').resolve(__dirname, "../../src/styles/mixins/index.scss"),
]
});
}
const types = ["vue-modules", "vue", "normal-modules", "normal"];
types.forEach(type => addStyleResource(config.module.rule("scss").oneOf(type)));

// ts loader rule
config.resolve
.extensions
.prepend('.ts')
.prepend('.tsx')
config.resolve.alias
.set('@', require('path').join(__dirname, '../../src'))

config.module
.rule('ts')
.test(/\.ts$/)
.use('awesome-typescript')
.loader('awesome-typescript-loader')
.end()
}
}
9 changes: 9 additions & 0 deletions docs/.vuepress/lib/enhanceAppFile.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
import ElementUI from 'element-ui'
import 'element-ui/lib/theme-chalk/index.css';

import vuele from '../../../src/index.ts';

export default ({ Vue }) => {
Vue.use(ElementUI)
Vue.use(vuele)
}
3 changes: 3 additions & 0 deletions docs/.vuepress/lib/index.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
module.exports = {
enhanceAppFiles: [require('path').resolve(__dirname, 'enhanceAppFile.js')]
}
1 change: 1 addition & 0 deletions docs/.vuepress/styles/palette.styl
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
$contentWidth = 960px
34 changes: 34 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
home: true
heroImage: https://encrypted-tbn0.gstatic.com/images?q=tbn:ANd9GcR3UJrWOYS_v_r7MoPsAOlHZkrU8yiynHJnLoIIGW_osHxNbLbw
heroText: vuele
tagline: 基于ElementUI业务组件库
actionText: 快速上手 →
actionLink: /quickstart.md
features:
- title: 简洁至上
details: 以 Markdown 为中心的项目结构,以最少的配置帮助你专注于写作。
- title: Vue驱动
details: 享受 Vue + webpack 的开发体验,在 Markdown 中使用 Vue 组件,同时可以使用 Vue 来开发自定义主题。
- title: 高性能
details: VuePress 为每个页面预渲染生成静态的 HTML,同时在页面被加载的时候,将作为 SPA 运行。
footer: MIT Licensed | Copyright © 2018-present springleo
footerColumn: 2
footerWrap:
- headline: Column 1
items:
- title: Item 1
link: https://github.com/zpfz/vuepress-theme-antdocs
details: details
- title: Item 2
link: https://github.com/zpfz/vuepress-theme-antdocs
details: details
- headline: Column 2
items:
- title: Item 1
link: https://github.com/zpfz/vuepress-theme-antdocs
details: details
- title: Item 2
link: https://github.com/zpfz/vuepress-theme-antdocs
details: details
---
11 changes: 11 additions & 0 deletions docs/base/Clipboard.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# clipboard粘贴

:::demo
```vue
<template>
<div>
点击复制<ks-clipboard content="hale" />
</div>
</template>
```
:::
20 changes: 20 additions & 0 deletions docs/base/DetailHeader.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# 审核

:::demo
```vue
<template>
<ks-detail-header
header="多元修复关节 缓解疼痛 汤臣倍健 升级版氨糖软骨素钙片 120片/瓶"
status="待考拉审核"
desc="复杂业务的页面,可以在页面标题下,添加简单文字描述页面功能">
<template slot="operation">
<el-button >审核驳回</el-button>
<el-button type="primary" >审核通过</el-button>
</template>
<template slot="operation-more">
<el-dropdown-item>黄金糕</el-dropdown-item>
</template>
</ks-detail-header>
</template>
```
:::
Loading

0 comments on commit 3bcb0f0

Please sign in to comment.