Skip to content

Commit ff918b3

Browse files
committed
Update CHANGELOG.md for version 1.1.0
- Document all new features: uniqueFields, autoId, deleteAll, createCrud, directory creation - Add technical details and backward compatibility notes - Update version links and structure - Comprehensive documentation of test suite reorganization
1 parent 6770ce1 commit ff918b3

File tree

1 file changed

+47
-0
lines changed

1 file changed

+47
-0
lines changed

CHANGELOG.md

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,48 @@ All notable changes to this project will be documented in this file.
55
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
66
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
77

8+
## [1.1.0] - 2025-07-07
9+
10+
### Added
11+
- **Unique Fields Support** - Prevent duplicate values in specified fields
12+
- Configure unique fields via `uniqueFields` option
13+
- Automatic validation on create and update operations
14+
- Clear error messages for duplicate field values
15+
- **Auto-ID Toggle** - Control automatic ID assignment
16+
- Enable/disable auto-ID with `autoId` option
17+
- Default behavior remains unchanged (auto-ID enabled)
18+
- **deleteAll Method** - Remove all items from the database
19+
- Simple `deleteAll(callback)` method
20+
- Thread-safe operation through existing queue system
21+
- **createCrud Convenience Function** - Quick CRUD instance creation
22+
- Simplified API: `createCrud(filePath, options)`
23+
- Exported as named export for easy access
24+
- **Automatic Directory Creation** - Create directories if they don't exist
25+
- Automatically creates parent directories for file paths
26+
- No need to manually create directories before using the library
27+
28+
### Enhanced
29+
- **Test Suite Reorganization** - Improved test structure
30+
- Split tests into logical files by functionality
31+
- `test-basic.js` - Basic functionality and convenience features
32+
- `test-config-options.js` - Configuration options (uniqueFields, autoId)
33+
- `test-delete.js` - Delete operations including deleteAll
34+
- Total test count increased to 37 tests
35+
- **Configuration Options** - Enhanced constructor options
36+
- `uniqueFields: string[]` - Array of field names that must be unique
37+
- `autoId: boolean` - Enable/disable automatic ID assignment
38+
- Backward compatible with existing code
39+
40+
### Changed
41+
- Package description updated to reflect new features
42+
- Test scripts updated for reorganized test structure
43+
44+
### Technical Details
45+
- All new features maintain backward compatibility
46+
- Thread-safe operations through existing queue system
47+
- Comprehensive error handling for all new features
48+
- Zero breaking changes to existing API
49+
850
## [1.0.0] - 2025-07-07
951

1052
### Added
@@ -55,3 +97,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
5597
- Batch operations (createMany, updateMany, deleteMany)
5698
- File locking for multi-process safety
5799
- Enhanced documentation and examples
100+
101+
---
102+
103+
[1.1.0]: https://github.com/arielweizman/json-file-crud/compare/v1.0.0...v1.1.0
104+
[1.0.0]: https://github.com/arielweizman/json-file-crud/releases/tag/v1.0.0

0 commit comments

Comments
 (0)