@apdesign/code-style-react 1.2.3 → 2.0.0

package/biome.jsonc

@@ -0,0 +1,99 @@
+{
+  "$schema": "https://biomejs.dev/schemas/2.2.6/schema.json",
+  "extends": ["ultracite"],
+  "formatter": {
+    "enabled": true,
+    "indentStyle": "space",
+    "indentWidth": 2,
+    "lineWidth": 100
+  },
+  "javascript": {
+    "formatter": {
+      "quoteStyle": "single",
+      "semicolons": "always",
+      "trailingCommas": "all",
+      "bracketSpacing": true,
+      "arrowParentheses": "always"
+    }
+  },
+  "json": {
+    "formatter": {
+      "trailingCommas": "none"
+    }
+  },
+  "linter": {
+    "enabled": true,
+    "rules": {
+      "recommended": false,
+      "a11y": {
+        "noNoninteractiveElementInteractions": "off",
+        "noStaticElementInteractions": "off",
+        "useKeyWithClickEvents": "off"
+      },
+      "complexity": {
+        "noBannedTypes": "error",
+        "noUselessConstructor": "error",
+        "noUselessFragments": "off",
+        "noUselessTypeConstraint": "error",
+        "noForEach": "off"
+      },
+      "correctness": {
+        "noPrecisionLoss": "error",
+        "noUndeclaredVariables": "off",
+        "noUnusedVariables": "warn",
+        "useExhaustiveDependencies": "off"
+      },
+      "style": {
+        "noNamespace": "error",
+        "noParameterAssign": "warn",
+        "useArrayLiterals": "error",
+        "useAsConstAssertion": "error",
+        "useBlockStatements": "off",
+        "useNamingConvention": "off",
+        "useTemplate": "warn",
+        "useFilenamingConvention": "off"
+      },
+      "suspicious": {
+        "noEmptyBlockStatements": "error",
+        "noExplicitAny": "warn",
+        "noExtraNonNullAssertion": "error",
+        "noMisleadingInstantiator": "error",
+        "noUnsafeDeclarationMerging": "error",
+        "noArrayIndexKey": "warn",
+        "noShadowRestrictedNames": "warn",
+        "noConsole": "off"
+      }
+    }
+  },
+  "files": {
+    "includes": [
+      "**/*.js",
+      "**/*.jsx",
+      "**/*.ts",
+      "**/*.tsx",
+      "**/*.json",
+      "**/*.jsonc"
+    ],
+    "experimentalScannerIgnores": [
+      "**/dist/**",
+      "**/node_modules/**",
+      "**/*.d.ts",
+      "**/mock/**",
+      "**/.eslintrc.cjs",
+      "**/build/**",
+      "**/coverage/**"
+    ]
+  },
+  "overrides": [
+    {
+      "includes": ["scripts/runEslint.js", "scripts/runStylelint.js"],
+      "linter": {
+        "rules": {
+          "complexity": {
+            "noExcessiveCognitiveComplexity": "off"
+          }
+        }
+      }
+    }
+  ]
+}

package/cli.js

@@ -1,15 +1,49 @@
-#!/usr/bin/env node
-
-const main = require('./index');
-
-const args = process.argv.slice(2);
-const command = args[0];
-
-if (command === 'init') {
-  main();
-} else if (command === 'eslint') {
-  const runEslint = require('./scripts/runEslint');
-  runEslint(args.slice(1));
-} else {
-  console.log(`Unknown command: "${command}"`);
-}
+#!/usr/bin/env node
+
+const main = require('./index');
+const { execSync } = require('node:child_process');
+
+const args = process.argv.slice(2);
+const command = args[0];
+
+if (command === 'init') {
+  main();
+} else if (command === 'fix') {
+  // 运行 ultracite fix
+  try {
+    execSync('npx ultracite fix', { stdio: 'inherit' });
+  } catch (_error) {
+    process.exit(1);
+  }
+} else if (command === 'check') {
+  // 运行 ultracite check
+  try {
+    execSync('npx ultracite check', { stdio: 'inherit' });
+  } catch (_error) {
+    process.exit(1);
+  }
+} else if (command === 'eslint') {
+  // 保留向后兼容的 eslint 命令
+  const runEslint = require('./scripts/runEslint');
+  runEslint(args.slice(1));
+} else if (command === 'stylelint') {
+  // 保留 stylelint 命令
+  const runStylelint = require('./scripts/runStylelint');
+  runStylelint(args.slice(1));
+} else {
+  console.log(`
+Usage: apdesign-code-style <command>
+
+Commands:
+  init         初始化配置文件（Biome, Stylelint, Husky）
+  fix          格式化并自动修复代码问题（使用 Ultracite）
+  check        检查代码问题但不修复（使用 Ultracite）
+  stylelint    运行 Stylelint 检查样式文件
+  eslint       [已废弃] 运行 ESLint（建议使用 fix 或 check）
+
+Example:
+  apdesign-code-style init
+  apdesign-code-style fix
+  apdesign-code-style check
+`);
+}

package/index.js

@@ -1,13 +1,13 @@
-#!/usr/bin/env node
-
-const initHusky = require('./scripts/initHusky');
-const initScripts = require('./scripts/initScripts');
-const initConfigs = require('./scripts/initConfigs');
-
-function main() {
-  initHusky();
-  initScripts();
-  initConfigs();
-}
-
-module.exports = main;
+#!/usr/bin/env node
+
+const initHusky = require('./scripts/initHusky');
+const initScripts = require('./scripts/initScripts');
+const initConfigs = require('./scripts/initConfigs');
+
+function main() {
+  initHusky();
+  initScripts();
+  initConfigs();
+}
+
+module.exports = main;

package/lefthook.yml

@@ -0,0 +1,19 @@
+pre-commit:
+  parallel: true
+  commands:
+    # 使用 lint-staged 来运行 Ultracite，会自动处理暂存的文件
+    lint-staged:
+      run: npx lint-staged
+
+pre-push:
+  parallel: true
+  commands:
+    # 在 push 前检查代码质量
+    biome-check:
+      glob: "*.{js,jsx,ts,tsx,json,jsonc}"
+      run: npx ultracite check {staged_files}
+    
+    # 检查样式文件
+    stylelint-check:
+      glob: "*.{css,scss,less}"
+      run: npx stylelint {staged_files}

package/package.json

@@ -1,45 +1,67 @@
-{
-  "name": "@apdesign/code-style-react",
-  "version": "1.2.3",
-  "scripts": {},
-  "bin": {
-    "apdesign-code-style": "cli.js"
-  },
-  "files": [
-    "index.js",
-    ".prettierrc.js",
-    "eslint",
-    "stylelint",
-    "husky",
-    "scripts"
-  ],
-  "keywords": [],
-  "author": "",
-  "license": "ISC",
-  "description": "",
-  "dependencies": {
-    "@types/glob": "^8.1.0",
-    "@typescript-eslint/eslint-plugin": "^6.21.0",
-    "@typescript-eslint/parser": "^6.21.0",
-    "css-color-names": "^1.0.1",
-    "eslint": "^8.57.1",
-    "eslint-config-airbnb": "^19.0.4",
-    "eslint-config-prettier": "^9.1.0",
-    "eslint-import-resolver-alias": "^1.1.2",
-    "eslint-plugin-import": "^2.31.0",
-    "eslint-plugin-jsx-a11y": "^6.10.2",
-    "eslint-plugin-prettier": "^5.2.1",
-    "eslint-plugin-react": "^7.37.2",
-    "eslint-plugin-react-hooks": "^4.6.2",
-    "glob": "^11.0.3",
-    "husky": "^9.1.7",
-    "lint-staged": "^15.3.0",
-    "postcss-less": "^6.0.0",
-    "postcss-scss": "^4.0.9",
-    "prettier": "^3.3.3",
-    "stylelint": "^16.19.1",
-    "stylelint-config-standard": "^38.0.0",
-    "stylelint-less": "^3.0.1",
-    "stylelint-scss": "^6.12.0"
-  }
-}
+{
+  "name": "@apdesign/code-style-react",
+  "version": "2.0.0",
+  "description": "基于 Ultracite (Biome) 的现代化前端代码规范工具集，专为 React/TypeScript 项目设计",
+  "keywords": [
+    "biome",
+    "ultracite",
+    "code-style",
+    "linter",
+    "formatter",
+    "react",
+    "typescript",
+    "eslint",
+    "prettier",
+    "stylelint",
+    "code-quality"
+  ],
+  "author": "apdesign",
+  "license": "ISC",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/apdesign/code-style-react.git"
+  },
+  "bugs": {
+    "url": "https://github.com/apdesign/code-style-react/issues"
+  },
+  "homepage": "https://github.com/apdesign/code-style-react#readme",
+  "scripts": {
+    "prepublishOnly": "npx @biomejs/biome check ."
+  },
+  "bin": {
+    "apdesign-code-style": "cli.js"
+  },
+  "files": [
+    "index.js",
+    "cli.js",
+    ".prettierrc.js",
+    "biome.jsonc",
+    "lefthook.yml",
+    "stylelint",
+    "husky",
+    "scripts",
+    "README.md",
+    "CHANGELOG.md",
+    "MIGRATION.md"
+  ],
+  "dependencies": {
+    "@biomejs/biome": "^2.2.6",
+    "css-color-names": "^1.0.1",
+    "husky": "^9.1.7",
+    "lefthook": "^1.12.4",
+    "lint-staged": "^16.1.6",
+    "postcss-less": "^6.0.0",
+    "postcss-scss": "^4.0.9",
+    "prettier": "^3.3.3",
+    "stylelint": "^16.19.1",
+    "stylelint-config-standard": "^38.0.0",
+    "stylelint-less": "^3.0.1",
+    "stylelint-scss": "^6.12.0",
+    "ultracite": "^5.6.2"
+  },
+  "lint-staged": {
+    "*.{js,jsx,ts,tsx,json,jsonc,css,scss,md,mdx}": [
+      "npx ultracite fix"
+    ]
+  }
+}

package/scripts/buildEslint.sh

@@ -1,60 +1,60 @@
-#!/usr/bin/env sh
-echo "🔍 Starting ESLint check (Git diff files only)..."
-
-# 切换到 Git 仓库根目录
-PROJECT_ROOT=$(git rev-parse --show-toplevel)
-cd "$PROJECT_ROOT" || exit 1
-
-# 参数：commitId（必填），路径（可选）
-TARGET_COMMIT=$1
-LATEST_COMMIT=$(git rev-parse HEAD)
-
-if [ -z "$TARGET_COMMIT" ]; then
-  echo "❗ Error: Missing target commit ID."
-  echo "👉 Usage: $0 <target-commit-id> [project-path]"
-  exit 1
-fi
-
-echo "获取到上一次运行commit ID: $TARGET_COMMIT"
-echo "获取到当前最新的commit ID: $LATEST_COMMIT"
-
-# 处理路径参数
-if [ -n "$FULL_PATH" ]; then
-  PROJECT_NAME=$(basename "$FULL_PATH")
-  echo "📂 检测子项目: $PROJECT_NAME"
-  DIFF_FILES=$(git diff --name-only "$TARGET_COMMIT" "$LATEST_COMMIT" -- "*/$PROJECT_NAME/*.{ts,tsx,js,jsx}")
-else
-  DIFF_FILES=$(git diff --name-only "$TARGET_COMMIT" "$LATEST_COMMIT" -- '*.ts' '*.tsx' '*.js' '*.jsx')
-fi
-
-if [ -z "$DIFF_FILES" ]; then
-  echo "✅ No matching file changes detected, skipping ESLint check"
-  exit 0
-fi
-
-echo "📂 Changed files:"
-echo "$DIFF_FILES"
-
-FILE_COUNT=$(echo "$DIFF_FILES" | wc -l)
-echo "🧾 Total changed files: $FILE_COUNT"
-
-ESLINT_CONFIG_FILE="$PROJECT_ROOT/.eslintrc.build.cjs"
-
-ESLINT_CMD_ARGS="--no-error-on-unmatched-pattern --report-unused-disable-directives"
-
-if [ -f "$ESLINT_CONFIG_FILE" ]; then
-  echo "🔧 Using ESLint config file: $ESLINT_CONFIG_FILE"
-  ESLINT_CMD_ARGS="--config $ESLINT_CONFIG_FILE $ESLINT_CMD_ARGS"
-else
-  echo "⚠️ ESLint config file not found, using default ESLint config resolution."
-fi
-
-echo "$DIFF_FILES" | tr -d '\r' | \
-  xargs -d '\n' -P 4 -n 30 npx --no-install eslint $ESLINT_CMD_ARGS
-
-if [ $? -ne 0 ]; then
-  echo "❌ ESLint check failed. Aborting build process"
-  exit 1
-fi
-
+#!/usr/bin/env sh
+echo "🔍 Starting ESLint check (Git diff files only)..."
+
+# 切换到 Git 仓库根目录
+PROJECT_ROOT=$(git rev-parse --show-toplevel)
+cd "$PROJECT_ROOT" || exit 1
+
+# 参数：commitId（必填），路径（可选）
+TARGET_COMMIT=$1
+LATEST_COMMIT=$(git rev-parse HEAD)
+
+if [ -z "$TARGET_COMMIT" ]; then
+  echo "❗ Error: Missing target commit ID."
+  echo "👉 Usage: $0 <target-commit-id> [project-path]"
+  exit 1
+fi
+
+echo "获取到上一次运行commit ID: $TARGET_COMMIT"
+echo "获取到当前最新的commit ID: $LATEST_COMMIT"
+
+# 处理路径参数
+if [ -n "$FULL_PATH" ]; then
+  PROJECT_NAME=$(basename "$FULL_PATH")
+  echo "📂 检测子项目: $PROJECT_NAME"
+  DIFF_FILES=$(git diff --name-only "$TARGET_COMMIT" "$LATEST_COMMIT" -- "*/$PROJECT_NAME/*.{ts,tsx,js,jsx}")
+else
+  DIFF_FILES=$(git diff --name-only "$TARGET_COMMIT" "$LATEST_COMMIT" -- '*.ts' '*.tsx' '*.js' '*.jsx')
+fi
+
+if [ -z "$DIFF_FILES" ]; then
+  echo "✅ No matching file changes detected, skipping ESLint check"
+  exit 0
+fi
+
+echo "📂 Changed files:"
+echo "$DIFF_FILES"
+
+FILE_COUNT=$(echo "$DIFF_FILES" | wc -l)
+echo "🧾 Total changed files: $FILE_COUNT"
+
+ESLINT_CONFIG_FILE="$PROJECT_ROOT/.eslintrc.build.cjs"
+
+ESLINT_CMD_ARGS="--no-error-on-unmatched-pattern --report-unused-disable-directives"
+
+if [ -f "$ESLINT_CONFIG_FILE" ]; then
+  echo "🔧 Using ESLint config file: $ESLINT_CONFIG_FILE"
+  ESLINT_CMD_ARGS="--config $ESLINT_CONFIG_FILE $ESLINT_CMD_ARGS"
+else
+  echo "⚠️ ESLint config file not found, using default ESLint config resolution."
+fi
+
+echo "$DIFF_FILES" | tr -d '\r' | \
+  xargs -d '\n' -P 4 -n 30 npx --no-install eslint $ESLINT_CMD_ARGS
+
+if [ $? -ne 0 ]; then
+  echo "❌ ESLint check failed. Aborting build process"
+  exit 1
+fi
+
 echo "✅ ESLint check passed"

package/scripts/initConfigs.js

@@ -1,98 +1,121 @@
-#!/usr/bin/env node
-
-const fs = require('fs');
-const path = require('path');
-
-function fileExists(filepath) {
-  try {
-    return fs.existsSync(filepath);
-  } catch (err) {
-    console.error(`❌ Check whether there are any errors in the file: ${filepath}`, err);
-    return false;
-  }
-}
-
-function createIfNotExists(filename, content) {
-  const filepath = path.resolve(process.cwd(), filename);
-  try {
-    if (!fs.existsSync(filepath)) {
-      fs.writeFileSync(filepath, content, { encoding: 'utf-8' });
-      console.log(`✅ The ${filename} has been created`);
-    }
-  } catch (err) {
-    console.error(`❌ Failed to create the file: ${filename}`, err);
-  }
-}
-
-function hasAnyFileExist(files) {
-  const cwd = process.cwd();
-  return files.some((file) => fileExists(path.join(cwd, file)));
-}
-
-function initConfigs() {
-  const eslintConfigFiles = [
-    '.eslintrc.js',
-    '.eslintrc.cjs',
-    '.eslintrc.json',
-    '.eslintrc.yaml',
-    '.eslintrc.yml',
-    '.eslintrc',
-    'eslint.config.js',
-  ];
-
-  const stylelintConfigFiles = [
-    '.stylelintrc.js',
-    '.stylelintrc.cjs',
-    '.stylelintrc.json',
-    '.stylelintrc.yaml',
-    '.stylelintrc.yml',
-    '.stylelintrc',
-    'stylelint.config.js',
-  ];
-
-  const prettierConfigFiles = [
-    '.prettierrc',
-    '.prettierrc.js',
-    '.prettierrc.cjs',
-    '.prettierrc.json',
-    '.prettierrc.yaml',
-    '.prettierrc.yml',
-    'prettier.config.js',
-  ];
-
-  try {
-    if (!hasAnyFileExist(eslintConfigFiles)) {
-      const eslintContent = `const baseConfig = require('@apdesign/code-style-react/eslint/.eslintrc.js');
-module.exports = {
-  ...baseConfig,
-  rules: {
-    ...baseConfig.rules,
-  },
-};`;
-      createIfNotExists('.eslintrc.cjs', eslintContent);
-    }
-
-    if (!hasAnyFileExist(stylelintConfigFiles)) {
-      const stylelintContent = `const baseConfig = require('@apdesign/code-style-react/stylelint/.stylelintrc.js');
-module.exports = {
-  ...baseConfig,
-  rules: {
-    ...baseConfig.rules,
-  },
-};`;
-      createIfNotExists('.stylelintrc.cjs', stylelintContent);
-    }
-
-    if (!hasAnyFileExist(prettierConfigFiles)) {
-      const prettierContent = `const baseConfig = require('@apdesign/code-style-react/.prettierrc.js');
-module.exports = {
-  ...baseConfig
-};`;
-      createIfNotExists('.prettierrc.cjs', prettierContent);
-    }
-  } catch (err) {
-    console.error('❌ Failed to initialize configuration:', err);
-  }
-}
-
-module.exports = initConfigs;
+#!/usr/bin/env node
+
+const fs = require('node:fs');
+const path = require('node:path');
+
+function fileExists(filepath) {
+  try {
+    return fs.existsSync(filepath);
+  } catch (err) {
+    console.error(`❌ Check whether there are any errors in the file: ${filepath}`, err);
+    return false;
+  }
+}
+
+function createIfNotExists(filename, content) {
+  const filepath = path.resolve(process.cwd(), filename);
+  try {
+    if (!fs.existsSync(filepath)) {
+      fs.writeFileSync(filepath, content, { encoding: 'utf-8' });
+      console.log(`✅ The ${filename} has been created`);
+    }
+  } catch (err) {
+    console.error(`❌ Failed to create the file: ${filename}`, err);
+  }
+}
+
+function hasAnyFileExist(files) {
+  const cwd = process.cwd();
+  return files.some((file) => fileExists(path.join(cwd, file)));
+}
+
+function initConfigs() {
+  const biomeConfigFiles = ['biome.json', 'biome.jsonc'];
+
+  const stylelintConfigFiles = [
+    '.stylelintrc.js',
+    '.stylelintrc.cjs',
+    '.stylelintrc.json',
+    '.stylelintrc.yaml',
+    '.stylelintrc.yml',
+    '.stylelintrc',
+    'stylelint.config.js',
+  ];
+
+  const prettierConfigFiles = [
+    '.prettierrc',
+    '.prettierrc.js',
+    '.prettierrc.cjs',
+    '.prettierrc.json',
+    '.prettierrc.yaml',
+    '.prettierrc.yml',
+    'prettier.config.js',
+  ];
+
+  try {
+    // 创建 biome.jsonc 配置（替代 ESLint 和 Prettier）
+    if (!hasAnyFileExist(biomeConfigFiles)) {
+      const biomeContent = `{
+  "$schema": "https://biomejs.dev/schemas/2.2.6/schema.json",
+  "extends": ["@apdesign/code-style-react/biome.jsonc"],
+  "linter": {
+    "rules": {
+      // 在这里添加你的自定义规则
+    }
+  }
+}`;
+      createIfNotExists('biome.jsonc', biomeContent);
+    }
+
+    // 创建 Stylelint 配置
+    if (!hasAnyFileExist(stylelintConfigFiles)) {
+      const stylelintContent = `const baseConfig = require('@apdesign/code-style-react/stylelint/.stylelintrc.js');
+module.exports = {
+  ...baseConfig,
+  rules: {
+    ...baseConfig.rules,
+  },
+};`;
+      createIfNotExists('.stylelintrc.cjs', stylelintContent);
+    }
+
+    // 创建 Prettier 配置（向后兼容）
+    if (!hasAnyFileExist(prettierConfigFiles)) {
+      const prettierContent = `const baseConfig = require('@apdesign/code-style-react/.prettierrc.js');
+module.exports = {
+  ...baseConfig
+};`;
+      createIfNotExists('.prettierrc.cjs', prettierContent);
+    }
+
+    // 创建 lefthook 配置
+    const lefthookConfigPath = path.resolve(process.cwd(), 'lefthook.yml');
+    if (!fs.existsSync(lefthookConfigPath)) {
+      const lefthookContent = `pre-commit:
+  parallel: true
+  commands:
+    lint:
+      glob: "*.{js,jsx,ts,tsx,json,jsonc,css,scss,md,mdx}"
+      run: npx lint-staged
+`;
+      createIfNotExists('lefthook.yml', lefthookContent);
+    }
+
+    // 创建 lint-staged 配置（如果 package.json 中没有）
+    const packageJsonPath = path.resolve(process.cwd(), 'package.json');
+    if (fs.existsSync(packageJsonPath)) {
+      const packageJson = JSON.parse(fs.readFileSync(packageJsonPath, 'utf-8'));
+      if (!packageJson['lint-staged']) {
+        packageJson['lint-staged'] = {
+          '*.{js,jsx,ts,tsx,json,jsonc,css,scss,md,mdx}': ['npx ultracite fix'],
+        };
+        fs.writeFileSync(packageJsonPath, JSON.stringify(packageJson, null, 2), 'utf-8');
+        console.log('✅ lint-staged configuration added to package.json');
+      }
+    }
+  } catch (err) {
+    console.error('❌ Failed to initialize configuration:', err);
+  }
+}
+
+module.exports = initConfigs;