npm - gbu-accessibility-package - Versions diffs - 3.12.1 → 3.13.0 - Mend

gbu-accessibility-package 3.12.1 → 3.13.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (10) hide show

package/CHANGELOG.md CHANGED Viewed

@@ -7,14 +7,19 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## [Unreleased]
+### Changed
+- **BREAKING**: Package is now check/report-only and never modifies source files
+- Removed destructive features including backup creation, cleanup mode, meta auto-fix, heading auto-fix, and unused-file deletion
+- Reworked CLI and documentation around `AccessibilityChecker` and dry-run-only behavior
 ### Added
-- **Unused Files List Workflow**:
-  - Added `--unused-files-list` to export detected unused files into `unused-files-list.txt`
-  - Added `--delete-unused-files` to delete files listed in `unused-files-list.txt`
-  - Added `--list-file` to customize the list file path inside the target directory
+- Added `AccessibilityChecker` export for the new public API
+- Kept `AccessibilityFixer` export in compatibility mode, but locked it to check-only behavior
+- Added safer unused-files list preview workflow instead of delete behavior
 ### Fixed
 - **Unused file reference matching**: `--unused-files` now ignores query strings and hash fragments like `style.css?hash` and `bundle.js#v1`
+- Added coverage to ensure legacy fix/delete code paths can no longer modify project files
 ## [3.8.3] - 2025-10-06

package/QUICK_START.md CHANGED Viewed

@@ -1,175 +1,32 @@
-# 🚀 Quick Start Guide
+# Quick Start
-Hướng dẫn nhanh để sử dụng GBU Accessibility Package trong 5 phút.
+GBU Accessibility Package is a check-and-report tool.
-## ⚡ Cài đặt nhanh
+## Install
 ```bash
-# 1. Cài đặt global (khuyến nghị)
 npm install -g gbu-accessibility-package
-# 2. Hoặc cài đặt local
-npm install gbu-accessibility-package
-# 3. Chạy ngay!
-gbu-a11y
-```
-## 🔄 Cài đặt lại / Cập nhật
-```bash
-# Gỡ cài đặt cũ
-npm uninstall -g gbu-accessibility-package
-# Xóa cache
-npm cache clean --force
-# Cài đặt phiên bản mới nhất
-npm install -g gbu-accessibility-package@latest
-# Kiểm tra version
-gbu-a11y --version
 ```
-## 🎯 Sử dụng cơ bản
-### Cách 1: CLI (Đơn giản nhất)
+## Run
 ```bash
-# Fix toàn bộ dự án (current directory)
+# Comprehensive review
 gbu-a11y
-# Fix thư mục cụ thể
+# Specific directory
 gbu-a11y ./src
-# Preview trước khi fix
-gbu-a11y --dry-run
-# Fix với ngôn ngữ khác
-gbu-a11y -l en ./dist
-# Fix comprehensive (khuyến nghị)
-gbu-a11y --comprehensive
-```
-### Cách 2: Node.js Script
-Tạo file `fix.js`:
-```javascript
-const AccessibilityFixer = require('gbu-accessibility-package');
-const fixer = new AccessibilityFixer({
-  language: 'ja',     // Thay đổi theo dự án
-  backupFiles: true,
-  dryRun: false
-});
-async function fix() {
-  // Fix tất cả issues
-  await fixer.fixAllAccessibilityIssues('.');
-  console.log('✅ Done!');
-}
-fix();
-```
-Chạy: `node fix.js`
-## 📋 Checklist nhanh
-- [ ] `npm install -g gbu-accessibility-package`
-- [ ] Backup code (git commit)
-- [ ] Chạy `gbu-a11y --dry-run` để preview
-- [ ] Chạy `gbu-a11y --comprehensive` để fix
-- [ ] Kiểm tra kết quả
-- [ ] Commit changes
-## 🎨 Kết quả mong đợi
-### Trước:
-```html
-<html>
-<body>
-  <img src="logo.png">
-  <a href="/about">About</a>
-  <button onclick="submit()">Submit</button>
-</body>
-</html>
-```
+# Alt text review only
+gbu-a11y --alt-only ./src
-### Sau:
-```html
-<html lang="ja">
-<body>
-  <img src="logo.png" alt="ロゴ" role="img">
-  <a href="/about" role="link">About</a>
-  <button onclick="submit()" role="button">Submit</button>
-</body>
-</html>
+# Excel report
+gbu-a11y --full-report -o reports/accessibility-report.xlsx
 ```
-## 🔧 Tùy chỉnh nhanh
-### Thay đổi ngôn ngữ
-```javascript
-// Trong config
-language: 'en'  // 'ja', 'vi', 'zh', etc.
-```
-### Không tạo backup
-```bash
-gbu-a11y --no-backup
-```
-### Chỉ preview
-```bash
-gbu-a11y --dry-run
-```
-## ❓ Troubleshooting
-**Lỗi "Cannot find module"**
-```bash
-# Cài đặt lại
-npm uninstall -g gbu-accessibility-package
-npm cache clean --force
-npm install -g gbu-accessibility-package
-```
-**Lỗi permission (macOS/Linux)**
-```bash
-sudo npm install -g gbu-accessibility-package
-```
-**Package không update**
-```bash
-# Force update
-npm cache clean --force
-npm install -g gbu-accessibility-package@latest --force
-```
-**Kiểm tra cài đặt**
-```bash
-which gbu-a11y
-npm list -g gbu-accessibility-package
-gbu-a11y --version
-```
-**Duplicate attributes**
-- Tool tự động tránh duplicate
-- Nếu có, chạy lại tool sẽ tự clean up
-**Performance chậm**
-- Chạy từng thư mục nhỏ
-- Exclude node_modules
-## 📞 Cần trợ giúp?
-1. Đọc [README.md](./README.md) đầy đủ
-2. Xem [example.js](./example.js)
-3. Chạy `gbu-a11y --help`
+## Important
----
+- Source files are never modified
+- `--dry-run` is now implicit
-**Chúc bạn coding vui vẻ! 🎉**
+See [README.md](./README.md) and [README-vi.md](./README-vi.md) for full usage.