cytopia/file-lint

file-lint Docker镜像

基于Alpine的Docker镜像，用于对代码文件执行基本的CI检查，基于https://github.com/topics/awesome-ci^[1]。

^{[1] 原始项目: https://github.com/topics/awesome-ci}

可用架构

amd64, i386, arm64, arm/v7, arm/v6

Docker镜像版本

滚动发布版

以下Docker镜像标签为滚动发布版，每晚构建和更新。

时间点发布版

以下Docker镜像标签仅构建一次，可用于可重现的构建。其版本永不更改，因此您需要定期更新管道中的标签以保持最新。

其中<tag>指从此仓库中选择的git标签。

特性

• 空运行（显示所有管道Unix命令，便于学习）
• 基于项目的配置文件（awesome-ci.conf）
• 检查空文件
• 检查带有回车符（\r）的文件
• 检查带有Windows换行符（\r\n）的文件
• 检查带有空字节字符（\x00）的文件
• 检查文件末尾的换行符（恰好一个或多个）
• 检查尾随空格
• 确保文件是UTF8编码
• 确保文件不包含UTF8 BOM（字节顺序标记：U+FEFF）
• 允许自动修复（大多数命令）
• 允许细粒度控制
  • 仅按特定扩展名检查文件
  • 仅按特定shebang检查文件
  • 仅检查二进制或文本文件

工具

_{工具提取自 https://github.com/cytopia/awesome-ci}

Docker挂载

Docker容器内的工作目录是**/data/**，应本地挂载。

使用方法

一般使用

bash
$ docker run --rm -v $(pwd):/data cytopia/file-lint

################################################################################
#                              cytopia/file-lint                               #
#                                 (awesome-ci)                                 #
################################################################################
#                                                                              #
#                                                                              #
# 使用方法:                                                                     #
# -----------------------------------------------------------------------------#
# docker run --rm cytopia/file-lint --help                                     #
# docker run --rm cytopia/file-lint <工具> --help                              #
# docker run --rm cytopia/file-lint <工具> --info                              #
# docker run --rm cytopia/file-lint <工具> --version                           #
#                                                                              #
#                                                                              #
# 可用工具:                                                                    #
# -----------------------------------------------------------------------------#
# file-empty                    扫描文件是否为空                                 #
# file-cr                       扫描文件是否包含回车符 (\r)                     #
# file-crlf                     扫描文件是否包含Windows换行符 (\r\n)            #
# file-nullbyte                 扫描文件是否包含空字节字符 (\x00)               #
# file-trailing-newline         扫描文件是否包含尾随换行符                       #
# file-trailing-single-newline  扫描文件是否包含单个尾随换行符                   #
# file-trailing-space           扫描文件是否包含尾随空格                         #
# file-utf8                     扫描文件是否为utf8编码                          #
# file-utf8-bom                 扫描文件是否包含字节顺序标记                     #
# git-conflicts                 扫描文件是否包含git冲突                         #
#                                                                              #
#                                                                              #
# 示例:                                                                       #
# -----------------------------------------------------------------------------#
# docker run --rm -v $(pwd):/data cytopia/file-lint \                          #
#     lf-crlf --ignore ".git/,.github/" --path .                               #
#                                                                              #
################################################################################

工具使用

以下帮助屏幕取自file-crlf。所有其他工具具有完全相同的功能。

$ docker run --rm cytopia/file-lint file-crlf --help

用法: file-crlf [--text] [--size] [--shebang <参数>] [--extension "tpl,htm,html,php,..."] [--ignore "dir1,dir2"] [--config "conf"] [--confpre "FILE_CRLF_"] [--fix] [--verbose] [--debug] [--dry] [--list] --path <目录>
       file-crlf --info
       file-crlf --help
       file-crlf --version

递归扫描包含CRLF（Windows换行符）的文件。
出现时返回1，否则返回0。

必填参数:

  --path <参数>       指定要扫描的目录。


可选运行参数:
  --fix              可修复 :-)
                     修复指定文件的问题。
                     注意，以下所有其他选项也适用

  --text             限制搜索到仅文本文件（非二进制）。
                     可以与'--extension'进一步缩小范围

  --size             限制搜索到非空文件（大于0字节）。

  --shebang <参数>    仅查找具有此特定shebang的文件（shell脚本）。
                     将此与--text和--size结合使用可加快搜索速度。
                     使用--dry查看如何生成此搜索命令。
                     示例:
                         --shebang bash
                         --shebang php
                         --shebang sh

  --extension <参数>  仅查找匹配这些扩展名的文件。
                     逗号分隔的文件扩展名列表。
                     仅查找匹配这些扩展名的文件。
                     如果未指定或为空，则默认为所有文件。
                     示例:
                         --extension "html,php,inc"
                         --extension php

  --ignore <参数>     逗号分隔的忽略路径列表。
                     目录必须从--path的起始位置指定。
                     示例:
                          在'/var/www'路径内忽略'foor/bar'文件夹:
                         --path /var/www --ignore foo/bar

  --config <参数>     加载配置文件。
                     文件必须包含以下指令:
                         FILE_CRLF_EXTENSION="" # 逗号分隔
                         FILE_CRLF_IGNORE=""    # 逗号分隔
                         FILE_CRLF_TEXT=0|1     # 0或1
                     注意，命令行参数优先于
                     配置文件设置。

  --confpre <参数>    设置自定义配置指令前缀。
                     当前默认值为: 'FILE_CRLF_'.
                     当您希望通过配置文件为每个检查定义不同的默认值时，这很有用。

  --verbose          详细模式，打印正在检查的命令和文件。


  --debug            打印系统消息。


可选训练参数:
  --dry              不执行任何操作，仅显示命令。

  --list             不搜索文件内容，仅显示将由--path、--extension和--ignore找到的文件名


系统参数:
  --info             显示所需命令的版本（对错误报告有用）。
  --help             显示帮助屏幕。
  --version          显示版本信息。


file-crlf是awesome-ci集合的一部分。
https://github.com/cytopia/awesome-ci

配置文件

您还可以在项目中添加名为awesome-ci.conf的配置文件，根据您的喜好进行配置。

bash
#
# Awesome-ci配置文件
#
# 每个工具都有自己的配置部分
# 它们的行为方式相同:
#
#
# 1. 文件扩展名
# ------------------
# 逗号分隔的文件扩展名列表
# 用于缩小要检查的文件范围。
#     <工具名称>_EXTENSION=""
#     <工具名称>_EXTENSION="tpl,html"
#
# 2. 忽略路径
# ----------------
# 逗号分隔的文件路径列表
# 用于缩小要检查的文件范围。
# 注意，这些路径必须从
# --path开始的路径。
#     <工具名称>_IGNORE=""
#     <工具名称>_IGNORE="tmp/log,tmp/run"
#
# 3. 文本文件
# -------------
# 0或1，指定是否仅处理文本文件。
#     <工具名称>_TEXT=0
#     <工具名称>_TEXT=1




#
# 文件检查器
#
# file-cr
FILE_CR_EXTENSION=""
FILE_CR_IGNORE=".git,*.svn"
FILE_CR_TEXT=1
FILE_CR_SIZE=1

# file-crlf
FILE_CRLF_EXTENSION=""
FILE_CRLF_IGNORE=".git,*.svn"
FILE_CRLF_TEXT=1
FILE_CRLF_SIZE=1

# file-empty
FILE_EMPTY_EXTENSION=""
FILE_EMPTY_IGNORE=".git,*.svn"
FILE_EMPTY_TEXT=0
FILE_EMPTY_SIZE=0

# file-nullbyte
FILE_NULLBYTE_EXTENSION=""
FILE_NULLBYTE_IGNORE=".git,*.svn,*.pyc"
FILE_NULLBYTE_TEXT=1
FILE_NULLBYTE_SIZE=1

# file-trailing-newline
FILE_TRAILING_NEWLINE_EXTENSION=""
FILE_TRAILING_NEWLINE_IGNORE=".git,*.svn"
FILE_TRAILING_NEWLINE_TEXT=1
FILE_TRAILING_NEWLINE_SIZE=1

# file-trailing-single-newline
FILE_TRAILING_SINGLE_NEWLINE_EXTENSION=""
FILE_TRAILING_SINGLE_NEWLINE_IGNORE=".git,*.svn"
FILE_TRAILING_SINGLE_NEWLINE_TEXT=1
FILE_TRAILING_SINGLE_NEWLINE_SIZE=1

# file-trailing-space
FILE_TRAILING_SPACE_EXTENSION=""
FILE_TRAILING_SPACE_IGNORE=".git,*.svn"
FILE_TRAILING_SPACE_TEXT=1
FILE_TRAILING_SPACE_SIZE=1

# file-utf8
FILE_UTF8_EXTENSION=""
FILE_UTF8_IGNORE=".git,*.svn"
FILE_UTF8_TEXT=1
FILE_UTF8_SIZE=1

# file-utf8-bom
FILE_UTF8_BOM_EXTENSION=""
FILE_UTF8_BOM_IGNORE=".git,*.svn"
FILE_UTF8_BOM_TEXT=1
FILE_UTF8_BOM_SIZE=1

# git-conflicts
GIT_CONFLICTS_EXTENSION=""
GIT_CONFLICTS_IGNORE=".git,*.svn"
GIT_CONFLICTS_TEXT=1
GIT_CONFLICTS_SIZE=1

相关 https://github.com/topics/awesome-ci 项目

Docker镜像

省去安装大量依赖的麻烦，为您喜爱的linter选择docker化版本，用于可重现的本地或远程CI测试：