mileschou/codegener

代码生成辅助工具。

v2.2.0 2024-08-03 02:56 UTC

This package is auto-updated.

Last update: 2024-09-03 03:12:59 UTC


README

tests codecov Codacy Badge Latest Stable Version Total Downloads License Beerpay

代码生成辅助工具。

概念

有时,我们需要生成大量的代码,例如 脚手架编译代码,甚至是文档。

此包可以帮助我们轻松编写代码。

使用方法

Writer 类需要 Laravel Filesystem,它是可测试的,并且需要实现 PSR-3 日志接口。

public function __construct(Filesystem $filesystem, LoggerInterface $logger)

使用 write() 方法立即写入代码。当 $overwrite 为 true 时,Codegener 将会覆盖。

public function write(string $path, $content, bool $overwrite = false): void

如果需要生成大量代码,请使用 writeMass

public function writeMass(iterable $contents, bool $overwrite = false): void

特性

以下特性是处理环境和路径的辅助工具。

示例

以下是一个示例代码。

$writer->setBasePath('/path/to/your/project');

$code = [
    'some-foo' => 'foo',
    'some-bar' => 'bar',
];

$writer->writeMass($code);

Codegener 将生成两个文件。

$ cat /path/to/your/project/some-foo
foo
$ cat /path/to/your/project/some-bar
bar

示例项目

许可证

MIT 许可证(MIT)。请参阅 许可证文件 了解更多信息。