前端项目构建时,一些有用的其他文件。

 阅读约 4 分钟
  1. humans.txt 记录参加该网页设计和建立的相关人员的信息。

       示例:
       /* TEAM */
       开发人员:小火柴
       网站: webhuochai.com
       电子邮件: 121631835@qq.com
    
       /* SITE */
       最后更新: 2017/07/13
       语言: HTML5、CSS3、javascript
    
  2. robots.txt 文件告诉搜索引擎哪些页面可以抓取,哪些页面不能抓取。
  3. .editorconfig 是用来协同团队开发人员之间的代码的风格及样式规范化的默认配置文件。

       示例:
       # 告诉EditorConfig插件,这是根文件,不用继续往上查找
       root = true
    
       # 匹配全部文件
       [*]
       # 结尾换行符,可选"lf"、"cr"、"crlf"
       end_of_line = lf
       # 在文件结尾插入新行
       insert_final_newline = true
       # 删除一行中的前后空格
       trim_trailing_whitespace = true
       # 匹配js和py结尾的文件
       [*.{js,py}]
       # 设置字符集
       charset = utf-8
    
       # 匹配py结尾的文件
       [*.py]
       # 缩进风格,可选"space"、"tab"
       indent_style = space
       # 缩进的空格数
       indent_size = 4
    
       # 以下匹配,类同
       [Makefile]
       indent_style = tab
       # tab的宽度
       tab_width = 4
    
       # 以下匹配,类同
       [lib/**.js]
       indent_style = space
       indent_size = 2
    
       [{package.json,.travis.yml}]
       indent_style = space
       indent_size = 2
    
       注意事项:
       1、如果是windows用户,如果无法创建.editorconfig文件,则需要先创建.editorconfig.文件,系统会自动重命名成.editorconfig文件。
    
       2、EditorConfig的匹配规则是从上往下,即先定义的规则优先级比后定义的优先级要高。
    
       3、插件安装,在GitHub上已经有了各种流行编辑器的插件源代码,可根据说明安装。
    
       4、对于VS Core,对应的插件名是EditorConfig for VS Code。
    
       5、这里列举了VS Code支持的规则:
           indent_style
           indent_size
           tab_width
           end_of_line
           insert_final_newline
           trim_trailing_whitespace
  4. LICENSE.txt 文件记录软件的使用协议 和 服务条款。
  5. README.md 记录一些项目简介,使用方式和相关链接。
  6. CHANGLOG.md 记录项目每个版本更新,说明版本号、更新内容、修复了那些问题。

注:

  1. md为后缀的文件,代表其是使用markdown格式编写的文件。详情请百度。
阅读 161发布于 9月18日
推荐阅读
目录