is-media-descriptor^5.2.0

Installation

Quick Take

Examples

• Report missing descriptor whitespace
• Offset reported indexes
• A valid media descriptor
• Report surrounding whitespace

Purpose

This is about so-called media descriptors (older spec, newer spec — CSS MQ Level 4), for example, the part screen and (color), projection and (color) in both HTML and CSS:

<link media="screen and (color), projection and (color)" rel="stylesheet" href="example.css" />

<link media="screen and (color), projection and (color)" rel="stylesheet" href="example.css" />

<?xml-stylesheet media="screen and (color), projection and (color)" rel="stylesheet" href="example.css" ?>

@import url(example.css) screen and (color), projection and (color);

@media screen and (color), projection and (color) {
  ...;
}

We plan to catch as many errors as possible:

• typos
• unclosed brackets
• redundant characters
• untangle the boolean logic
• ... anything that can happen to media queries and media selectors in general.

This is not a replacement for the validator; this is a linting tool. We will use it in emlint.

Conceptually, CSS spec is very permissive, if it doesn’t like something it invalidates that part and moves on. In this light, linting needs to be the opposite.

API — isMediaD()

The main function isMediaD() is imported like this:

It’s a function which takes two input arguments:

The optional options object has the following shape:

Falsy opt.offset is fine but something truthy which is not a natural number will throw.

Function returns an array of zero or more plain objects of the following shape (ResObj type above):

If an input is not a string or an empty string, an empty array will be returned.

For example, all the calls below will yield an empty array (no errors):

isMediaD();
isMediaD("");
isMediaD("screen");
isMediaD("screen", {});
isMediaD("screen", null);
isMediaD("screen", { offset: 0 });
isMediaD("screen", { offset: 51 });

⚠️ A bad example is below — don’t put @media, please extract the value:

// program won't work with `@media` - extract the value first!
isMediaD("@media only (screen) and (min-width: 320px) and (max-width: 500px) {");

Instead, feed the main function with an extracted value, with no @media:

isMediaD("only (screen) and (min-width: 320px) and (max-width: 500px)");

Output

The program returns an array of zero or more plain objects, each meaning an error. Each object’s notation is the same as in emlint (except there’s no ruleId):

{
  idxFrom: 21,
  idxTo: 22,
  message: `Rogue bracket.`,
  fix: {
    ranges: [[21, 22]]
  }
}

Quick basics: idxFrom and idxTo are the same as in String.slice, just used for marking.

The fix key is either null or has value — plain object — with key ranges. ESLint uses singular, range, EMLint uses ranges, plural, because EMLint uses Ranges notation — where ESLint marks “to add” thing separately, EMLint puts it as the third element in a ranges array.

Ranges are always either null or array of arrays.

EMLint and ranges arrays here follow Ranges notation and all Ranges packages can be used to process them — merging, inverting, resolving/applying and so on.

API — defaults

You can import defaults:

It's a plain object:

The main function calculates the options to be used by merging the options you passed with these defaults.

API — version

You can import version:

Competition

There are capable CSS parsers out there, but they are all oriented at parsing the correct code and strictly pure HTML or CSS. Code validators built upon such parsers are not really serious validators.

• W3C
• CSSTree Validator

Conceptually, code checking tools should use advanced but slow, error-recovering parsers to find and fix errors. Then, for general parsing (like syntax highlighting), parsers which can’t recognise many errors but are fast should be used.

These are two different levels of the “food-chain”. Currently, there is not much competition for this program in this sense.

Changelog