svelteesp32 1.3.0 → 1.3.1

package/README.md

@@ -107,7 +107,8 @@ The content of **generated file** (do not edit, just use)
 ```c
 #define SVELTEESP32_COUNT 5
 #define SVELTEESP32_SIZE 145633
-#define SVELTEESP32_FILE_index_html
+#define SVELTEESP32_FILE_INDEX_HTML
+#define SVELTEESP32_HTML_FILES 1
 ...
 
 const uint8_t data0[12547] = {0x1f, 0x8b, 0x8, 0x0, ...
@@ -189,30 +190,42 @@ You can use the COUNT and SIZE constants:
 ...
 ```
 
-You can include a warning if a named file accidentally missing from the build:
+You can include a blocker error if a named file accidentally missing from the build:
 
 ```c
 ...
 #include "svelteesp32.h"
 
-#ifndef SVELTEESP32_FILE_index_html
+#ifndef SVELTEESP32_FILE_INDEX_HTML
   #error Missing index file
 #endif
 ...
 ```
 
+...or if there are too many of a file type:
+
+```c
+...
+#include "svelteesp32.h"
+
+#if SVELTEESP32_CSS_FILES > 1
+  #error Too many CSS files
+#endif
+...
+```
+
 ### Command line options
 
-| Option        | Required | Description                                                      | default                 |
-| ------------- | :------: | ---------------------------------------------------------------- | ----------------------- |
-| `-e`          |    x     | The engine for which the include file is created (psychic/async) | psychic                 |
-| `-s`          |    x     | Source dist folder contains compiled web files                   |                         |
-| `-o`          |    x     | Generated output file with path                                  | `svelteesp32.h`         |
-| `--etag`      |          | Use ETag header for cache                                        | false                   |
-| `--no-gzip`   |          | Do not compress content with gzip                                | false -> gzip used      |
-| `--espmethod` |    x     | Name of generated method                                         | `initSvelteStaticFiles` |
-| `--define`    |    x     | Prefix of c++ defines                                            | `SVELTEESP32`           |
-| `-h`          |          | Show help                                                        |                         |
+| Option        | Description                                               | default                 |
+| ------------- | --------------------------------------------------------- | ----------------------- | ------- |
+| `-s`          | **Source dist folder contains compiled web files**        |                         |
+| `-e`          | The engine for which the include file is created [psychic | async]                  | psychic |
+| `-o`          | Generated output file with path                           | `svelteesp32.h`         |
+| `--etag`      | Use ETag header for cache                                 | false                   |
+| `--no-gzip`   | Do not compress content with gzip                         | false -> gzip used      |
+| `--espmethod` | Name of generated method                                  | `initSvelteStaticFiles` |
+| `--define`    | Prefix of c++ defines                                     | `SVELTEESP32`           |
+| `-h`          | Show help                                                 |                         |
 
 ### Q&A
 

package/dist/cppCode.d.ts

@@ -1,9 +1,16 @@
-export type cppCodeSource = {
+export type CppCodeSource = {
     filename: string;
     dataname: string;
+    datanameUpperCase: string;
     mime: string;
     content: Buffer;
     isGzip: boolean;
     md5: string;
 };
-export declare const getCppCode: (sources: cppCodeSource[]) => string;
+export type CppCodeSources = CppCodeSource[];
+export type ExtensionGroup = {
+    extension: string;
+    count: number;
+};
+export type ExtensionGroups = ExtensionGroup[];
+export declare const getCppCode: (sources: CppCodeSources, filesByExtension: ExtensionGroups) => string;

package/dist/cppCode.js

@@ -16,8 +16,13 @@ const psychicTemplate = `
 
 #define {{definePrefix}}_COUNT {{fileCount}}
 #define {{definePrefix}}_SIZE {{fileSize}}
+
 {{#each sources}}
-#define {{../definePrefix}}_FILE_{{this.dataname}}
+#define {{../definePrefix}}_FILE_{{this.datanameUpperCase}}
+{{/each}}
+
+{{#each filesByExtension}}
+#define {{../definePrefix}}_{{this.extension}}_FILES {{this.count}}
 {{/each}}
 
 {{#each sources}}
@@ -63,8 +68,13 @@ const asyncTemplate = `
 
 #define {{definePrefix}}_COUNT {{fileCount}}
 #define {{definePrefix}}_SIZE {{fileSize}}
+
 {{#each sources}}
-#define {{../definePrefix}}_FILE_{{this.dataname}}
+#define {{../definePrefix}}_FILE_{{this.datanameUpperCase}}
+{{/each}}
+
+{{#each filesByExtension}}
+#define {{../definePrefix}}_{{this.extension}}_FILES {{this.count}}
 {{/each}}
 
 {{#each sources}}
@@ -99,7 +109,7 @@ void {{methodName}}(AsyncWebServer * server) {
 
 {{/each}}
 }`;
-const getCppCode = (sources) => (0, handlebars_1.compile)(commandLine_1.cmdLine.engine === 'psychic' ? psychicTemplate : asyncTemplate)({
+const getCppCode = (sources, filesByExtension) => (0, handlebars_1.compile)(commandLine_1.cmdLine.engine === 'psychic' ? psychicTemplate : asyncTemplate)({
     commandLine: process.argv.slice(2).join(' '),
     now: `${new Date().toLocaleDateString()} ${new Date().toLocaleTimeString()}`,
     fileCount: sources.length.toString(),
@@ -110,6 +120,7 @@ const getCppCode = (sources) => (0, handlebars_1.compile)(commandLine_1.cmdLine.
         bytes: [...s.content].map((v) => `0x${v.toString(16)}`).join(', '),
         isDefault: s.filename.startsWith('index.htm')
     })),
+    filesByExtension,
     isEtag: commandLine_1.cmdLine.etag,
     methodName: commandLine_1.cmdLine.espmethod,
     definePrefix: commandLine_1.cmdLine.define

package/dist/index.js

@@ -17,6 +17,7 @@ const summary = {
     gzipsize: 0
 };
 const sources = [];
+const filesByExtension = [];
 const files = (0, file_1.getFiles)();
 if (files.length === 0) {
     console.error(`Directory ${commandLine_1.cmdLine.sourcepath} is empty`);
@@ -28,6 +29,14 @@ for (const file of files) {
     console.log(`[${file}]`);
     const filename = file.replace(/\\/g, '/');
     const dataname = filename.replace(/[./-]/g, '_');
+    let extension = node_path_1.default.extname(filename).toUpperCase();
+    if (extension.startsWith('.'))
+        extension = extension.slice(1);
+    const group = filesByExtension.find((fe) => fe.extension === extension);
+    if (group)
+        group.count += 1;
+    else
+        filesByExtension.push({ extension, count: 1 });
     const rawContent = (0, node_fs_1.readFileSync)(node_path_1.default.join(commandLine_1.cmdLine.sourcepath, file), { flag: 'r' });
     const md5 = (0, node_crypto_1.createHash)('md5').update(rawContent).digest('hex');
     summary.size += rawContent.length;
@@ -35,6 +44,7 @@ for (const file of files) {
         sources.push({
             filename: filename,
             dataname,
+            datanameUpperCase: dataname.toUpperCase(),
             content: rawContent,
             isGzip: false,
             mime,
@@ -49,6 +59,7 @@ for (const file of files) {
             sources.push({
                 filename: filename,
                 dataname,
+                datanameUpperCase: dataname.toUpperCase(),
                 content: zipContent,
                 isGzip: true,
                 mime,
@@ -60,6 +71,7 @@ for (const file of files) {
             sources.push({
                 filename: filename,
                 dataname,
+                datanameUpperCase: dataname.toUpperCase(),
                 content: rawContent,
                 isGzip: false,
                 mime,
@@ -70,7 +82,8 @@ for (const file of files) {
     }
     console.log('');
 }
-const cppFile = (0, cppCode_1.getCppCode)(sources);
+filesByExtension.sort((left, right) => left.extension.localeCompare(right.extension));
+const cppFile = (0, cppCode_1.getCppCode)(sources, filesByExtension);
 (0, node_fs_1.writeFileSync)(commandLine_1.cmdLine.outputfile, cppFile);
 if (commandLine_1.cmdLine['no-gzip']) {
     console.log(`${summary.filecount} files, ${Math.round(summary.size / 1024)}kB original size`);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "svelteesp32",
-  "version": "1.3.0",
+  "version": "1.3.1",
   "description": "Convert Svelte (or any frontend) JS application to serve it from ESP32 webserver (PsychicHttp)",
   "author": "BCsabaEngine",
   "license": "ISC",
@@ -56,7 +56,7 @@
   ],
   "devDependencies": {
     "@types/mime-types": "^2.1.4",
-    "@types/node": "^22.2.0",
+    "@types/node": "^22.3.0",
     "@typescript-eslint/eslint-plugin": "^8.1.0",
     "@typescript-eslint/parser": "^8.1.0",
     "eslint": "^9.9.0",