@gitopslovers/nx-biome

中文文档
1.5.0发布于 2024/08/09CommonJS零依赖近 30 天下载 1.5万

NX Biome

此软件包已被标记为弃用

Package no longer supported. Contact Support at https://www.npmjs.com/support for more info.

原始使用文档
文档目录5 节
  1. @gitopslovers/nx-biome:configuration generator
  2. Usage
  3. Options
  4. @gitopslovers/nx-biome:biome-lint executor
  5. Options

NX Biome

nx-biome

Nx plugin to use Biome toolchain in your Nx workspace.

Nx peer dependency version Stylelint peer dependency version CI LICENSE npm version npm


🚀 Features

@gitopslovers/nx-biome provides a set of power-ups for Nx to lint, format and analyze your projects with Biome.

  • Executor: Provides some executor to lint, format and analyze your files with Biome.
  • Generators: Helping you to configure your projects.
  • Configuration: Per Project configuration of Biome extending a workspace configuration.
  • Only Affected: Uses Nx to support linting formatting and analyzing only affected projects.
  • Cache: Uses Nx to cache already touched projects.

📦 Installation

using npm

npm i -D @gitopslovers/nx-biome

🛠️ Configuring Biome for a project

To add a Biome configuration to a project you just have to run the @gitopslovers/nx-biome:configuration generator.

nx g @gitopslovers/nx-biome:configuration --project <projectName>

The generator adds a biome.json configuration file at the project root which extends the root biome.json and adds a biome-lint target to the project.

At the first run the generator installs all required dependencies and creates a biome.json file at the workspace root. It also configures the namedInputs for the biome-lint targets.

Examples

Run biome-lint for a project

nx biome-lint {{projectName}}

Run biome-lint for all projects

nx run-many --target=biome-lint

Run biome-lint for affected projects

nx affected --target=biome-lint

📖 Documentation

@gitopslovers/nx-biome:configuration generator

Add Biome configuration to a project.

Usage

Add configuration to a project:

nx g @gitopslovers/nx-biome:configuration --project projectName

Options

OptionValueDescription
projectstringThe name of the project.

@gitopslovers/nx-biome:biome-lint executor

Run Biome linter on a project.

Target Options can be configured in project.json or when the executor is invoked.

See: https://nx.dev/configuration/projectjson#targets

Options

OptionValueDefaultDescription
lintFilePatternsstring[]One or more files/dirs/globs to pass directly to Biome's lint() method.

版本与发布记录

@gitopslovers/nx-biome 共发布 8 个版本,首次发布于 2024/04/11;过去 12 个月发布了 0 个版本。

版本发布日期距今
1.5.0latest2024/08/092 年前
1.4.02024/08/082 年前
1.3.02024/08/082 年前
1.2.32024/04/112 年前
1.2.22024/04/112 年前
1.2.12024/04/112 年前

关于 @gitopslovers/nx-biome 的常见问题

如何安装 @gitopslovers/nx-biome?

在项目目录运行 npm install @gitopslovers/nx-biome,或使用 pnpm add / yarn add / bun add。

@gitopslovers/nx-biome 支持 TypeScript 吗?

该包的 package.json 没有声明类型入口。需要类型提示时,可以在 npm 上查找社区维护的 @types/gitopslovers__nx-biome 是否存在。

@gitopslovers/nx-biome 支持 ESM 还是 CommonJS?

以 CommonJS 形式发布,可以直接 require();在 ES Module 项目中也可以用 import 引入(Node.js 会把 module.exports 作为默认导出)。

@gitopslovers/nx-biome 可以商用吗?

@gitopslovers/nx-biome 使用 未声明 许可。package.json 没有声明许可证。没有许可证的代码默认保留全部权利,商用前请联系作者或查看仓库中的 LICENSE 文件。以上为概括,不构成法律意见,请以许可原文为准。

@gitopslovers/nx-biome 的下载量有多少?

根据 npm 官方下载统计,@gitopslovers/nx-biome 在 2026/10/17 – 2026/11/15 这 30 天内被下载 14,917 次,日均约 497 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@gitopslovers/nx-biome 还在维护吗?

最新版本 1.5.0 发布于 2024/08/09(2 年前);至今共发布 8 个版本,其中过去 12 个月发布了 0 个;首次发布于 2024/04/11。作者已将其标记为弃用,新项目建议寻找替代方案。