diff --git a/README.md b/README.md index 74ffd44..076ece2 100644 --- a/README.md +++ b/README.md @@ -1,24 +1,34 @@ # ccssoft vue组件说明文档 +### 2017/8/24 update +> 增加jshint配置说明 + ### 2017/8/2 update -##### 树组件进行了重构,为了兼容旧版本,旧版树使用方式不变。 -##### 新增了\resource\components\mobile\formComponents\TreePickerAdvance.js -##### 现在表单使用的是新树,可在表单项的config中配置新参数,具体看用例文件 -##### 新树加了两个参数: -##### [已删除]leafOnly:是否只能选中叶子节点,默认为true -##### selectable:是否可以选中该节点,默认值为this.isLeaf(item)  值为一个函数或字符串表达式 -##### multiple:是否可以多选,默认为false +> 树组件进行了重构,为了兼容旧版本,旧版树使用方式不变。 + 新增了\resource\components\mobile\formComponents\TreePickerAdvance.js + 现在表单使用的是新树,可在表单项的config中配置新参数,具体看用例文件 + 新树加了两个参数: + [已删除]leafOnly:是否只能选中叶子节点,默认为true + selectable:是否可以选中该节点,默认值为this.isLeaf(item)  值为一个函数或字符串表达式 + multiple:是否可以多选,默认为false ### 简介 -> ccssoft vue前端开发流使用了vue.js实现界面的组件化,使用vue-router实现了单页式应用,图标采用图标库fontawesome, -> 样式框架以ratchet为基础进行了一些封装 -> 使用了promise库bluebird来实现所有异步操作的统一封装管理(如ajax,原生能力,工单操作等) -> 开发文档地址如下 +> ccssoft vue前端开发流使用了vue.js实现界面的组件化,使用vue-router实现了单页式应用,图标采用图标库fontawesome, 样式框架以ratchet为基础进行了一些封装 +> 使用了promise库bluebird来实现所有异步操作的统一封装管理(如ajax,原生能力,工单操作等) +> 开发文档地址如下 + * [vue 1.2](http://v1-cn.vuejs.org/api/) * [vue-router](https://github.com/vuejs/vue-router/tree/1.0/docs/zh-cn/api) * [fontawesome](http://fontawesome.io/icons/) * [ratchet](http://cnratchet.com/components) -> 前端项目分为通用资源(resource),业务内容(butterfly),大厅应用(shell),大厅管理平台(michael)四个并列文件夹 +### 开发 + +> 前端项目分为通用资源(resource),业务内容(butterfly),大厅应用(shell),大厅管理平台(michael)四个并列文件夹 +> 其中resource为公共资源,由公司统一维护,现场只需要在公共资源的基础上编写业务代码。 + +#### 代码检查 +> 在node环境下,使用jsHint工具对代码进行检查。 +* [jsHint配置说明](jsHint配置说明.md) ### 业务抽象组件 * [工单列表组件](工单列表组件.md) @@ -27,10 +37,8 @@ * [信息查询组件](信息查询组件.md) ### 基础组件 - * [通用表单组件](通用表单组件.md) * [通用信息提示组件](通用信息提示组件.md) * [通用名值对串显示组件](通用名值对串显示组件.md) * 其他组件 - * 工具函数 diff --git a/jsHint配置说明.md b/jsHint配置说明.md new file mode 100644 index 0000000..9b199b2 --- /dev/null +++ b/jsHint配置说明.md @@ -0,0 +1,55 @@ +# jsHint配置说明 + +### 安装依赖资源 +> 使用命令行,切换到node开发环境根目录后,开始顺序执行以下命令: + 将包管理器npm更新到最新版本 + npm install npm@latest -g + 安装任务管理工具grunt + npm install grunt --save + 安装代码检查工具jshint + npm install jsHint --save + 安装grunt的jshint插件 + npm install grunt-contrib-jshint --save + +### 配置jsHint规则 + +> 在开发环境根目录建立文件"Gruntfile.js" +> 内容如下 +> + module.exports = function(grunt){ + grunt.initConfig({ + pkg : grunt.file.readJSON("package.json"), + jshint : { + //要检查的目录和文件列表。!开头表示忽略该规则 + files : [ + "./public/butterfly-hunan/*.js", + "./public/butterfly-hunan/*/*.js", + "!./public/butterfly-hunan/device.js", + "!./public/butterfly-hunan/resource/_device.js", + "!./public/butterfly-hunan/resource/store.min.js" + ], + //具体规则见以下文档 + //http://www.cnblogs.com/tadini/p/5279335.html + options : { + evil : true,//允许使用eval + asi : true,//允许句末省略分号 + lastsemic : false,//允许语句块末省略分号 + expr : true,//允许表达式作为赋值 + sub : true,//允许使用obj["key"]这类方式操作对象 + undef : false,//允许使用不在全局变量列表中的未定义的变量 + quotmark : false, + globals : { + jQuery : true, + console : true, + document : true + }, + } + } + }) + grunt.loadNpmTasks("grunt-contrib-jshint") + grunt.registerTask("test",["jshint"]) + } + +### 启动检查 +> 在nodejs开发环境根目录输入以下命令: + grunt jshint \ No newline at end of file