espurna/code/html/README.md

Builder script is using Gulp

• https://gulpjs.com
• https://www.npmjs.com/package/gulp

Additional tools used

• eslint to validate javascript files
• html-validate to validate html file
• vitest testing framework

All commands must be called from code/

$ pwd
/home/dev/espurna/code

When gulp command is not available globally

$ ./node_modules/.bin/gulp

Files

• code/espurna/static/ - .html.ipp, used in the firmware code
• code/gulpfile.mjs - builder script entrypoint
• code/vite.config.mjs - (experimental) vite dev server configuration
• code/html/index.html - main entrypoint, index.html template
• code/html/build - intermediate build results
• code/html/preset - build configurations
• code/html/spec - vitest 'spec' files
• code/html/src - source .mjs, .html, etc.
• code/node_modules - build dependencies
• code/package{,-lock}.json - build dependencies metadata

Installation

(recommended) Install exact dependencies listed in the package-lock.json, from the time the builder code was last updated

$ npm ci

(optional) Install dependencies listed in the package.json, possibly updating packages listed in the package-lock.json

$ npm install

Building

Run tests and build every .html.ipp (default task)

$ gulp

Build only (does not run tests)

$ gulp build

Build specific flavour (preset tasks)

$ gulp build --preset small

List all available tasks

$ gulp --tasks

Development

Launches development server on port 8080 with the resulting .html bundle. No minification or compression, using dev preset as base

$ gulp dev

Only the default task depends on the test and lint tasks, call them manually

$ gulp test

$ gulp eslint html-validate vitest

$ gulp eslint
$ gulp html-validate
$ gulp vitest

Gulp usually does not allow any task arguments, run these tools manually to select specific files or change command line arguments

$ npm exec --no -- eslint gulpfile.mjs html/src/*.mjs html/spec/*.mjs

$ npm exec --no -- html-validate html/src/*.html

$ npm exec --no -- vitest --environment jsdom --dir html/spec --run

Experimental support of Vite dev server is also included. Every preset is supported, but only --mode dev is expected to work locally

$ vite --mode dev