gbu-accessibility-package 3.0.0 → 3.1.3
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.
- package/CHANGELOG.md +139 -0
- package/README-vi.md +720 -0
- package/README.md +394 -119
- package/cli.js +6 -6
- package/demo/no-backup-test.html +12 -0
- package/demo/no-backup-test.html.backup +12 -0
- package/lib/fixer.js +1 -1
- package/package.json +19 -5
package/CHANGELOG.md
ADDED
|
@@ -0,0 +1,139 @@
|
|
|
1
|
+
# Changelog
|
|
2
|
+
|
|
3
|
+
All notable changes to this project will be documented in this file.
|
|
4
|
+
|
|
5
|
+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
|
|
6
|
+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
|
7
|
+
|
|
8
|
+
## [3.1.0] - 2024-07-25
|
|
9
|
+
|
|
10
|
+
### Changed
|
|
11
|
+
- **BREAKING**: Default behavior now **no backup files** for faster processing
|
|
12
|
+
- **Backup is now optional**: Use `--backup` flag when you need backup files
|
|
13
|
+
- **Performance improvement**: Faster processing by default without backup creation
|
|
14
|
+
- **CLI help updated**: Reflects new default behavior
|
|
15
|
+
- **Documentation updated**: README and README-vi updated with new backup behavior
|
|
16
|
+
|
|
17
|
+
### Migration Guide
|
|
18
|
+
- **No action needed for most users** - you get faster processing by default
|
|
19
|
+
- **If you want backup files**: Add `--backup` flag to your commands
|
|
20
|
+
- **Old behavior**: `gbu-a11y` (created backups) → **New behavior**: `gbu-a11y --backup`
|
|
21
|
+
- **Scripts using --no-backup**: Can remove the flag (now default behavior)
|
|
22
|
+
|
|
23
|
+
## [3.0.0] - 2024-07-25
|
|
24
|
+
|
|
25
|
+
### Added
|
|
26
|
+
- **Form Labels**: Automatic fixing of missing form labels with intelligent aria-label generation
|
|
27
|
+
- **Button Names**: Fix empty buttons and input buttons without names
|
|
28
|
+
- **Link Names**: Fix empty links and detect generic link text
|
|
29
|
+
- **Landmarks**: Add missing main and navigation landmarks
|
|
30
|
+
- **Heading Analysis**: Analyze heading structure with suggestions (no auto-fix for safety)
|
|
31
|
+
- **Individual Fix Modes**: New CLI options for targeted fixes:
|
|
32
|
+
- `--forms-only` - Fix form labels + cleanup
|
|
33
|
+
- `--buttons-only` - Fix button names + cleanup
|
|
34
|
+
- `--links-only` - Fix link names + cleanup
|
|
35
|
+
- `--landmarks-only` - Fix landmarks + cleanup
|
|
36
|
+
- `--headings-only` - Analyze heading structure only
|
|
37
|
+
- **Comprehensive Mode**: Now includes 9 steps of accessibility fixes
|
|
38
|
+
- **Language Support**: Japanese labels for form inputs and buttons
|
|
39
|
+
- **axe DevTools Coverage**: Addresses major axe accessibility issues
|
|
40
|
+
- **Advanced Demo**: New `advanced-test.html` showcasing all features
|
|
41
|
+
|
|
42
|
+
### Changed
|
|
43
|
+
- **BREAKING**: Comprehensive fixes now default mode (was basic fixes)
|
|
44
|
+
- **All individual modes** now include cleanup step for consistency
|
|
45
|
+
- **Enhanced CLI**: Better help messages and examples
|
|
46
|
+
- **Improved Reporting**: More detailed issue analysis and suggestions
|
|
47
|
+
|
|
48
|
+
### Enhanced
|
|
49
|
+
- **Alt Text Generation**: Now also adds matching aria-label attributes
|
|
50
|
+
- **Role Attributes**: Enhanced picture/img handling
|
|
51
|
+
- **Context Analysis**: Improved smart text generation
|
|
52
|
+
- **Error Handling**: Better error messages and recovery
|
|
53
|
+
|
|
54
|
+
## [2.1.0] - 2024-07-24
|
|
55
|
+
|
|
56
|
+
### Added
|
|
57
|
+
- **Backup Management**: Improved backup options with `--backup` and `--no-backup`
|
|
58
|
+
- **Consistent Messaging**: Unified completion messages across all modes
|
|
59
|
+
- **Cleanup Scripts**: npm script for removing backup files
|
|
60
|
+
|
|
61
|
+
### Changed
|
|
62
|
+
- **Default Behavior**: Comprehensive fixes as default mode
|
|
63
|
+
- **Backup Notifications**: Clear messaging about backup status
|
|
64
|
+
|
|
65
|
+
## [2.0.0] - 2024-07-24
|
|
66
|
+
|
|
67
|
+
### Added
|
|
68
|
+
- **Comprehensive Mode**: All fixes including cleanup as default
|
|
69
|
+
- **Basic Mode**: `--basic` flag for fixes without cleanup
|
|
70
|
+
|
|
71
|
+
### Changed
|
|
72
|
+
- **BREAKING**: Default mode now runs comprehensive fixes
|
|
73
|
+
- **CLI Behavior**: Simplified command structure
|
|
74
|
+
|
|
75
|
+
## [1.6.0] - 2024-07-24
|
|
76
|
+
|
|
77
|
+
### Added
|
|
78
|
+
- **Backup Options**: Explicit `--backup` and `--no-backup` flags
|
|
79
|
+
- **Helper Functions**: Consistent completion messaging
|
|
80
|
+
- **Safety Features**: Enhanced backup management
|
|
81
|
+
|
|
82
|
+
## [1.5.0] - 2024-07-24
|
|
83
|
+
|
|
84
|
+
### Added
|
|
85
|
+
- **Aria Label Support**: Automatic aria-label generation matching alt text
|
|
86
|
+
- **Picture Handling**: Move role from `<picture>` to `<img>` elements
|
|
87
|
+
- **Enhanced Reporting**: Comprehensive issue analysis
|
|
88
|
+
|
|
89
|
+
## [1.4.0] - 2024-07-24
|
|
90
|
+
|
|
91
|
+
### Added
|
|
92
|
+
- **Individual Fix Options**: Separate modes for different fix types
|
|
93
|
+
- **Enhanced CLI**: More granular control over fixes
|
|
94
|
+
|
|
95
|
+
## [1.3.0] - 2024-07-24
|
|
96
|
+
|
|
97
|
+
### Added
|
|
98
|
+
- **Individual Fix Modes**: `--alt-only`, `--lang-only`, `--role-only`
|
|
99
|
+
- **Enhanced Documentation**: Updated README with new features
|
|
100
|
+
|
|
101
|
+
## [1.2.0] - 2024-07-24
|
|
102
|
+
|
|
103
|
+
### Added
|
|
104
|
+
- **Role Attributes**: Comprehensive role attribute management
|
|
105
|
+
- **Duplicate Cleanup**: Remove duplicate role attributes
|
|
106
|
+
- **Context-Aware Alt Text**: Intelligent alt text generation
|
|
107
|
+
|
|
108
|
+
## [1.1.0] - 2024-07-24
|
|
109
|
+
|
|
110
|
+
### Added
|
|
111
|
+
- **HTML Lang Attributes**: Automatic language attribute fixes
|
|
112
|
+
- **Backup System**: Automatic backup file creation
|
|
113
|
+
|
|
114
|
+
## [1.0.0] - 2024-07-24
|
|
115
|
+
|
|
116
|
+
### Added
|
|
117
|
+
- **Initial Release**: Basic alt attribute fixes
|
|
118
|
+
- **CLI Interface**: Command-line tool
|
|
119
|
+
- **Dry Run Mode**: Preview changes before applying
|
|
120
|
+
- **Batch Processing**: Process multiple files and directories
|
|
121
|
+
|
|
122
|
+
---
|
|
123
|
+
|
|
124
|
+
## Migration Guides
|
|
125
|
+
|
|
126
|
+
### Upgrading to 3.0.0
|
|
127
|
+
- **No breaking changes for most users** - you get better default behavior
|
|
128
|
+
- **New features available** - try `--forms-only`, `--buttons-only`, etc.
|
|
129
|
+
- **Comprehensive mode is now default** - includes all fixes + cleanup
|
|
130
|
+
- **Heading analysis is safe** - only provides suggestions, no auto-fixes
|
|
131
|
+
|
|
132
|
+
### Upgrading to 2.0.0
|
|
133
|
+
- **Default behavior changed** - now runs comprehensive fixes by default
|
|
134
|
+
- **Use `--basic` flag** if you want the old default behavior
|
|
135
|
+
- **All modes now include cleanup** for better consistency
|
|
136
|
+
|
|
137
|
+
---
|
|
138
|
+
|
|
139
|
+
For more details about any release, see the [GitHub Releases](https://github.com/dangpv94/gbu-accessibility-tool/releases) page.
|