release: 1.9.2

Author: BCsabaEngine

CHANGELOG.md

@@ -1,132 +1,227 @@
-# Change log
+# Changelog
 
-## 1.9
+All notable changes to this project will be documented in this file.
 
-### 1.9.1
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-- Chore: deps
-- Chore: require Node.js >=20
+## [1.9.2] - 2025-10-18
 
-### 1.9.0
+### Changed
 
-- Feat: allow code generator for esp-idf
+- Improved CLAUDE.md with detailed architecture information, processing pipeline details, and template system documentation
+- Enhanced README.md with comprehensive updates:
+  - Added Node.js >= 20 and npm >= 9 requirements
+  - Added ESP-IDF native code usage example
+  - Improved generated code examples with complete header structure
+  - Enhanced engine descriptions with detailed use cases
+  - Added PsychicHttpServer `max_uri_handlers` configuration note
+  - Improved compression output examples with percentage ratios
+  - Better Q&A explanations for PROGMEM usage and file size
+  - Updated command line options table with clarifications
+  - Fixed inaccuracies in MIME type package references
+- Reformatted CHANGELOG.md to follow Keep a Changelog standard with proper categorization and GitHub comparison links
 
-## 1.8
+## [1.9.1] - 2024-09-13
 
-### 1.8.1
+### Changed
 
-- Fix: http header casing
+- Updated dependencies
+- **BREAKING**: Require Node.js >= 20 and npm >= 9
 
-### 1.8.0
+## [1.9.0] - 2024-03-31
 
-- Using the new and maintained ESPAsyncWebserver available at https://github.com/ESP32Async/ESPAsyncWebServer, that has some deprecations.
+### Added
 
-## 1.7
+- Code generator support for native ESP-IDF web server (`-e espidf`)
+- New `src/cppCodeEspIdf.ts` module for ESP-IDF template generation
+- ESP-IDF demo project in `demo/esp32idf/`
 
-### 1.7.1
+## [1.8.1] - 2023-12-XX
 
-- Due to ESM problems, we revert to using the **mime-types** npm module.
+### Fixed
 
-### 1.7.0
+- HTTP header casing issues
 
-- Using the cachetime command line option, you can set whether the browser can cache pages. Together with the ETag switch, you can replace the default no-cache response with a max-age=xy response.
+## [1.8.0] - 2023-XX-XX
 
-## 1.6
+### Changed
 
-### 1.6.1
+- Updated to use the new and maintained ESPAsyncWebServer from https://github.com/ESP32Async/ESPAsyncWebServer
+- Adapted to ESPAsyncWebServer API deprecations
 
-- Chore: force publish npm
+## [1.7.1] - 2023-XX-XX
 
-### 1.6.0
+### Fixed
 
-- Using mime npm package instead of mime-types: I prefer to use standard text/javascript. It better meets today's requirements.
+- Reverted to **mime-types** npm package due to ESM compatibility issues
 
-## 1.5
+## [1.7.0] - 2023-XX-XX
 
-### 1.5.2
+### Added
 
-- chore: In the psychicHttp generated code, the minimum setting of server.config.max_uri_handlers (20 by default) is displayed as a comment so that all files can be served.
+- `--cachetime` command line option to control browser caching behavior
+- Ability to set `max-age` cache control header value (in seconds)
+- Works in conjunction with ETag to replace default `no-cache` response
 
-### 1.5.1
+## [1.6.1] - 2023-XX-XX
 
-- bugfix: It generated an error code if there was an @ sign in the file name. We tried to protect all possible characters: `!&()+./@{}~-`
+### Changed
 
-### 1.5.0
+- Force publish to npm registry
 
-- New engine type (-e psychic2) for PsychicHttp v2
+## [1.6.0] - 2023-XX-XX
 
-- Run tests with github repos instead of packages
+### Changed
 
-## 1.4
+- Switched to `mime-types` package for better MIME type handling
+- Updated MIME type for JavaScript files to standard `text/javascript` (was `application/javascript`)
 
-### 1.4.1
+## [1.5.2] - 2023-XX-XX
 
-- Implemented a new function to **identify and log files with identical content**.
+### Changed
 
-- Added support for multiple linting tools to ensure higher code standards.
+- Added comment in PsychicHttpServer generated code suggesting minimum `server.config.max_uri_handlers` setting (default 20) to ensure all files can be served
 
-### 1.4.0
+## [1.5.1] - 2023-XX-XX
 
-- Breaking change: --no-gzip changed to --gzip
+### Fixed
 
-- The etag and gzip compiler option: For Etag and Gzip switches, values ​​true|false|compiler can be used. In the case of a compiler value, both variants can be found in the .h file and you can decide at compile time which one should be used.
+- Fixed error when file names contain `@` character
+- Enhanced character protection for file name conversion to C++ identifiers: `!&()+./@{}~-`
 
-- The created and version info: You can put the creation date and a version number in the .h file with the --created and --version options.
+## [1.5.0] - 2023-XX-XX
 
-- 2x9 build and test system: We also run all possible parameter combinations (etag and gzip) for the Async and Psychic web servers.
+### Added
 
-- Separated demo env
+- New engine type `-e psychic2` for PsychicHttpServer V2 support
+- PsychicHttpServer V2 template with updated API (response passed as parameter)
 
-- Proper svelte demo app
+### Changed
 
-- Create output directory: If output folder not exists, it will be automatically created
+- Test suite now uses GitHub repositories instead of npm packages
 
-- Detect precompressed files: If a.b and a.b.gz exist together, the .gz file is not used (gz, br, brottli)
+## [1.4.1] - 2023-XX-XX
 
-- Reduce .h file size: The size of the .h file has been reduced by 35-50%.
+### Added
 
-- Skip gz under 1024: The gzip threshold increased to 1024 bytes.
+- Duplicate file detection using SHA256 hashing
+- Logging of files with identical content
+- Support for multiple linting tools (ESLint with TypeScript, Prettier, Unicorn plugins)
 
-- Pipeline node version update
+## [1.4.0] - 2023-XX-XX
 
-- Warning if not usable directive used
+### Added
 
-- Colored console
+- Three-state option support for `--etag` and `--gzip` parameters: `true|false|compiler`
+  - `compiler` mode generates both variants in .h file with C++ preprocessor directives
+  - Allows runtime configuration via `SVELTEESP32_ENABLE_ETAG` and `SVELTEESP32_ENABLE_GZIP` defines
+- `--created` option to include creation timestamp in generated header
+- `--version` option to include version string in generated header
+- Comprehensive test system generating all parameter combinations (2×9 builds)
+- Automatic output directory creation if it doesn't exist
+- Pre-compressed file detection (skips `.gz`, `.br`, `.brottli` if original exists)
+- Colored console output for better readability
+- Warning messages when non-effective directives are used
 
-## 1.3
+### Changed
 
-### 1.3.1
+- **BREAKING**: Renamed `--no-gzip` to `--gzip` (inverted logic)
+- Increased gzip threshold from default to 1024 bytes minimum
+- Reduced generated .h file size by 35-50% through optimizations
+- Separated demo environment
+- Improved Svelte demo application
+- Updated pipeline Node.js version
 
-- Filename directives are uppercased
+## [1.3.1] - 2023-XX-XX
 
-- Filecount by extension
+### Changed
 
-### 1.3.0
+- Filename C++ defines are now uppercased (e.g., `SVELTEESP32_FILE_INDEX_HTML`)
 
-- C++ defines can be used
+### Added
 
-- C++ defines group by filetypes: Should we be able to check if a given file name or number of files is correct? For this, we should find C++ defines in the generated code.
+- File count statistics grouped by extension (e.g., `SVELTEESP32_CSS_FILES`)
 
-## 1.2
+## [1.3.0] - 2023-XX-XX
 
-### 1.2.4
+### Added
 
-- Deps update
+- C++ preprocessor defines for build-time validation:
+  - `{PREFIX}_COUNT` - Total file count
+  - `{PREFIX}_SIZE` - Total uncompressed size
+  - `{PREFIX}_SIZE_GZIP` - Total gzip compressed size
+  - `{PREFIX}_FILE_{FILENAME}` - Individual file markers
+  - `{PREFIX}_{EXT}_FILES` - Count by file extension
+- Ability to use `#ifndef` and `#error` for compile-time checks
 
-### 1.2.2
+## [1.2.4] - 2023-XX-XX
 
-- Necessary C++ includes
+### Changed
 
-### 1.2.1
+- Updated dependencies
 
-- Windows paths
+## [1.2.2] - 2023-XX-XX
 
-### 1.2.0
+### Added
 
-- ESP8266/ESP8285 is also supported
+- Necessary C++ includes in generated headers
 
-## 1.1
+## [1.2.1] - 2023-XX-XX
 
-### 1.1.0
+### Fixed
 
-- ETag available
+- Windows path handling
+
+## [1.2.0] - 2023-XX-XX
+
+### Added
+
+- ESP8266/ESP8285 support
+- PROGMEM directive usage for ESPAsyncWebServer engine
+
+## [1.1.0] - 2023-XX-XX
+
+### Added
+
+- ETag HTTP header support for cache validation
+- MD5 hash generation for ETag values
+- HTTP 304 Not Modified response handling
+- `--etag` command line option
+
+## [1.0.0] - 2023-XX-XX
+
+### Added
+
+- Initial release
+- Support for PsychicHttpServer (ESP32)
+- Support for ESPAsyncWebServer (ESP32/ESP8266)
+- Automatic gzip compression for files >1024 bytes with >15% size reduction
+- Binary data embedding as const arrays
+- MIME type detection
+- Handlebars-based C++ code generation
+- CLI interface with `-s`, `-e`, `-o` options
+- `index.html` automatic default route handling
+
+[1.9.2]: https://github.com/BCsabaEngine/svelteesp32/compare/v1.9.1...v1.9.2
+[1.9.1]: https://github.com/BCsabaEngine/svelteesp32/compare/v1.9.0...v1.9.1
+[1.9.0]: https://github.com/BCsabaEngine/svelteesp32/compare/v1.8.1...v1.9.0
+[1.8.1]: https://github.com/BCsabaEngine/svelteesp32/compare/v1.8.0...v1.8.1
+[1.8.0]: https://github.com/BCsabaEngine/svelteesp32/compare/v1.7.1...v1.8.0
+[1.7.1]: https://github.com/BCsabaEngine/svelteesp32/compare/v1.7.0...v1.7.1
+[1.7.0]: https://github.com/BCsabaEngine/svelteesp32/compare/v1.6.1...v1.7.0
+[1.6.1]: https://github.com/BCsabaEngine/svelteesp32/compare/v1.6.0...v1.6.1
+[1.6.0]: https://github.com/BCsabaEngine/svelteesp32/compare/v1.5.2...v1.6.0
+[1.5.2]: https://github.com/BCsabaEngine/svelteesp32/compare/v1.5.1...v1.5.2
+[1.5.1]: https://github.com/BCsabaEngine/svelteesp32/compare/v1.5.0...v1.5.1
+[1.5.0]: https://github.com/BCsabaEngine/svelteesp32/compare/v1.4.1...v1.5.0
+[1.4.1]: https://github.com/BCsabaEngine/svelteesp32/compare/v1.4.0...v1.4.1
+[1.4.0]: https://github.com/BCsabaEngine/svelteesp32/compare/v1.3.1...v1.4.0
+[1.3.1]: https://github.com/BCsabaEngine/svelteesp32/compare/v1.3.0...v1.3.1
+[1.3.0]: https://github.com/BCsabaEngine/svelteesp32/compare/v1.2.4...v1.3.0
+[1.2.4]: https://github.com/BCsabaEngine/svelteesp32/compare/v1.2.2...v1.2.4
+[1.2.2]: https://github.com/BCsabaEngine/svelteesp32/compare/v1.2.1...v1.2.2
+[1.2.1]: https://github.com/BCsabaEngine/svelteesp32/compare/v1.2.0...v1.2.1
+[1.2.0]: https://github.com/BCsabaEngine/svelteesp32/compare/v1.1.0...v1.2.0
+[1.1.0]: https://github.com/BCsabaEngine/svelteesp32/compare/v1.0.0...v1.1.0
+[1.0.0]: https://github.com/BCsabaEngine/svelteesp32/releases/tag/v1.0.0

CLAUDE.md

@@ -60,6 +60,9 @@ npx svelteesp32 -e async -s ./dist -o ./output.h --etag=true --gzip=true
 
 # Generate header for ESP-IDF
 npx svelteesp32 -e espidf -s ./dist -o ./output.h --etag=true --gzip=true
+
+# Test the CLI directly using tsx (for development)
+npx tsx src/index.ts -e psychic -s ./demo/svelte/dist -o ./output.h --etag=true --gzip=true
 ```
 
 ## Architecture
@@ -75,11 +78,11 @@ npx svelteesp32 -e espidf -s ./dist -o ./output.h --etag=true --gzip=true
 
 ### Processing Pipeline
 
-1. **File Collection**: Scans source directory for web assets
-2. **Content Analysis**: Determines MIME types and calculates MD5 hashes
-3. **Compression**: Applies gzip compression when beneficial (>1024 bytes, >15% reduction)
-4. **Code Generation**: Uses Handlebars templates to generate C++ header files
-5. **Output**: Writes optimized header with embedded binary data and web server handlers
+1. **File Collection** (`src/file.ts`): Scans source directory recursively using glob, skips pre-compressed files (.gz, .br) if originals exist, detects duplicate files via SHA256 hashing
+2. **Content Analysis** (`src/index.ts`): Determines MIME types using `mime-types` library, calculates MD5 hashes for ETag generation, groups files by extension for statistics
+3. **Compression** (`src/index.ts`): Applies gzip level 9 compression, uses compressed version only when size reduction >15% and original >1024 bytes
+4. **Code Generation** (`src/cppCode.ts`, `src/cppCodeEspIdf.ts`): Uses Handlebars templates with custom helpers (switch/case), generates engine-specific C++ code with conditional compilation support
+5. **Output**: Writes optimized header with embedded binary data arrays, route handlers, ETag strings, and C++ defines for validation
 
 ### Supported Engines
 
@@ -113,15 +116,39 @@ npx svelteesp32 -e espidf -s ./dist -o ./output.h --etag=true --gzip=true
 
 ### Demo Projects
 
-- **`demo/svelte/`**: Example Svelte application for testing
-- **`demo/esp32/`**: PlatformIO project demonstrating Arduino framework usage
-- **`demo/esp32idf/`**: ESP-IDF native project example
+- **`demo/svelte/`**: Example Svelte application with Vite, TailwindCSS, gallery images
+- **`demo/esp32/`**: PlatformIO Arduino framework project with WiFi credentials example
+- **`demo/esp32idf/`**: ESP-IDF native project using native web server
 
-The `package.script` file contains comprehensive test scenarios that generate all combinations of ETag/gzip settings for validation.
+The `package.script` executable generates 36 test header files (9 combinations of etag/gzip × 4 engines) for comprehensive validation.
 
 ## Important Notes
 
 - The tool processes entire directories recursively and embeds all files as binary data
 - Generated header files can be large but compile efficiently
-- Memory usage is optimized through const array placement in program memory
+- Memory usage is optimized through const array placement in program memory (ESP32) or PROGMEM (ESP8266)
 - The CLI is designed for CI/CD integration with npm packaging workflows
+- `index.html` or `index.htm` files are automatically set as the default route for "/"
+- Pre-compressed files (.gz, .br, .brottli) in the source directory are skipped if the original file exists
+- The build uses `--clean` and `--force` flags to ensure clean builds without incremental compilation
+
+## Template System
+
+The code generation uses Handlebars with custom helpers:
+
+- **switch/case helpers**: Enable conditional C++ code generation based on etag/gzip settings
+- **Three-state options**: `etag` and `gzip` can be "true", "false", or "compiler" (for C++ directive control)
+- **Engine-specific templates**: Each engine (psychic, psychic2, async, espidf) has its own template in `src/cppCode.ts` or `src/cppCodeEspIdf.ts`
+- **Data transformation**: Binary content is converted to comma-separated byte arrays in the template data
+
+## Generated C++ Defines
+
+The generated header file includes C++ defines for build-time validation:
+
+- `{PREFIX}_COUNT`: Total number of files
+- `{PREFIX}_SIZE`: Total uncompressed size in bytes
+- `{PREFIX}_SIZE_GZIP`: Total gzip compressed size in bytes
+- `{PREFIX}_FILE_{FILENAME}`: Define for each file (e.g., `SVELTEESP32_FILE_INDEX_HTML`)
+- `{PREFIX}_{EXT}_FILES`: Count of files by extension (e.g., `SVELTEESP32_CSS_FILES`)
+
+These allow C++ code to verify expected files are present using `#ifndef` and `#error` directives.