@zealakit/css-doctor-cli 0.0.0-stage → 1.0.0

package/README.md

@@ -1,3 +1,42 @@
-# Temporary Holding Version
+<div align="center">
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+# @zealakit/css-doctor-cli
+
+**Command-line diagnostics for CSS files using the native css-doctor engine.**
+
+[English](https://github.com/zealakit/css-doctor/blob/main/packages/cli/README.md) | [Tiếng Việt](https://github.com/zealakit/css-doctor/blob/main/packages/cli/README_VI.md) | [简体中文](https://github.com/zealakit/css-doctor/blob/main/packages/cli/README_CN.md)
+
+</div>
+
+---
+
+![css doctor](https://github.com/zealakit/css-doctor/blob/main/assets/images/css-doctor.jpg)
+
+## Installation
+
+```bash
+pnpm add -D @zealakit/css-doctor-cli
+```
+
+## Usage
+
+```bash
+# Analyze files or quoted globs
+pnpm exec css-doctor check "src/**/*.css"
+
+# Machine-readable CI output
+pnpm exec css-doctor check "src/**/*.css" --json
+
+# Warn when a file has more than 500 selectors
+pnpm exec css-doctor check "src/**/*.css" --threshold 500
+```
+
+## Safety and limitations
+
+- The binary is named css-doctor and is exposed through the package bin field.
+- --json emits a stable CheckReport schema with files, issues, and summary counters.
+- Exit code is non-zero for fatal setup/read/analysis failures; warnings remain visible in the report.
+
+## Full documentation
+
+Project README: [English](https://github.com/zealakit/css-doctor/blob/main/README.md) | [Tiếng Việt](https://github.com/zealakit/css-doctor/blob/main/README_VI.md) | [简体中文](https://github.com/zealakit/css-doctor/blob/main/README_CN.md)

package/README_CN.md

@@ -0,0 +1,42 @@
+<div align="center">
+
+# @zealakit/css-doctor-cli
+
+**使用原生 css-doctor 引擎的命令行 CSS 诊断工具。**
+
+[English](https://github.com/zealakit/css-doctor/blob/main/packages/cli/README.md) | [Tiếng Việt](https://github.com/zealakit/css-doctor/blob/main/packages/cli/README_VI.md) | [简体中文](https://github.com/zealakit/css-doctor/blob/main/packages/cli/README_CN.md)
+
+</div>
+
+---
+
+![css doctor](https://github.com/zealakit/css-doctor/blob/main/assets/images/css-doctor.jpg)
+
+## 安装
+
+```bash
+pnpm add -D @zealakit/css-doctor-cli
+```
+
+## 使用
+
+```bash
+# 分析文件或带引号的 glob
+pnpm exec css-doctor check "src/**/*.css"
+
+# 适用于 CI/CD 的 JSON 输出
+pnpm exec css-doctor check "src/**/*.css" --json
+
+# 当文件 selector 超过 500 时警告
+pnpm exec css-doctor check "src/**/*.css" --threshold 500
+```
+
+## 安全与限制
+
+- 命令名为 css-doctor，通过 package.json 的 bin 字段暴露。
+- --json 输出稳定的 CheckReport 结构，包含 files、issues 和 summary。
+- 初始化、读取或分析发生致命错误时返回非零退出码；warning 仍会显示在报告中。
+
+## 完整文档
+
+项目 README：[English](https://github.com/zealakit/css-doctor/blob/main/README.md) | [Tiếng Việt](https://github.com/zealakit/css-doctor/blob/main/README_VI.md) | [简体中文](https://github.com/zealakit/css-doctor/blob/main/README_CN.md)

package/README_VI.md

@@ -0,0 +1,42 @@
+<div align="center">
+
+# @zealakit/css-doctor-cli
+
+**Công cụ chẩn đoán CSS trên terminal bằng engine native css-doctor.**
+
+[English](https://github.com/zealakit/css-doctor/blob/main/packages/cli/README.md) | [Tiếng Việt](https://github.com/zealakit/css-doctor/blob/main/packages/cli/README_VI.md) | [简体中文](https://github.com/zealakit/css-doctor/blob/main/packages/cli/README_CN.md)
+
+</div>
+
+---
+
+![css doctor](https://github.com/zealakit/css-doctor/blob/main/assets/images/css-doctor.jpg)
+
+## Cài đặt
+
+```bash
+pnpm add -D @zealakit/css-doctor-cli
+```
+
+## Sử dụng
+
+```bash
+# Phân tích file hoặc glob có quote
+pnpm exec css-doctor check "src/**/*.css"
+
+# Output JSON cho CI/CD
+pnpm exec css-doctor check "src/**/*.css" --json
+
+# Cảnh báo khi file có hơn 500 selector
+pnpm exec css-doctor check "src/**/*.css" --threshold 500
+```
+
+## An toàn và giới hạn
+
+- Binary tên css-doctor, được expose qua trường bin của package.
+- --json xuất schema CheckReport ổn định gồm files, issues và summary.
+- Exit code khác 0 khi setup/read/analyze lỗi nghiêm trọng; warning vẫn hiện trong report.
+
+## Tài liệu đầy đủ
+
+README dự án: [English](https://github.com/zealakit/css-doctor/blob/main/README.md) | [Tiếng Việt](https://github.com/zealakit/css-doctor/blob/main/README_VI.md) | [简体中文](https://github.com/zealakit/css-doctor/blob/main/README_CN.md)