varavan / hints
此软件包最新版本(v1.1)没有可用的许可信息。
轻松实现知识共享
v1.1
2016-12-12 09:44 UTC
Requires
- symfony/config: ^2.8 | ~3.1
- symfony/console: ^2.8 | ~3.1
- symfony/dependency-injection: ^2.8 | ~3.1
- symfony/yaml: ^2.8 | ~3.1
Requires (Dev)
- phpunit/phpunit: ~5.0
README
这是一个用于在PHP项目中共享知识的微学习工具,无论项目多么复杂。你是否曾经尝试了很长时间都无法修复某个问题,然后有人给你一个小提示,让你几分钟内就解决了?这就是这个项目的目的。它包含一系列可以轻松添加或从终端显示的提示。
示例
安装
使用composer通过 composer require varavan/hints
安装
用法
应用程序有一个入口点,即文件 hints
。安装后,您可以通过 vendor/varavan/hints/hints
调用它。只要这个项目是针对PHP项目实现的,应用程序就是用PHP编写的。
我鼓励您在可执行文件 hints
和您的 bin
文件夹之间创建一个符号链接。这样,就更容易将 hints
包含到您的项目中。
我建议您在 composer
的 post-scripts
中调用 hints
命令,这样每个人都可以在每次供应商更新时刷新这些知识药丸。
请注意,此应用程序的存储是一个名为 hints.json
的文件,它将被版本化。
添加提示 hints add '提示内容'
- 可选的作者元数据 --author '作者名称'
- 可选的标签元数据 --tags '标签,以逗号分隔'
- 可选的指向文件 --file-path '相关内容的文件路径'
- 可选的指向行 --file-line '行号'
列出提示 hints show
- 按标签过滤的选项 --tags '标签'
- 按作者过滤的选项 --author
- 按文件过滤的选项 --file-path
- 设置限制的选项(默认为1) --limit
例如 hints show --author 'Jhon Doe' --tags 'set-up,init' --limit 15
状态
这个库仍在开发中。您可能会在其中发现一些错误。请报告它 :)