cssserve

cssserve – CSS Server

cssserve is a small dedicated HTTP/2 server that serves lots of small CSS files.

---

Chapters:

• How to run it
• Configuration
• Log-levels
• CSS dependency bundling and version resolution
  • Example request
• Static assets

---

How to run it

npm install --save cssserve
cssserve

Configuration

cssserve is highly opinionated but accepts configuration options, using the rc package.

See the TypeScript type definition for AppConfig for the available config values and defaults.

The server looks for .cssservec in your package root (or its containing folders) and also accepts CSSSERVE_*-prefixed environment variables, direct CLI arguments and a --config file option as well. (See the rc docs for more details.)

Additionally the port option can be overridden via the environment variables NODE_PORT and/or PORT.

Log-levels

Logging is controlled by the NODE_ENV variable.

• NODE_ENV=production logs nothing much
• NODE_ENV=development logs server 500 errors and info about all invalid token names found while parsing CSS files.
• NODE_ENV=debug same as development, but adds detailed stacktrace for all thrown errors

CSS dependency bundling and version resolution

The server's primary purpose is to accept a list of CSS module names build a correctly ordered, deduplicated list of @include links to the corresponding CSS files and their dependencies (see below), recursively.

For this, the server exposes the endpoint /bundle/:version?m={module1,module2,...}

The :version path token can be any value ascii alpha-numerical value with (single) periods, slashes and underscores. (/^[a-z0-9._-]+$/i). Note, however, that multiple adjacent . characters are forbidden. (See iSafeToken.tests.)

The :version token is matched against direct subfolders of options.staticFolder + 'css/' and supports simple semantic versioning - so that if your folder tree looks like this:

public/
	css/
		v1.1/
		v1.2/
		v1.10/

...then the :version token v1 will resolve to the folder css/v1.10/. (See getAllValidCssVersions.tests and resolveCssVersionFolder.tests for more nerdy details.)

Example request

<link
	rel="stylesheet"
	href="https://css.server/bundle/v1?m=_base,ModuleB,ModuleA"
/>

Example response (with comments):

/* "_base" from query-string */
@import '/css/v1.10/_base.css';
/* Dependencies of ModuleA.css */
@import '/css/v1.10/Button.css';
@import '/css/v1.10/Carousel.css';
@import '/css/v1.10/Herobanner.css';
@import '/css/v1.10/Tabs.css';
/* "ModuleA" from query-string */
@import '/css/v1.10/ModuleA.css';
/* Dependencies of ModuleB.css not already met by ModuleA */
@import '/css/v1.10/FormInput.css';
@import '/css/v1.10/Selectbox.css';
@import '/css/v1.10/BasicTable.css';
/* "ModuleB" from query-string */
@import '/css/v1.10/ModuleB.css';

Example of how ModuleA.css declares its dependencies:

/*!@deps
	Button
	Carousel  // NOTE: comments are allowed
	Herobanner 
	Tabs
*/
@media screen {
	.ModuleA {
		/* ...styles for ModuleA */
	}
}

(See parseDepsFromCSS.tests and parseModules.tests for details.)

Static assets

Any files/folders you place inside options.staticFolder will automatically exposed and served with a HTTP caching lifetime set to options.ttl_static (same as the @imported CSS files and their linked assets).

Changelog

1.3.0

2021-06-15

• feat: Add config.loudBadTokenErrors (default: false in "production")