本地/biome-js-bundle

使用Biome.js与Symfony结合

安装: 850

依赖: 0

建议者: 0

安全: 0

星星: 18

观察者: 1

分支: 4

开放问题: 0

类型:symfony-bundle

v1.2.1 2024-09-25 09:31 UTC

This package is auto-updated.

Last update: 2024-09-25 09:31:55 UTC


README

.github/workflows/ci.yaml Packagist Version

此包使您能够在Symfony项目中轻松使用Biome.js,而无需Node.js(例如,当使用Symfony的AssetMapper组件)来检查和格式化您的资产文件。

安装

使用Composer安装包

composer require kocal/biome-js-bundle --dev

包应该已经在您的Symfony应用程序中自动启用(位于config/bundles.php)。如果不是这种情况,您可以手动启用它

// config/bundles.php
return [
    // ...
    Kocal\BiomeJsBundle\KocalBiomeJsBundle::class => ['dev' => true],
];

配置

如果您想使用Biome.js的特定版本,您可以在您的config/packages/kocal_biome_js.yaml中进行配置

when@dev:
    kocal_biome_js:
        version: v1.7.3

配置Biome.js本身,您必须在项目的根目录中创建一个biome.json文件。

对于Symfony项目,建议忽略assets/vendor/vendor/public/bundles/目录下的文件

{
    "files": {
        "ignore": [
            "assets/vendor/*",
            "assets/controllers.json",
            "composer.json",
            "public/assets/*",
            "public/bundles/*",
            "vendor/*"
        ]
    }
}

使用方法

在运行任何biomejs:*命令时,将自动安装最新的Biome.js CLI二进制文件(如果尚未安装)。

biomejs:check

运行格式化器、检查器和导入排序到请求的文件。

# Shows format and lint errors
php bin/console biomejs:check .

# Shows format and lint errors, and fix them if possible
php bin/console biomejs:check . --write

biomejs:ci

CI环境中使用的命令。运行格式化器、检查器和导入排序到请求的文件。

文件不会被修改,该命令是只读操作。

# Shows format and lint errors
php bin/console biomejs:ci .