README

PHP JSON 简历构建器

一个用于构建JSON 简历的 PHP 库。

JSON 简历是一个由社区驱动的开源项目，旨在创建基于 JSON 的简历标准。

您可以在 GitHub 上创建一个公开的Gist，然后将您的用户名添加到 JSON 简历注册 URL 中，以生成一份精美的简历/简历，例如

https://registry.jsonresume.org/YOUR_GITHUB_USERNAME

不同的主题可在jsonresume.org/themes/找到。

安装

需要 PHP 8.1 或更高版本。

通过 Composer 安装

composer require elliotjreed/json-resume

使用

<?php

require 'vendor/autoload.php';

$resume = (new \ElliotJReed\JsonResume\Entity\Resume())
    ->setBasics((new \ElliotJReed\JsonResume\Entity\Basics()
        ->setName('Elliot Reed'))
    ->setWork((new \ElliotJReed\JsonResume\Entity\Work())
        ->setName('Company Ltd.')
        ->setPosition('Spatula Tester')));

$jsonResume = new \ElliotJReed\JsonResume\JsonResume();

echo $jsonResume->asJson($jsonResume);

PHP 实体与在jsonresume.org/schema找到的 JSON 简历标准相匹配。

开始开发

安装 Composer

有关如何安装 Composer 的说明，请访问getcomposer.org。

安装

在克隆此存储库后，切换到新创建的目录并运行

composer install

或如果您在当前目录中已安装本地 Composer

php composer.phar install

这将安装项目所需的所有依赖项。

从现在起，本 README 的其余部分将假定已全局安装 composer（即，如果您使用 composer.phar，则需要在终端/命令行中使用 composer.phar 而不是 composer）。

运行测试

单元测试

此项目中的单元测试是通过 PHPUnit 进行的。

可以通过执行以下操作运行所有单元测试

composer phpunit

调试

要使 PHPUnit 停止并报告遇到的第一个失败的测试，请运行

composer phpunit:debug

静态分析

静态分析工具可以指出您代码中的潜在“薄弱环节”，并在识别意外副作用方面非常有用。

Psalm 被配置为最高级别，这意味着误报的可能性很大。

可以通过执行以下操作运行静态分析测试

composer static-analysis

代码格式化

在团队中工作时，代码风格的标准很重要，因为它意味着开发者将花费更少的时间来处理他们所阅读的内容（因为一切都将保持一致）。

代码格式化通过 PHP-CS-Fixer 自动化。PHP-CS-Fixer 不会格式化形成 PSR-2 编码标准的行长度，因此这些行在通过 PHP Code Sniffer 检查时将产生警告。

可以通过执行以下操作运行这些

composer phpcs

运行一切

可以通过执行以下操作运行所有测试

composer test

过时的依赖项

可以通过执行以下操作检查过时的 Composer 依赖项

composer outdated

验证 Composer 配置

可以通过执行以下操作检查composer.json 是否有效

composer validate --no-check-publish

通过 GNU Make 运行

如果已安装 GNU Make，则可以用 make 替换上述 composer 命令前缀。

可以通过执行以下操作运行所有测试

make test

在持续集成平台（例如 Github Actions）上运行测试

包含了一些适合CI平台的特定输出格式，作为Composer脚本来使用。

以文本和Clover XML格式输出单元测试覆盖率（可用于Coveralls等服务Coveralls）

composer phpunit:ci

以checkstyle格式输出PHP-CS-Fixer（dry run）和PHPCS结果（GitHub Actions将使用此格式输出可读性更高的格式）

composer phpcs:ci

elliotjreed / json-resume

维护者

详细信息