Feat: define filetypes (#20)

* feat: filename directives are uppercased
* feat: filecount by extension
* fix: readme

Author: BCsabaEngine

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
 

demo/esp32/include/svelteesp32async.h

@@ -8,10 +8,14 @@
 #error Invalid file count
 #endif
 
-#ifndef SVELTEESP32_FILE_index_html
+#ifndef SVELTEESP32_FILE_INDEX_HTML
 #error Missing index file
 #endif
 
+#if SVELTEESP32_CSS_FILES > 1
+#error Too many CSS files
+#endif
+
 AsyncWebServer server(80);
 void setup()
 {
@@ -30,10 +34,14 @@ void loop() {}
 #error Invalid file count
 #endif
 
-#ifndef SVELTEESP32_FILE_index_html
+#ifndef SVELTEESP32_FILE_INDEX_HTML
 #error Missing index file
 #endif
 
+#if SVELTEESP32_CSS_FILES > 1
+#error Too many CSS files
+#endif
+
 PsychicHttpServer server;
 void setup()
 {

demo/esp32/include/svelteesp32psychic.h

@@ -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",

demo/esp32/src/main.cpp

@@ -2,14 +2,22 @@ import { compile as handlebarsCompile } from 'handlebars';
 
 import { cmdLine } from './commandLine';
 
-export type cppCodeSource = {
+export type CppCodeSource = {
   filename: string;
   dataname: string;
+  datanameUpperCase: string;
   mime: string;
   content: Buffer;
   isGzip: boolean;
   md5: string;
 };
+export type CppCodeSources = CppCodeSource[];
+
+export type ExtensionGroup = {
+  extension: string;
+  count: number;
+};
+export type ExtensionGroups = ExtensionGroup[];
 
 const psychicTemplate = `
 //engine:   PsychicHttpServer
@@ -24,8 +32,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}}
@@ -72,8 +85,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}}
@@ -109,7 +127,7 @@ void {{methodName}}(AsyncWebServer * server) {
 {{/each}}
 }`;
 
-export const getCppCode = (sources: cppCodeSource[]): string =>
+export const getCppCode = (sources: CppCodeSources, filesByExtension: ExtensionGroups): string =>
   handlebarsCompile(cmdLine.engine === 'psychic' ? psychicTemplate : asyncTemplate)({
     commandLine: process.argv.slice(2).join(' '),
     now: `${new Date().toLocaleDateString()} ${new Date().toLocaleTimeString()}`,
@@ -121,6 +139,7 @@ export const getCppCode = (sources: cppCodeSource[]): string =>
       bytes: [...s.content].map((v) => `0x${v.toString(16)}`).join(', '),
       isDefault: s.filename.startsWith('index.htm')
     })),
+    filesByExtension,
     isEtag: cmdLine.etag,
     methodName: cmdLine.espmethod,
     definePrefix: cmdLine.define

package-lock.json

@@ -7,7 +7,7 @@ import { gzipSync } from 'node:zlib';
 import { lookup } from 'mime-types';
 
 import { cmdLine } from './commandLine';
-import { cppCodeSource, getCppCode } from './cppCode';
+import { CppCodeSources, ExtensionGroups, getCppCode } from './cppCode';
 import { getFiles } from './file';
 
 const summary = {
@@ -16,7 +16,8 @@ const summary = {
   gzipsize: 0
 };
 
-const sources: cppCodeSource[] = [];
+const sources: CppCodeSources = [];
+const filesByExtension: ExtensionGroups = [];
 const files = getFiles();
 if (files.length === 0) {
   console.error(`Directory ${cmdLine.sourcepath} is empty`);
@@ -30,6 +31,12 @@ for (const file of files) {
 
   const filename = file.replace(/\\/g, '/');
   const dataname = filename.replace(/[./-]/g, '_');
+  let extension = path.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 = readFileSync(path.join(cmdLine.sourcepath, file), { flag: 'r' });
   const md5 = createHash('md5').update(rawContent).digest('hex');
@@ -38,6 +45,7 @@ for (const file of files) {
     sources.push({
       filename: filename,
       dataname,
+      datanameUpperCase: dataname.toUpperCase(),
       content: rawContent,
       isGzip: false,
       mime,
@@ -51,6 +59,7 @@ for (const file of files) {
       sources.push({
         filename: filename,
         dataname,
+        datanameUpperCase: dataname.toUpperCase(),
         content: zipContent,
         isGzip: true,
         mime,
@@ -61,6 +70,7 @@ for (const file of files) {
       sources.push({
         filename: filename,
         dataname,
+        datanameUpperCase: dataname.toUpperCase(),
         content: rawContent,
         isGzip: false,
         mime,
@@ -72,8 +82,9 @@ for (const file of files) {
 
   console.log('');
 }
+filesByExtension.sort((left, right) => left.extension.localeCompare(right.extension));
 
-const cppFile = getCppCode(sources);
+const cppFile = getCppCode(sources, filesByExtension);
 writeFileSync(cmdLine.outputfile, cppFile);
 
 if (cmdLine['no-gzip']) {