Appium源码项目的目录结构分析

.git文件夹

git版本控制工具自带的文件夹，用于存储各个版本的相关信息，每一个git项目都会有该文件，一般处于隐藏状态。

asserts文件夹

资源文件夹，大致是sample-code文件夹里的项目产生的。

bin文件夹

node.js项目的可执行文件配置项。一些放到全局变量的文件存放地址,这样你就可以在命令行下敲这个文件对应的缩写，然后执行该文件。

build文件夹

项目编译后的产物输出目录

ci文件夹

持续集成用的相关文件保存在这个目录中

docs文件夹

项目文档存放目录

lib文件夹

node.js的源码文件夹，类似于java的src文件夹。

node_modules文件夹

node项目默认存放插件的目录

sample-code文件夹

一些样例代码，我们一般可以从该文件的源码中如何学习写case。还有一些样例的app的源代码，包括ios和android平台的。

submodules文件夹

.gitmodules文件中配置的子模块的存放目录，该目录里都是这个项目所需要依赖的一些单独项目。

test 文件夹

测试代码所在文件夹

.appiumconfig.json文件

appium项目配置档文件，里面是一个json字符串，包含的信息有sha校验码和一个版本号

.gitignore文件

git版本管理中用于配置不需要加入版本管理的文件

.gitmodules文件

配置了该项目含有哪些子模块，这些子模块的的存放路径以及下载地址都会在该文件中配置。

.jscsrc文件

gulp相关文件，对gulp中jscs任务中的options属性的配置文件

.jshintignore文件

gulp相关文件。这个文件里面定义了一些路径，可能是用来设置这些路径中文件不接受检查。

.jshintrc文件

gulp相关文件，gulp中有一个JSHint任务，该任务是用来检测你的js代码有没有异常。而该任务需要一些options属性来判断，你可以直接把这些options属性放到Gruntfile.js文件中也可以单独写一个.jshintrc，这就是该文件的作用。

.npmignore文件

package.json相关文件。类似于.gitignore，但是该文件是配合package中files属性使用的，比如你在files中设置了一个目录，但是该目录中某个文件你不想包含在内，那你就可以用 .npmignore配置忽略的文件的。

AUTHORS文件

作者列表

CHANGELOG.txt文件

版本更替说明文档

CONTRIBUTING.md文件

贡献代码须知说明文档

Gruntfile.js文件

grunt插件的配置文件，用来配置grunt任务，说到这里就需要大致了解一下grunt是什麽？从官网了解的，grunt是专门为js设计的构建工具，类似于java中的ant，maven和gradle，看来gradle想提供给node.js插件也不现实了。

grunt-helpers.js文件

包含在Gruntfile.js文件中，把一些操作抽离出来放到该文件中。

gulpfile.js文件

gulp工具的配置文件，gulp也是一个js构建工具。目前来看，grunt应该是利用gulp来完成构建的。

install-beta.md文件

利用npm安装appium应用的beta版本说明文档

install-from-npm.md文件

利用npm安装appium应用说明文档

LICENSE文件

许可声明文件，可忽略。

package.json文件

node.js项目的清单文件，里面配置node.js项目各种属性。比如启动文件，依赖的node模块等等。

README.md文件

markdown语言写成的文档文件，git项目一般都会有这个文件，里面会有一些关于该项目的简单介绍，使用网页版的github时候，会看到项目介绍信息，就是在该文件里面编写的。

RELEASE.pdf文件

该文件一般不会改变，但不是所有git项目都有的啊，这就是一个开源项目需要遵守的一个协议，你要去管理该协议的组织申请一下，等到官方的确认信就ok啦。打开该文件你会发现，其实就是一份邮件的回信，只是说比较官方的回复，说明appium项目拿到了apache的许可，可以发布。可忽略

reset.bat文件

windows上的批处理文件，该文件和下面的reset.sh文件的作用一样，都是用来检测源码环境和安装一些必须的模块。

reset.sh文件

一键搞定源码环境，运行该文件后，它会帮你发现环境中缺少的，有问题的东西，也会帮你安装一些必要的模块。

trigger.txt

web hook的测试文件，可忽略