@lint-spec/cli

lint-spec 是前端编码规范工程化的配套 Lint 工具，可以为项目一键接入规范、一键扫描和修复规范问题，保障项目的编码规范和代码质量。

背景

我们引入了多个业界流行的 Linter，并根据规范内容定制了规则包，它们包括：

| 规范 | Lint 工具 | npm 包 | | ----------------------------------------------------------------- | ---------------------------------------------------------- | -------------------------------------------------------------------------------------------- | | JavaScript 编码规范 TypeScript 编码规范 Node 编码规范 | ESLint | @lint-spec/eslint-config | | CSS 编码规范 | stylelint | @lint-spec/stylelint-config | | Git 规范 | commitlint | @lint-spec/commitlint-config | | 文档规范 | markdownlint | @lint-spec/markdownlint-config |

CLI 使用

安装

npm install @lint-spec/cli -g

使用

lint-spec init：一键接入

在项目根目录执行 lint-spec init，即可一键接入规范。

lint-spec scan：一键扫描

在项目的根目录执行命令，即可扫描项目的规范问题。

支持下列参数：

• -q --quiet 仅报告 error 级别的问题
• -o --output-report 输出扫描出的规范问题日志
• -i --include <dirpath> 指定要进行规范扫描的目录

lint-spec fix：一键修复

在项目的根目录执行命令，即可修复部分规范问题。

Node.js API 使用

安装

npm install @lint-spec/cli --save

API

import { init, scan } from '@lint-spec/cli';

// 初始化
await init({
  cwd: process.cwd(),
  eslintType: 'react',
  enableESLint: true,
  enableStylelint: true,
  enableMarkdownlint: true,
  enablePrettier: true,
});

// 扫描
const results = await scan({
  cwd: process.cwd(),
  include: './src',
  fix: false,
});

配置

lint-spec 会读取执行目录下的 lint-spec.config.js 作为配置文件：

// lint-spec.config.js
export default {
  enableESLint: true,
  enableStylelint: true,
  enableMarkdownlint: true,
  enablePrettier: true,
};

v2.0.0 更新说明

• 升级 ESLint 至 v9，使用 flat config 格式
• 升级 Stylelint 至 v16
• 升级 TypeScript ESLint 至 v8
• 升级 commitlint 至 v19
• 升级 markdownlint 至 v0.37
• 使用 ESM 模块格式
• 移除已废弃的规则，使用 @stylistic/eslint-plugin 替代样式相关规则