README

根据其模式和最佳实践修复和清理composer.json文件的工具。

安装

composer.json fixer 可以全局安装

composer global require kubawerlos/composer-json-fixer

或作为依赖项（例如，将其包含到CI流程中）

composer require --dev kubawerlos/composer-json-fixer

使用

运行并修复

vendor/bin/composer-json-fixer

查看潜在修复的diff

vendor/bin/composer-json-fixer --dry-run

使用composer require升级依赖项

vendor/bin/composer-json-fixer --upgrade

修复器

• composer keys lowercase - 将属性名称转换为小写
• autoload - 修复路径并排序autoload和autoload-dev
• config - 根据键对config进行排序
• keywords - 根据值对keywords进行排序
• license - 如果缺失，则添加license
• minimum stability - 如果具有默认值("stable")，则删除minimum-stability
• name - 将包名转换为小写
• repositories - 对repositories进行排序
• require - 清理require和require-dev的版本
• version - 如果存在，则删除version
• composer keys sorting - 根据文档对属性进行排序

示例

在运行 composer-json-fixer 之前

{
    "name": "JohnDoe/FooBar",
    "version": "v1.0.0",
    "type": "library",
    "description": "A library to do something cool",
    "keywords": [
        "cool",
        "awesome stuff"
    ],
    "require-dev": {
        "phpunit/phpunit": "^5.7 | ^6.5"
    },
    "require": {
        "symfony/finder": "^2.7|^3.4|^4",
        "symfony/yaml": ">= 2.7"
    },
    "minimum-stability": "stable",
    "autoload": {
        "psr-4": {
            "FooBar": "src"
        }
    }
}

之后

{
    "name": "johndoe/foobar",
    "description": "A library to do something cool",
    "type": "library",
    "keywords": [
        "awesome stuff",
        "cool"
    ],
    "license": "proprietary",
    "require": {
        "symfony/finder": "^2.7 || ^3.4 || ^4",
        "symfony/yaml": ">=2.7"
    },
    "require-dev": {
        "phpunit/phpunit": "^5.7 || ^6.5"
    },
    "autoload": {
        "psr-4": {
            "FooBar\\": "src/"
        }
    }
}

退出状态

• 0 - composer.json 文件无需修复
• 1 - composer.json 文件可以或已被修复
• 2 - 抛出异常

贡献

通过创建问题请求功能或报告错误。

或者，复制仓库，开发您的更改，重新生成README.md

src/Readme/run > README.md

确保所有检查都通过

composer check

并提交拉取请求。