# stdlint

**Repository Path**: pandorping/stdlint

## Basic Information

- **Project Name**: stdlint
- **Description**: stdlint

- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-03-30
- **Last Updated**: 2026-06-03

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# web-code-lint

一站式代码规范工具，一键集成：
- ESLint 9（flat config）+ Vue `<template>` + TypeScript
- Prettier（含 `index.html` / `app.html` 排版）
- Stylelint
- Husky + lint-staged + Commitlint
- VSCode 保存自动格式化

支持 **Vue3 / Vite** 与 **Nuxt 3** 业务项目。

## 环境要求

- **Node.js ≥ 20.19**

## 安装

```bash
pnpm add -g web-code-lint
# 或
npm install -g web-code-lint
```

## 在项目中初始化

```bash
npx web-code-lint@latest init
npx web-code-lint@latest init --nuxt
npx web-code-lint@latest init --vue
```

| 选项 | 说明 |
|------|------|
| `--nuxt` | 忽略 `.nuxt` / `.output` / `.data` 等生成与缓存目录、Nuxt 全局变量、放宽 pages 单词组件名 |
| `--vue` | 强制 Vue/Vite 预设（覆盖自动检测） |

若 `package.json` 含 `nuxt` 且未传 `--vue`，自动使用 Nuxt 预设。

## HTML 如何处理

| 文件 | ESLint | Prettier |
|------|--------|----------|
| `.vue` 的 `<template>` | `vue/html-*` 等模板规则 | 经 ESLint + Prettier |
| 根目录 `index.html`、`app.html` | 不校验 | `lint` / `lint:fix` 会格式化 |

不再维护 `@html-eslint`，避免与 Prettier 冲突。业务 UI 规范集中在 Vue SFC 模板中。

## Nuxt 说明

- 已忽略 Nuxt 生成与缓存目录：`.nuxt/`、`.output/`、`.data/`、`.nitro/`、`.cache/`，以及 `.vercel/`、`.netlify/` 等部署产物（`build/` 若含 Vite 等源码需保留 lint，勿整体忽略）
- `init` 会为 pnpm 在 `pnpm-workspace.yaml`（npm / yarn 在 `package.json`）写入传递依赖 `overrides`，消除安装时常见的 deprecated subdependencies 警告
- 已声明常用 Nuxt 自动导入 API
- 若已用 [`@nuxt/eslint`](https://nuxt.com/docs/guide/concepts/code-style#eslint)，注意避免规则重复

## 常用命令

- `lint` / `lint:fix`：由 `scripts/run-lint.mjs` 串联三项工具
- **仅当** ESLint、Stylelint 均为 `0 errors · 0 warnings`，且 Prettier 无待格式化文件时，额外显示「满分」汇总
- **否则** 与原先一致：直接输出 ESLint / Prettier / Stylelint 原生报错（`eslint .` → `prettier --check` → `stylelint`）

## 架构说明（是否专业）

| 做法 | 评价 |
|------|------|
| 去掉 `@html-eslint`，模板规范进 `vue/*` | ✅ 主流 Vue 项目常见；避免与 Prettier 循环 fix |
| 根目录 `index.html` 仅 Prettier | ✅ 与 Vite/Nuxt 脚手架一致，入口页不承担组件级规则 |
| 需要整页 HTML 语义（法务页、邮件模板） | 可单独加 `@html-eslint` 或 HTML 专用子包，不必绑进默认套件 |
| 与 `@nuxt/eslint` 并存 | 约定分工：本套件偏 Stylelint + Prettier + 团队 Vue 规则；Nuxt 官方包管框架自动导入 |

结论：**面向 Vue/Nuxt 业务开发是专业且可维护的**；若团队有大量独立 `.html` 维护场景，再按需扩展即可。

## 从旧版迁移（曾启用 @html-eslint）

1. 用新版 `web-code-lint` 重新 `init`，或同步模板 `eslint.config.mjs`
2. 卸载：`npm uninstall @html-eslint/eslint-plugin`
3. 删除 `webCodeLintOptions.htmlLint` 与所有 `@html-eslint/*` 规则
4. `npm run lint:fix`

## Monorepo 子包

`scripts/ensure-git-hooks.mjs` 会在 `prepare` 时将 `core.hooksPath` 指向子包内 `.husky`。