通过
搜索
搜索jameshalsall / licenser
为您的源代码文件添加许可证头部
0.5.0
2016-05-14 09:49 UTC
Requires
- pimple/pimple: ~3.0
- symfony/console: ~2.8|~3.0
- symfony/finder: ~2.8|~3.0
- twig/twig: ~1.0
Requires (Dev)
- phpunit/phpunit: ~4.6|~5.0
This package is not auto-updated.
Last update: 2024-09-14 14:04:08 UTC
README
自动将许可证头部文档块添加到您的源文件目录。
目前仍在开发中，但将...
- 接受源文件目录或单个源文件路径以进行处理
- 接受包含您自定义许可证文档块的文件路径
- 除非您明确指定，否则不会为在类声明之前有注释的文件添加许可证头部（类文档块是可以的）
- 可以检查您的源文件以获取正确的许可证信息
使用方法
- 将
"jameshalsall/licenser":"dev-master"添加到您的composer.json的require-dev - 运行
composer update - 运行
./bin/licenser run /path/to/source/files /path/to/license/file以处理源文件
使用内置许可证类型
Licenser支持以下内置许可证
- Apache 2.0许可证（在Licenser中称为
apache-2.0） - MIT许可证（在Licenser中称为
mit）
要使用这些内置许可证之一，只需将自定义许可证文件路径替换为内置许可证名称。例如，如果您想使用MIT许可证，那么您将运行类似以下命令
./bin/licenser run /path/to/files mit --owners="steve@apple.com tim@apple.com"
内置许可证中的值替换
当使用内置许可证时，Licenser将使用特殊占位符替换自定义值。以下twig占位符值被使用
thisYear（始终替换为当前年份）owner（替换为您通过--owners选项指定的值，或者如果您未指定值，则忽略）
替换现有许可证
您可以通过在运行命令时使用--replace-existing选项来告诉Licenser用新的许可证头部替换现有的许可证头部。这将告诉Licenser删除任何现有的许可证并将它们替换为新生成的许可证。
检查文件以获取正确的许可证
Licenser还允许您检查源文件中的正确许可证信息。如果有任何源文件没有与您提供的选项匹配的许可证头部，它将警告您。
./bin/licenser check /path/to/files mit --owners=steve@apple.com
注意
建议您在运行此工具时将源文件置于版本控制之下，因为它仍然是实验性的并且正在积极开发中。
路线图
添加替换现有许可证的支持（感谢@markwilson）添加内置许可证选项添加dry-run选项，在添加头部之前查看受影响的文件（感谢@unfunco）添加处理单个文件的支持（感谢@jeroensmit）添加自定义许可证文件中的占位符支持（例如年份、所有者等）
错误报告
如果您发现该库有任何问题，请提交一个描述问题的issue，我将努力解决它。