svelteesp32 1.10.0 → 1.11.0

package/README.md

@@ -37,6 +37,51 @@ This npm package provides a solution for **inserting any JS client application i
 - Node.js >= 20
 - npm >= 9
 
+### Development
+
+#### Testing
+
+The project includes comprehensive unit tests using Vitest:
+
+```bash
+# Run tests once
+npm run test
+
+# Run tests in watch mode (for development)
+npm run test:watch
+
+# Generate coverage report
+npm run test:coverage
+```
+
+**Test Coverage:** ~68% overall with focus on core functionality:
+
+- `commandLine.ts`: 84.56% - CLI argument parsing and validation
+- `file.ts`: 100% - File operations and duplicate detection
+- `cppCode.ts`: 96.62% - C++ code generation and templates
+- `consoleColor.ts`: 100% - Console output utilities
+
+Coverage reports are generated in the `coverage/` directory and can be viewed by opening `coverage/index.html` in a browser.
+
+#### Code Quality
+
+```bash
+# Check formatting
+npm run format:check
+
+# Fix formatting
+npm run format:fix
+
+# Check linting
+npm run lint:check
+
+# Fix linting issues
+npm run lint:fix
+
+# Fix all formatting and linting issues
+npm run fix
+```
+
 ### Usage
 
 **Install package** as devDependency (it is practical if the package is part of the project so that you always receive updates)
@@ -258,6 +303,71 @@ At the same time, it can be an advantage that the content is cached by the brows
 
 Typically, the entry point for web applications is the **index.htm or index.html** file. This does not need to be listed in the browser's address bar because web servers know that this file should be served by default. Svelteesp32 also does this: if there is an index.htm or index.html file, it sets it as the main file to be served. So using `http://esp_xxx.local` or just entering the `http://x.y.w.z/` IP address will serve this main file.
 
+### File Exclusion
+
+The `--exclude` option allows you to exclude files from being embedded in the ESP32 firmware using glob patterns. This is useful for excluding source maps, documentation, and test files that shouldn't be part of the deployed application.
+
+#### Basic Usage
+
+```bash
+# Exclude source maps
+npx svelteesp32 -e psychic -s ./dist -o ./output.h --exclude="*.map"
+
+# Exclude documentation files
+npx svelteesp32 -e psychic -s ./dist -o ./output.h --exclude="*.md"
+
+# Exclude multiple file types (comma-separated)
+npx svelteesp32 -e psychic -s ./dist -o ./output.h --exclude="*.map,*.md,*.txt"
+
+# Exclude using multiple flags
+npx svelteesp32 -e psychic -s ./dist -o ./output.h --exclude="*.map" --exclude="*.md"
+
+# Exclude entire directories
+npx svelteesp32 -e psychic -s ./dist -o ./output.h --exclude="test/**/*"
+
+# Combine multiple approaches
+npx svelteesp32 -e psychic -s ./dist -o ./output.h --exclude="*.map,*.md" --exclude="docs/**/*"
+```
+
+#### Pattern Syntax
+
+The exclude patterns use standard glob syntax:
+
+- `*.map` - Match all files ending with `.map`
+- `**/*.test.js` - Match all `.test.js` files in any directory
+- `test/**/*` - Match all files in the `test` directory and subdirectories
+- `.DS_Store` - Match specific filename
+
+#### Default Exclusions
+
+By default, the following system and development files are automatically excluded:
+
+- `.DS_Store` (macOS system file)
+- `Thumbs.db` (Windows thumbnail cache)
+- `.git` (Git directory)
+- `.svn` (SVN directory)
+- `*.swp` (Vim swap files)
+- `*~` (Backup files)
+- `.gitignore` (Git ignore file)
+- `.gitattributes` (Git attributes file)
+
+Custom exclude patterns are added to these defaults.
+
+#### Exclusion Output
+
+When files are excluded, you'll see a summary in the build output:
+
+```
+Excluded 5 file(s):
+  - assets/index.js.map
+  - assets/vendor.js.map
+  - README.md
+  - docs/guide.md
+  - test/unit.test.js
+```
+
+This helps you verify that the correct files are being excluded from your build.
+
 ### C++ defines
 
 To make it easy to integrate into a larger c++ project, we have made a couple of variables available as c++ defines.
@@ -307,6 +417,7 @@ You can use the following c++ directives at the project level if you want to con
 | `-s`          | **Source dist folder contains compiled web files**                                   | (required)              |
 | `-e`          | The engine for which the include file is created (psychic/psychic2/async/espidf)     | psychic                 |
 | `-o`          | Generated output file with path                                                      | `svelteesp32.h`         |
+| `--exclude`   | Exclude files matching glob pattern (repeatable or comma-separated)                  | Default system files    |
 | `--etag`      | Use ETag header for cache (true/false/compiler)                                      | false                   |
 | `--cachetime` | Override no-cache response with a max-age=\<cachetime\> response (seconds)           | 0                       |
 | `--gzip`      | Compress content with gzip (true/false/compiler)                                     | true                    |

package/dist/commandLine.d.ts

@@ -9,6 +9,7 @@ interface ICopyFilesArguments {
     cachetime: number;
     created: boolean;
     version: string;
+    exclude: string[];
     help?: boolean;
 }
 export declare const cmdLine: ICopyFilesArguments;

package/dist/commandLine.js

@@ -18,6 +18,8 @@ Options:
   --espmethod <name>         Name of generated method (default: "initSvelteStaticFiles")
   --define <prefix>          Prefix of c++ defines (default: "SVELTEESP32")
   --cachetime <seconds>      max-age cache time in seconds (default: 0)
+  --exclude <pattern>        Exclude files matching glob pattern (repeatable or comma-separated)
+                             Examples: --exclude="*.map" --exclude="test/**/*.ts"
   -h, --help                 Shows this help
 `);
     process.exit(0);
@@ -32,6 +34,16 @@ function validateTriState(value, name) {
         return value;
     throw new Error(`Invalid ${name}: ${value}`);
 }
+const DEFAULT_EXCLUDE_PATTERNS = [
+    '.DS_Store',
+    'Thumbs.db',
+    '.git',
+    '.svn',
+    '*.swp',
+    '*~',
+    '.gitignore',
+    '.gitattributes'
+];
 function parseArguments() {
     const arguments_ = process.argv.slice(2);
     const result = {
@@ -43,7 +55,8 @@ function parseArguments() {
         version: '',
         espmethod: 'initSvelteStaticFiles',
         define: 'SVELTEESP32',
-        cachetime: 0
+        cachetime: 0,
+        exclude: [...DEFAULT_EXCLUDE_PATTERNS]
     };
     for (let index = 0; index < arguments_.length; index++) {
         const argument = arguments_[index];
@@ -85,10 +98,18 @@ function parseArguments() {
                     break;
                 case 'cachetime':
                     result.cachetime = Number.parseInt(value, 10);
-                    if (Number.isNaN(result.cachetime)) {
+                    if (Number.isNaN(result.cachetime))
                         throw new TypeError(`Invalid cachetime: ${value}`);
-                    }
                     break;
+                case 'exclude': {
+                    const patterns = value
+                        .split(',')
+                        .map((p) => p.trim())
+                        .filter(Boolean);
+                    result.exclude = result.exclude || [...DEFAULT_EXCLUDE_PATTERNS];
+                    result.exclude.push(...patterns);
+                    break;
+                }
                 default:
                     throw new Error(`Unknown flag: ${flag}`);
             }
@@ -161,11 +182,20 @@ function parseArguments() {
                     break;
                 case 'cachetime':
                     result.cachetime = Number.parseInt(nextArgument, 10);
-                    if (Number.isNaN(result.cachetime)) {
+                    if (Number.isNaN(result.cachetime))
                         throw new TypeError(`Invalid cachetime: ${nextArgument}`);
-                    }
                     index++;
                     break;
+                case 'exclude': {
+                    const patterns = nextArgument
+                        .split(',')
+                        .map((p) => p.trim())
+                        .filter(Boolean);
+                    result.exclude = result.exclude || [...DEFAULT_EXCLUDE_PATTERNS];
+                    result.exclude.push(...patterns);
+                    index++;
+                    break;
+                }
                 default:
                     throw new Error(`Unknown flag: --${flag}`);
             }

package/dist/consoleColor.d.ts

@@ -1,3 +1,4 @@
 export declare const greenLog: (s: string) => string;
 export declare const yellowLog: (s: string) => string;
 export declare const redLog: (s: string) => string;
+export declare const cyanLog: (s: string) => string;

package/dist/consoleColor.js

@@ -1,9 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.redLog = exports.yellowLog = exports.greenLog = void 0;
+exports.cyanLog = exports.redLog = exports.yellowLog = exports.greenLog = void 0;
 const greenLog = (s) => `\u001B[32m${s}\u001B[0m`;
 exports.greenLog = greenLog;
 const yellowLog = (s) => `\u001B[33m${s}\u001B[0m`;
 exports.yellowLog = yellowLog;
 const redLog = (s) => `\u001B[31m${s}\u001B[0m`;
 exports.redLog = redLog;
+const cyanLog = (s) => `\u001B[36m${s}\u001B[0m`;
+exports.cyanLog = cyanLog;

package/dist/file.js

@@ -7,6 +7,7 @@ exports.getFiles = void 0;
 const node_crypto_1 = require("node:crypto");
 const node_fs_1 = require("node:fs");
 const node_path_1 = __importDefault(require("node:path"));
+const picomatch_1 = __importDefault(require("picomatch"));
 const tinyglobby_1 = require("tinyglobby");
 const commandLine_1 = require("./commandLine");
 const consoleColor_1 = require("./consoleColor");
@@ -15,19 +16,15 @@ const findSimilarFiles = (files) => {
     for (const [filename, content] of files.entries()) {
         const hash = (0, node_crypto_1.createHash)('sha256').update(content).digest('hex');
         const existingFiles = contentComparer.get(hash);
-        if (existingFiles) {
+        if (existingFiles)
             existingFiles.push(filename);
-        }
-        else {
+        else
             contentComparer.set(hash, [filename]);
-        }
     }
     const result = [];
-    for (const filenames of contentComparer.values()) {
-        if (filenames.length > 1) {
+    for (const filenames of contentComparer.values())
+        if (filenames.length > 1)
             result.push(filenames);
-        }
-    }
     return result;
 };
 const shouldSkipFile = (filename, allFilenames) => {
@@ -42,18 +39,46 @@ const shouldSkipFile = (filename, allFilenames) => {
     }
     return false;
 };
+const isExcluded = (filename, excludePatterns) => {
+    if (excludePatterns.length === 0)
+        return false;
+    const normalizedFilename = filename.replace(/\\/g, '/');
+    const isMatch = (0, picomatch_1.default)(excludePatterns, {
+        dot: true,
+        noglobstar: false,
+        matchBase: false
+    });
+    return isMatch(normalizedFilename);
+};
 const getFiles = () => {
     const allFilenames = (0, tinyglobby_1.globSync)('**/*', { cwd: commandLine_1.cmdLine.sourcepath, onlyFiles: true, dot: false });
-    const filenames = allFilenames.filter((filename) => !shouldSkipFile(filename, allFilenames));
+    const withoutCompressed = allFilenames.filter((filename) => !shouldSkipFile(filename, allFilenames));
+    const excludePatterns = commandLine_1.cmdLine.exclude || [];
+    const excludedFiles = [];
+    const filenames = withoutCompressed.filter((filename) => {
+        if (isExcluded(filename, excludePatterns)) {
+            excludedFiles.push(filename);
+            return false;
+        }
+        return true;
+    });
+    if (excludedFiles.length > 0) {
+        console.log((0, consoleColor_1.cyanLog)(`\n Excluded ${excludedFiles.length} file(s):`));
+        const displayLimit = 10;
+        for (const file of excludedFiles.slice(0, displayLimit))
+            console.log((0, consoleColor_1.cyanLog)(`  - ${file}`));
+        if (excludedFiles.length > displayLimit)
+            console.log((0, consoleColor_1.cyanLog)(`  ... and ${excludedFiles.length - displayLimit} more`));
+        console.log();
+    }
     const result = new Map();
     for (const filename of filenames) {
         const filePath = node_path_1.default.join(commandLine_1.cmdLine.sourcepath, filename);
         result.set(filename, (0, node_fs_1.readFileSync)(filePath, { flag: 'r' }));
     }
     const duplicates = findSimilarFiles(result);
-    for (const sameFiles of duplicates) {
+    for (const sameFiles of duplicates)
         console.log((0, consoleColor_1.yellowLog)(` ${sameFiles.join(', ')} files look like identical`));
-    }
     return result;
 };
 exports.getFiles = getFiles;

package/dist/index.js

@@ -26,9 +26,8 @@ const calculateCompressionRatio = (originalSize, compressedSize) => Math.round((
 const formatCompressionLog = (filename, padding, originalSize, compressedSize, useGzip) => {
     const ratio = calculateCompressionRatio(originalSize, compressedSize);
     const sizeInfo = `(${originalSize} -> ${compressedSize} = ${ratio}%)`;
-    if (useGzip) {
+    if (useGzip)
         return (0, consoleColor_1.greenLog)(` [${filename}] ${padding} ✓ gzip used ${sizeInfo}`);
-    }
     const tooSmall = originalSize <= GZIP_MIN_SIZE ? '(too small) ' : '';
     return (0, consoleColor_1.yellowLog)(` [${filename}] ${padding} x gzip unused ${tooSmall}${sizeInfo}`);
 };
@@ -44,12 +43,10 @@ const createSourceEntry = (filename, dataname, content, contentGzip, mimeType, m
 });
 const updateExtensionGroup = (extension) => {
     const group = filesByExtension.find((fe) => fe.extension === extension);
-    if (group) {
+    if (group)
         group.count += 1;
-    }
-    else {
+    else
         filesByExtension.push({ extension, count: 1 });
-    }
 };
 console.log('Collecting source files');
 const files = (0, file_1.getFiles)();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "svelteesp32",
-  "version": "1.10.0",
+  "version": "1.11.0",
   "description": "Convert Svelte (or any frontend) JS application to serve it from ESP32 webserver (PsychicHttp)",
   "author": "BCsabaEngine",
   "license": "ISC",
@@ -31,6 +31,9 @@
     "dev:async": "nodemon src/index.ts -- -e async -s ./demo/svelte/dist -o ./demo/esp32/include/svelteesp32.h --etag=true --gzip=true --cachetime=86400 --version=v$npm_package_version",
     "dev:psychic": "nodemon src/index.ts -- -e psychic -s ./demo/svelte/dist -o ./demo/esp32/include/svelteesp32.h --etag=false --gzip=false --version=v$npm_package_version",
     "dev:psychic2": "nodemon src/index.ts -- -e psychic2 -s ./demo/svelte/dist -o ./demo/esp32/include/svelteesp32.h --etag=false --gzip=false --version=v$npm_package_version",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "test:coverage": "vitest run --coverage",
     "test:esp32": "./package.script && ~/.platformio/penv/bin/pio run -d ./demo/esp32",
     "test:esp32idf": "./package.script && ~/.platformio/penv/bin/pio run -d ./demo/esp32idf",
     "test:all": "node --run test:esp32 && node --run test:esp32idf",
@@ -41,7 +44,7 @@
     "lint:check": "eslint .",
     "lint:fix": "eslint --fix .",
     "fix": "node --run format:fix && node --run lint:fix && node --run format:fix",
-    "all": "node --run fix && node --run build",
+    "all": "node --run fix && node --run build && node --run test",
     "npm:reinstall": "rm -rf ./node_modules && rm -f ./package-lock.json && npm i && npm i"
   },
   "keywords": [
@@ -60,21 +63,25 @@
     "@types/mime-types": "^3.0.1",
     "@types/node": "^24.10.1",
     "@types/picomatch": "^4.0.2",
-    "@typescript-eslint/eslint-plugin": "^8.47.0",
-    "@typescript-eslint/parser": "^8.47.0",
+    "@typescript-eslint/eslint-plugin": "^8.48.1",
+    "@typescript-eslint/parser": "^8.48.1",
+    "@vitest/coverage-v8": "^4.0.15",
     "eslint": "^9.39.1",
     "eslint-config-prettier": "^10.1.8",
     "eslint-plugin-simple-import-sort": "^12.1.1",
     "eslint-plugin-unicorn": "^62.0.0",
+    "memfs": "^4.51.1",
     "nodemon": "^3.1.11",
-    "prettier": "^3.6.2",
+    "prettier": "^3.7.4",
     "ts-node": "^10.9.2",
-    "tsx": "^4.20.6",
-    "typescript": "^5.9.3"
+    "tsx": "^4.21.0",
+    "typescript": "^5.9.3",
+    "vitest": "^4.0.15"
   },
   "dependencies": {
     "handlebars": "^4.7.8",
     "mime-types": "^3.0.2",
+    "picomatch": "^4.0.3",
     "tinyglobby": "^0.2.15"
   }
 }