README

TodoTxt格式的解析器

安装

使用 Composer 将此包作为依赖项安装。

composer require alister/todotxt-parser

欢迎贡献！在为此项目做出贡献之前，请熟悉 CONTRIBUTING.md。

要开发此项目，您需要 PHP 7.4 或更高版本，Composer，Node.js，以及 Yarn。

在本地克隆此存储库后，执行以下命令

cd /path/to/repository
composer install
yarn install

现在，您已经准备好开发了！

此项目使用 Husky 和 lint-staged 在提交之前验证所有待处理的更改。

要查看项目中td命名空间所有可用的Composer命令，请输入

composer list td

如果您想使用Composer命令自动完成，可以使用 bamarni/symfony-console-autocomplete。使用Composer全局安装它

composer global require bamarni/symfony-console-autocomplete

然后，在您的shell配置文件中（通常是~/.bash_profile或~/.zshrc，但可能因设置而异）确保您的全局Composer bin目录在您的PATH中，并评估symfony-autocomplete命令。这看起来像这样

export PATH="$(composer config home)/vendor/bin:$PATH"
eval "$(symfony-autocomplete)"

现在，您可以使用tab键自动完成Composer命令

composer td:[TAB][TAB]

此项目遵循PSR-12编码标准的超集，由PHP_CodeSniffer强制执行。项目的PHP_CodeSniffer配置可以在phpcs.xml.dist中找到。

lint-staged将在提交之前运行PHP_CodeSniffer。它将尝试修复任何错误，如果有任何无法修复的问题，它将拒绝提交。许多问题可以在预提交时自动修复。

您可以使用以下命令使用PHP_CodeSniffer检查整个代码库

# Lint
composer td:lint

# Lint and autofix
composer td:lint:fix

此项目使用PHPStan和Psalm的组合来提供PHP代码的静态分析。这些配置分别位于phpstan.neon.dist和psalm.xml中。

lint-staged将在提交之前运行PHPStan和Psalm。预提交钩子不会尝试修复任何静态分析错误。相反，提交将失败，您必须手动修复错误。

您可以使用以下命令手动在整个代码库上运行静态分析

# Static analysis
composer td:analyze

此项目使用pds/skeleton作为其基本文件夹结构和布局。