前言
编写开源软件的时候,我们经常会发现国外的项目中一大堆 .
开头的文件,比如
- .tsconfig
- .gitignore
- ….
接下来,我们就慢慢熟悉和掌握这些配置文件(不仅仅是 .
开头,还有普通文件名的),让我们的姿势涨起来。
细则
.flowconfig
JavaScript , 类型检测
flow 是由 facebook 开源的一个 JavaScript 静态检测工具。就是因为 JavaScript 太灵活了,又是弱类型语言,所以如果使用不当,会出现一些莫名其妙的故障。
.flowconfig
就是它的项目级配置文件
Github : https://github.com/facebook/flow
参考 : flow——A static type checker for javascript
.gitignore
Git
此文件是配合 Git 使用的,用于指定需要被排除于源代码管理之外的文件
.gitmodules
Git
此文件是配合 Git 使用的,用于设置子模块。
关于子模块的介绍,参照:
[Git].gitmodules跟.git/config两个配置文件的区别
Git Book中文版 - 子模块
Git 官方关于子模块的文档
.jscs.json
jscs
是一个 js 代码风格检查器,目前已经和 eslint
合并
官网 : http://jscs.info/
相关介绍 : JavaScript代码风格检查器:node-jscs
.jshintrc
jshint
是一个自动对 js 代码进行语法和格式检查的工具,类似于前面的 jscs
,如何取舍,可以参考这篇文章。
官网 : http://jshint.com/
Github : https://github.com/jshint/jshint
.npmignore
npm
是 Node.JS 生态的包管理器。而 .npmignore
配置了发布 npm 包的时候需要被排除在外的部分文件。
参考文章 : Node魔法堂:NPM入了个门
.travis.yml
Travis CI
是一个被社区广泛采用的云构建测试平台,用于进行软件的持续集成构建测试,自动的检查提交的pull request构建是否存在问题。
官方网站 : https://travis-ci.org/
Github : https://github.com/travis-ci
中文教程 :
Makefile
Makefile
常见于 Linux 、或开源的软件开发,不像 Windows 中的 IDE ,由于很多开源软件没有良好的集成开发环境,所以需要有一个文件来描述项目的编译顺序,构建逻辑。 Makefile
就是这样的一个工具。
参考文献:
bower.json
Bower
是一个类似于 npm
的包管理工具,但是,它的局限性更大,局限于 web
的包管理。
Github : https://github.com/bower/bower
package.json
package.json
是著名包管理工具 npm
的配置文件,里面配置有
- 包名
- 版本
- Git库
- 维护者
- Issue地址
- 包依赖(dependencies)
- 开发依赖(devDependencies)
- 自动化指令脚本等等
参考链接