@buildinams/lint

中文文档
1.0.1发布于 2026/03/04MITESM + CJS构建来源已验证近 30 天下载 2714

BiA's base lint config(s).

原始使用文档
文档目录10 节
  1. Requirements
  2. Installation
  3. ESLint
  4. Bundled plugins
  5. Custom rules
  6. Prettier
  7. Stylelint
  8. VSCode
  9. Migrating from v0.4.x
  10. Contributing

lint

NPM version Actions Status PR Welcome

BiA's base lint config(s).

Requirements

  • Node >=20.19.0 | ESLint >=9.0.0
  • TypeScript >=5.1.0, React >=17.0.0, Prettier >=3.0.0, Stylelint >=16.0.0 — as needed

Uses ESLint flat config. Legacy .eslintrc.* is not supported.

Installation

npm i -D @buildinams/lint eslint prettier stylelint

Drop prettier and/or stylelint if you don't need them.

ESLint

ConfigExport path
JavaScript@buildinams/lint/eslint/javascript
TypeScript@buildinams/lint/eslint/typescript
React@buildinams/lint/eslint/react
React + TypeScript@buildinams/lint/eslint/react-typescript
Next.js@buildinams/lint/eslint/next
Next.js + TypeScript@buildinams/lint/eslint/next-typescript
// eslint.config.mjs
import config from "@buildinams/lint/eslint/next-typescript";
import { globalIgnores } from "eslint/config";

export default [
    ...config,
    globalIgnores([".next/**", "out/**", "build/**"]),
];
CJS
// eslint.config.js
module.exports = [...require("@buildinams/lint/eslint/next-typescript")];

Bundled plugins

unused-imports, simple-import-sort, import-x, prettier (formatting errors as lint errors), react + react-hooks + jsx-a11y (React/Next), @next/eslint-plugin-next (Next), typescript-eslint (TS).

Custom rules

  • Import order: externals → absolute (_, ~ prefixed) → relative
  • type over interface via consistent-type-definitions
  • No enums — use as const instead (only non-auto-fixable rule)
  • No console.log — warn and error allowed
  • React version defaults to 19. Override for older versions:
// eslint.config.mjs
export default [
    ...config,
    { settings: { react: { version: "18" } } },
];

Prettier

// .prettierrc.mjs
export { default } from "@buildinams/lint/prettier";

Trailing commas "all" | Tabs | Double quotes

Formatting errors also surface as ESLint errors via eslint-plugin-prettier.

Stylelint

// .stylelintrc.json
{
    "extends": "@buildinams/lint/stylelint"
}

Extends: standard-scss, css-modules, recess-order, stylelint-prettier. Enables scss/selector-no-redundant-nesting-selector.

Custom SCSS functions
{
    "extends": "@buildinams/lint/stylelint",
    "rules": {
        "scss/function-no-unknown": [true, { "ignoreFunctions": ["px-to-rem"] }]
    }
}

VSCode

Extensions: vscode-eslint, prettier-vscode, vscode-stylelint

// .vscode/settings.json
{
    "editor.formatOnSave": false,
    "editor.defaultFormatter": "esbenp.prettier-vscode",
    "editor.codeActionsOnSave": {
        "source.fixAll.eslint": "explicit",
        "source.fixAll.stylelint": "explicit"
    },
    "scss.validate": false,
    "stylelint.validate": ["scss"]
}

Migrating from v0.4.x

  1. Update to ESLint 9+ and Node 20+
  2. Delete .eslintrc.*
  3. Create eslint.config.mjs (see above)

Pin @buildinams/[email protected] if staying on ESLint 8.

Contributing

Found an issue? Want a new feature? Get involved.

版本与发布记录

@buildinams/lint 共发布 15 个版本,首次发布于 2023/01/19;过去 12 个月发布了 2 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
1.0.1latest2026/03/048 个月前
1.0.02026/03/048 个月前
0.4.32025/02/181.7 年前
0.4.22024/01/162 年前
0.4.12024/01/162 年前
0.4.02024/01/022 年前

关于 @buildinams/lint 的常见问题

@buildinams/lint 是什么?

BiA's base lint config(s).

如何安装 @buildinams/lint?

在项目目录运行 npm install @buildinams/lint,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:eslint(>=9.0.0 <11)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@buildinams/lint 支持 TypeScript 吗?

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

@buildinams/lint 支持 ESM 还是 CommonJS?

同时提供 ES Module 与 CommonJS 入口,import 和 require() 都可以使用,打包工具会自动选择合适的版本。

@buildinams/lint 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=20.19.0。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@buildinams/lint 可以商用吗?

@buildinams/lint 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@buildinams/lint 的下载量有多少?

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

@buildinams/lint 还在维护吗?

最新版本 1.0.1 发布于 2026/03/04(8 个月前);至今共发布 15 个版本,其中过去 12 个月发布了 2 个;首次发布于 2023/01/19。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。