spatie / code-outliner
生成代码大纲图像
Requires
- php: ^7.1
- spatie/browsershot: ^3.23
- spatie/typed: ^0.1.1
- symfony/console: ^4.1
- symfony/finder: ^4.1
Requires (Dev)
- larapack/dd: ^1.1
- phpunit/phpunit: ^7.2
This package is auto-updated.
Last update: 2024-09-21 18:44:38 UTC
README
创建代码的可视表示
你每天都在阅读代码,代码应该针对这一点进行优化。这个工具可以帮助你可视化项目中的代码外观,这可能会成为更好地组织文件的一个触发点。
有关代码视觉感知的更多信息,请参阅:https://www.stitcher.io/blog/visual-perception-of-code。
支持我们
我们在创建最佳开源包上投入了大量资源。您可以通过购买我们的付费产品之一来支持我们。
我们非常感谢您从家乡寄给我们明信片,注明您正在使用哪个(些)我们的包。您可以在我们的联系页面上找到我们的地址。我们将所有收到的明信片发布在我们的虚拟明信片墙上。
安装
spatie/browsershot是生成图像所必需的。请参阅Browsershot文档以获取所有详细信息,最重要的是安装puppeteer。
npm install puppeteer --global
您可以通过composer安装此包
composer global require spatie/code-outliner
用法
code-outliner <file> [--output=] [--extensions=]
单个文件的概要
将单个文件传递给命令,您将得到如下输出。
覆盖多个文件
将目录路径传递给命令,它将所有文件叠加在一起。较暗的区域表示所有文件中代码较多的区域。
过滤扩展名
默认情况下,将扫描PHP文件。您可以使用--extensions
选项指定其他和多个扩展名。
code-outliner --extensions="html,twig"
安全性
如果您发现了关于安全性的错误,请通过security@spatie.be发送电子邮件,而不是使用问题跟踪器。
明信片软件
您可以使用此包,但如果它进入您的生产环境,我们非常感谢您从家乡寄给我们明信片,注明您正在使用哪个(些)我们的包。
我们的地址是:Spatie,Kruikstraat 22,2018 安特卫普,比利时。
我们将所有收到的明信片发布在我们的公司网站上。
鸣谢
许可证
MIT许可证(MIT)。请参阅许可证文件以获取更多信息。