README

Venus

一个Laravel包，包含编写代码所需的全部内容，无需考虑编码风格 🚀

动机

我在很多Laravel项目中工作。作为一名前端开发者，我总是需要处理前端栈的安装和编码风格/代码质量问题。

我厌倦了重复做同样的事情。获取我的ESLint配置文件，将它们复制到我的新项目中。获取所有PHP编码风格的东西，将所有内容复制到我的新项目中。安装所有依赖项，等等。

我本可以使用Laravel启动项目，但我更喜欢从头开始使用Laravel安装器命令创建一个全新的Laravel安装。

这就是为什么我创建了 Venus。

Venus - 罗马爱情、美丽、生育、繁荣和欲望的女神 - 是一个 非常有争议的 Laravel包，旨在简化将必要的编码风格工具（如ESLint、Duster和Prettier）集成到新Laravel项目的过程。借助Artisan命令，Venus简化了安装过程，使我所有项目的代码更加整洁和一致。

功能

此包包含以下工具

• ESLint: 一个用于识别和报告ECMAScript/JavaScript代码中发现的模式的工具，旨在使代码更一致并避免错误。
• Duster: 一个用于识别和报告PHP代码中发现的模式的工具，旨在使代码更一致并避免错误。
• Prettier: 一个有争议的代码格式化工具。它通过解析您的代码并使用自己的规则重新打印它来强制执行一致的风格。
• 使用 PostCSS、Tailwind CSS 和 Alpine.js 完成完整的前端栈安装。

安装

您可以通过composer安装此包

composer require manoz/venus --dev

用法

安装包后，您可以通过运行以下Artisan命令来安装工具

安装所有内容

php artisan venus:install --all

npm install

仅安装ESLint

php artisan venus:install --eslint

npm install

仅安装Duster

php artisan venus:install --duster

仅安装Prettier

php artisan venus:install --prettier

npm install

仅安装前端栈

php artisan venus:install --frontend

npm install

别忘了在您的 resources/css/app.css 文件中导入Tailwind CSS

@import "./tailwind.css";

每个工具都将有自己的配置文件和依赖项。所有内容都将为您安装，配置文件也将复制到您的项目中。

请注意：此包将覆盖您现有的ESLint、Duster和Prettier配置文件。
它还将添加npm脚本和包到您的 package.json 文件中。
它还将添加composer脚本到您的 composer.json 文件中。

配置

ESLint

您可以通过编辑项目根目录中的 .eslintrc.js 文件来配置ESLint。更多信息可以在 ESLint 网站 上找到。

Duster

Duster 在幕后有很多操作。
您应该在 Duster 网站 上检查使用方法和选项。

Prettier

您可以通过编辑项目根目录下的 .prettierrc.json 文件来配置 Prettier。更多信息可以在 Prettier 网站 找到。

前端框架

Tailwind CSS 和 Alpine.js 已经配置好了。您可以通过编辑项目根目录下的 tailwind.config.js 文件来扩展 Tailwind 的配置。更多信息可以在 Tailwind CSS 网站 找到。

贡献

感谢您考虑为 Venus 做贡献！贡献指南可以在 此处 找到。

安全漏洞

如果您发现任何与安全相关的问题，请先查阅 安全策略，而不是使用问题跟踪器。

许可协议

遵循 MIT 许可协议，版权 © Manoz。

有关更多信息，请参阅 LICENSE。