@milesight/spec

现代化代码规范库，专为 Milesight 项目打造，基于 ESLint 9+ flat config 格式。

English | 简体中文 | 文档

特性

• ✨ 现代化 ESLint 9+ - 最新的 flat config 格式
• 🎯 TypeScript 优先 - 完整的 TypeScript 支持，可选类型检查
• ⚛️ React & Vue - 内置 React、Vue 2/3 支持
• 📦 一体化 - ESLint、Prettier、Commitlint 和 Stylelint
• 🎨 灵活的格式化 - Prettier 或 @stylistic/eslint-plugin
• 🚀 导入排序 - 自动组织导入语句
• 🔧 高度可配置 - 对每条规则进行细粒度控制

快速开始

安装

pnpm add -D @milesight/spec eslint prettier typescript

配置

在项目根目录创建 eslint.config.ts：

import { defineConfig } from '@milesight/spec';

export default defineConfig({
    typescript: true,
    react: true,  // 或 vue: true
    stylistic: 'prettier',
});

使用

# 检查代码
pnpm exec eslint .

# 自动修复问题
pnpm exec eslint . --fix

在 package.json 中添加脚本：

{
    "scripts": {
        "lint": "eslint .",
        "lint:fix": "eslint . --fix",
        "format": "prettier --write \"src/**/*.{ts,tsx,js,jsx,json,md}\""
    }
}

文档

完整文档请访问 https://milesight-iot.github.io/frontend-spec/zh/

• 快速开始
• 配置指南
• 使用示例
• API 参考

贡献

欢迎贡献！请阅读我们的贡献指南了解开发流程。

许可证

MIT © Milesight

链接

• 文档
• GitHub 仓库
• 问题追踪
• 更新日志