README

确保文件符合 .editorconfig 文件设置。

工作原理

使用 editorconfig-checker/editorconfig-checker 来验证您的文件是否遵循在 .editorconfig 文件中定义的规则。

使用方法

将包添加到您的 composer.json 文件

composer require --dev pnnl/editorconfig

将扩展添加到您的 grumphp.yml 文件

#grumphp.yml
parameters:
  extensions:
    - Pnnl\EditorConfig\Extension\Loader

添加并配置以下“参数”部分中定义的任务。

参数

#grumphp.yml
parameters:
  tasks:
    editorconfig:
      auto_fix: false
      dotfiles: false
      ignore_defaults: false
      ignore_patterns: []
      list_files: false
      triggered_by: []

auto_fix

默认：false

将自动修复可修复的问题（插入_final_newline、end_of_line、trim_trailing_whitespace、tabs to spaces）。有关自动修复文件的存储位置，请参阅README。

dotfiles

默认：false

如果您想排除隐藏文件，请使用此标志。

ignore_defaults

默认：false

将忽略默认排除项，有关详细信息，请参阅README。

ignore_patterns

默认：[]

字符串或正则表达式，用于过滤不应检查的文件。

示例

parameters:
  tasks:
    editorconfig:
      ignored_patterns:
        - '.(yml|yaml)' # ignore all files ending in yml or yaml
        - '.json' # ignore all files ending in json
        - 'tests/' # ignore all files in the tests folder

list_files

默认：false

将打印所有检查过的文件到标准输出（如果有错误才会输出）。

triggered_by

默认：[]

这是应检查的扩展名列表。留空表示所有扩展名。

示例

parameters:
  tasks:
    editorconfig:
      triggered_by:
        - yml
        - yaml
        - json
        - php

免责声明

本文档是根据美国政府机构资助的工作准备的。美国政府、美国能源部、Battelle、其雇员、任何参与这些材料开发的司法管辖区或组织均不对信息的准确性、完整性或有用性做出任何明示或暗示的保证，也不承担任何法律责任或责任，包括但不限于信息、设备、产品、软件或过程披露的准确性、完整性或有用性，或者表示其使用不会侵犯私有权利。

本文档中提到的任何特定商业产品、流程或服务，无论通过贸易名称、商标、制造商还是其他方式，均不构成或暗示美国政府的认可、推荐或偏袒，也不代表美国政府的任何机构或Battelle纪念研究所的观点和意见。

太平洋西北国家实验室
由
BATTELLE
为
美国能源部
根据合同 DE-AC05-76RL01830 运营